Class: Telnyx::Models::Conferences::ActionLeaveParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Conferences::ActionLeaveParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/conferences/action_leave_params.rb

Overview

See Also:

• Resources::Conferences::Actions#leave

Defined Under Namespace

Modules: BeepEnabled, Region

Instance Attribute Summary

• #beep_enabled ⇒ Symbol, ...

  Whether a beep sound should be played when the participant leaves the conference.

• #call_control_id ⇒ String

  Unique identifier and token for controlling the call.

• #command_id ⇒ String^?

  Use this field to avoid execution of duplicate commands.

• #id ⇒ String
• #region ⇒ Symbol, ...

  Region where the conference data is located.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, call_control_id:, beep_enabled: nil, command_id: nil, region: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ActionLeaveParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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:, call_control_id:, beep_enabled: nil, command_id: nil, region: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Conferences::ActionLeaveParams for more details.

Parameters:

• id (String)
• call_control_id (String) —

  Unique identifier and token for controlling the call

• beep_enabled (Symbol, Telnyx::Models::Conferences::ActionLeaveParams::BeepEnabled) (defaults to: nil) —

  Whether a beep sound should be played when the participant leaves the conference

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

  Use this field to avoid execution of duplicate commands. Telnyx will ignore subs

• region (Symbol, Telnyx::Models::Conferences::ActionLeaveParams::Region) (defaults to: nil) —

  Region where the conference data is located. Defaults to the region defined in u

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/telnyx/models/conferences/action_leave_params.rb', line 44

Instance Attribute Details

#beep_enabled ⇒ Symbol, ...

Whether a beep sound should be played when the participant leaves the conference. Can be used to override the conference-level setting.

Returns:

• (Symbol, Telnyx::Models::Conferences::ActionLeaveParams::BeepEnabled, nil)

# File 'lib/telnyx/models/conferences/action_leave_params.rb', line 27

optional :beep_enabled, enum: -> { Telnyx::Conferences::ActionLeaveParams::BeepEnabled }

#call_control_id ⇒ String

Unique identifier and token for controlling the call

Returns:

• (String)

# File 'lib/telnyx/models/conferences/action_leave_params.rb', line 20

required :call_control_id, String

#command_id ⇒ String^?

Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same ‘command_id` as one that has already been executed.

Returns:

• (String, nil)

# File 'lib/telnyx/models/conferences/action_leave_params.rb', line 35

optional :command_id, String

#id ⇒ String

Returns:

• (String)

# File 'lib/telnyx/models/conferences/action_leave_params.rb', line 14

required :id, String

#region ⇒ Symbol, ...

Region where the conference data is located. Defaults to the region defined in user’s data locality settings (Europe or US).

Returns:

• (Symbol, Telnyx::Models::Conferences::ActionLeaveParams::Region, nil)

# File 'lib/telnyx/models/conferences/action_leave_params.rb', line 42

optional :region, enum: -> { Telnyx::Conferences::ActionLeaveParams::Region }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/conferences/action_leave_params.rb', line 70