Class: Telnyx::Models::AI::AssistantTool::Refer::Refer::Target

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/assistant_tool.rb,
sig/telnyx/models/ai/assistant_tool.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(targets:, custom_headers: nil, sip_headers: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::AI::AssistantTool::Refer::Refer for more details.

Parameters:



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
 
# File 'lib/telnyx/models/ai/assistant_tool.rb', line 867

class Target < Telnyx::Internal::Type::BaseModel
  # @!attribute name
  #   The name of the target.
  #
  #   @return [String]
  required :name, String

  # @!attribute sip_address
  #   The SIP URI to which the call will be referred.
  #
  #   @return [String]
  required :sip_address, String

  # @!attribute sip_auth_password
  #   SIP Authentication password used for SIP challenges.
  #
  #   @return [String, nil]
  optional :sip_auth_password, String

  # @!attribute sip_auth_username
  #   SIP Authentication username used for SIP challenges.
  #
  #   @return [String, nil]
  optional :sip_auth_username, String

  # @!method initialize(name:, sip_address:, sip_auth_password: nil, sip_auth_username: nil)
  #   @param name [String] The name of the target.
  #
  #   @param sip_address [String] The SIP URI to which the call will be referred.
  #
  #   @param sip_auth_password [String] SIP Authentication password used for SIP challenges.
  #
  #   @param sip_auth_username [String] SIP Authentication username used for SIP challenges.
end

Instance Attribute Details

#name ⇒ String

The name of the target.

Parameters:

  • value (String)

Returns:

  • (String) 


872
 
# File 'lib/telnyx/models/ai/assistant_tool.rb', line 872

required :name, String

#sip_address ⇒ String

The SIP URI to which the call will be referred.

Parameters:

  • value (String)

Returns:

  • (String) 


878
 
# File 'lib/telnyx/models/ai/assistant_tool.rb', line 878

required :sip_address, String

#sip_auth_password ⇒ String?

SIP Authentication password used for SIP challenges.

Parameters:

  • (String)

Returns:

  • (String, nil) 


884
 
# File 'lib/telnyx/models/ai/assistant_tool.rb', line 884

optional :sip_auth_password, String

#sip_auth_username ⇒ String?

SIP Authentication username used for SIP challenges.

Parameters:

  • (String)

Returns:

  • (String, nil) 


890
 
# File 'lib/telnyx/models/ai/assistant_tool.rb', line 890

optional :sip_auth_username, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


780
 
# File 'sig/telnyx/models/ai/assistant_tool.rbs', line 780

def to_hash: -> {