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:



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/telnyx/models/ai/assistant_tool.rb', line 266

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) 


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

required :name, String

#sip_address ⇒ String

The SIP URI to which the call will be referred.

Returns:

  • (String) 


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

required :sip_address, String

#sip_auth_password ⇒ String?

SIP Authentication password used for SIP challenges.

Returns:

  • (String, nil) 


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

optional :sip_auth_password, String

#sip_auth_username ⇒ String?

SIP Authentication username used for SIP challenges.

Returns:

  • (String, nil) 


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

optional :sip_auth_username, String