Class: Telnyx::Models::Calls::ActionStopForkingParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Calls::ActionStopForkingParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/calls/action_stop_forking_params.rb

Overview

See Also:

• Resources::Calls::Actions#stop_forking

Defined Under Namespace

Modules: StreamType

Instance Attribute Summary

• #call_control_id ⇒ String
• #client_state ⇒ String^?

  Use this field to add state to every subsequent webhook.

• #command_id ⇒ String^?

  Use this field to avoid duplicate commands.

• #stream_type ⇒ Symbol, ...

  Optionally specify a ‘stream_type`.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(call_control_id:, client_state: nil, command_id: nil, stream_type: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ActionStopForkingParams 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(call_control_id:, client_state: nil, command_id: nil, stream_type: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Calls::ActionStopForkingParams for more details.

Parameters:

• call_control_id (String)
• client_state (String) (defaults to: nil) —

  Use this field to add state to every subsequent webhook. It must be a valid Base

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

  Use this field to avoid duplicate commands. Telnyx will ignore any command with

• stream_type (Symbol, Telnyx::Models::Calls::ActionStopForkingParams::StreamType) (defaults to: nil) —

  Optionally specify a ‘stream_type`. This should match the `stream_type` that was

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

# File 'lib/telnyx/models/calls/action_stop_forking_params.rb', line 37

Instance Attribute Details

#call_control_id ⇒ String

Returns:

• (String)

# File 'lib/telnyx/models/calls/action_stop_forking_params.rb', line 14

required :call_control_id, String

#client_state ⇒ String^?

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_stop_forking_params.rb', line 21

optional :client_state, String

#command_id ⇒ String^?

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same ‘command_id` for the same `call_control_id`.

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_stop_forking_params.rb', line 28

optional :command_id, String

#stream_type ⇒ Symbol, ...

Optionally specify a ‘stream_type`. This should match the `stream_type` that was used in `fork_start` command to properly stop the fork.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionStopForkingParams::StreamType, nil)

# File 'lib/telnyx/models/calls/action_stop_forking_params.rb', line 35

optional :stream_type, enum: -> { Telnyx::Calls::ActionStopForkingParams::StreamType }