Class: Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant

Defined in:

lib/telnyx/models/calls/action_start_ai_assistant_params.rb

Defined Under Namespace

Modules: OnHangup, Role

Instance Attribute Summary

• #id ⇒ String

  The call_control_id of the participant to add to the conversation.

• #name ⇒ String^?

  Display name for the participant.

• #on_hangup ⇒ Symbol, ...

  Determines what happens to the conversation when this participant hangs up.

• #role ⇒ Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant::Role

  The role of the participant in the conversation.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, role:, name: nil, on_hangup: nil) ⇒ Object constructor

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(id:, role:, name: nil, on_hangup: nil) ⇒ Object

Parameters:

• id (String) —

  The call_control_id of the participant to add to the conversation.

• role (Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant::Role) —

  The role of the participant in the conversation.

• name (String) (defaults to: nil) —

  Display name for the participant.

• on_hangup (Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant::OnHangup) (defaults to: nil) —

  Determines what happens to the conversation when this participant hangs up.

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 416

Instance Attribute Details

#id ⇒ String

The call_control_id of the participant to add to the conversation.

Returns:

• (String)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 396

required :id, String

#name ⇒ String^?

Display name for the participant.

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 408

optional :name, String

#on_hangup ⇒ Symbol, ...

Determines what happens to the conversation when this participant hangs up.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant::OnHangup, nil)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 414

optional :on_hangup, enum: -> { Telnyx::Calls::ActionStartAIAssistantParams::Participant::OnHangup }

#role ⇒ Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant::Role

The role of the participant in the conversation.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionStartAIAssistantParams::Participant::Role)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 402

required :role, enum: -> { Telnyx::Calls::ActionStartAIAssistantParams::Participant::Role }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 433