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

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

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:



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/telnyx/models/ai/assistant_tool.rb', line 774

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.

Returns:

  • (String) 


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

required :name, String

#sip_address ⇒ String

The SIP URI to which the call will be referred.

Returns:

  • (String) 


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

required :sip_address, String

#sip_auth_password ⇒ String?

SIP Authentication password used for SIP challenges.

Returns:

  • (String, nil) 


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

optional :sip_auth_password, String

#sip_auth_username ⇒ String?

SIP Authentication username used for SIP challenges.

Returns:

  • (String, nil) 


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

optional :sip_auth_username, String