Class: Moonbase::Models::CallCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Moonbase::Models::CallCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/moonbase/models/call_create_params.rb

Overview

See Also:

• Resources::Calls#create

Defined Under Namespace

Modules: Direction, Provider Classes: Participant, Recording, Transcript

Instance Attribute Summary

• #answered_at ⇒ Time^?

  The time the call was answered, as an ISO 8601 timestamp in UTC.

• #direction ⇒ Symbol, Moonbase::Models::CallCreateParams::Direction

  The direction of the call, either ‘incoming` or `outgoing`.

• #end_at ⇒ Time^?

  The time the call ended, as an ISO 8601 timestamp in UTC.

• #participants ⇒ Array<Moonbase::Models::CallCreateParams::Participant>

  An array of participants involved in the call.

• #provider ⇒ Symbol, Moonbase::Models::CallCreateParams::Provider

  The name of the phone provider that handled the call (e.g., ‘openphone`).

• #provider_id ⇒ String

  The unique identifier for the call from the provider’s system.

• #provider_metadata ⇒ Hash{Symbol=>Object}^?

  A hash of additional metadata from the provider.

• #provider_status ⇒ String

  The status of the call.

• #recordings ⇒ Array<Moonbase::Models::CallCreateParams::Recording>^?

  Any recordings associated with the call.

• #start_at ⇒ Time

  The time the call started, as an ISO 8601 timestamp in UTC.

• #tags ⇒ Array<Moonbase::Models::TagPointerParam>^?

  Optional list of tag pointers to assign to the call.

• #transcript ⇒ Moonbase::Models::CallCreateParams::Transcript^?

  A transcript of the call.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(direction:, participants:, provider:, provider_id:, provider_status:, start_at:, answered_at: nil, end_at: nil, provider_metadata: nil, recordings: nil, tags: nil, transcript: nil, request_options: {}) ⇒ Object constructor

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(direction:, participants:, provider:, provider_id:, provider_status:, start_at:, answered_at: nil, end_at: nil, provider_metadata: nil, recordings: nil, tags: nil, transcript: nil, request_options: {}) ⇒ Object

Parameters:

• direction (Symbol, Moonbase::Models::CallCreateParams::Direction) —

  The direction of the call, either ‘incoming` or `outgoing`.

• participants (Array<Moonbase::Models::CallCreateParams::Participant>) —

  An array of participants involved in the call.

• provider (Symbol, Moonbase::Models::CallCreateParams::Provider) —

  The name of the phone provider that handled the call (e.g., ‘openphone`).

• provider_id (String) —

  The unique identifier for the call from the provider’s system.

• provider_status (String) —

  The status of the call.

• start_at (Time) —

  The time the call started, as an ISO 8601 timestamp in UTC.

• answered_at (Time) (defaults to: nil) —

  The time the call was answered, as an ISO 8601 timestamp in UTC.

• end_at (Time) (defaults to: nil) —

  The time the call ended, as an ISO 8601 timestamp in UTC.

• provider_metadata (Hash{Symbol=>Object}) (defaults to: nil) —

  A hash of additional metadata from the provider.

• recordings (Array<Moonbase::Models::CallCreateParams::Recording>) (defaults to: nil) —

  Any recordings associated with the call.

• tags (Array<Moonbase::Models::TagPointerParam>) (defaults to: nil) —

  Optional list of tag pointers to assign to the call.

• transcript (Moonbase::Models::CallCreateParams::Transcript) (defaults to: nil) —

  A transcript of the call.

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

# File 'lib/moonbase/models/call_create_params.rb', line 82

Instance Attribute Details

#answered_at ⇒ Time^?

The time the call was answered, as an ISO 8601 timestamp in UTC.

Returns:

• (Time, nil)

# File 'lib/moonbase/models/call_create_params.rb', line 50

optional :answered_at, Time

#direction ⇒ Symbol, Moonbase::Models::CallCreateParams::Direction

The direction of the call, either ‘incoming` or `outgoing`.

Returns:

• (Symbol, Moonbase::Models::CallCreateParams::Direction)

# File 'lib/moonbase/models/call_create_params.rb', line 14

required :direction, enum: -> { Moonbase::CallCreateParams::Direction }

#end_at ⇒ Time^?

The time the call ended, as an ISO 8601 timestamp in UTC.

Returns:

• (Time, nil)

# File 'lib/moonbase/models/call_create_params.rb', line 56

optional :end_at, Time

#participants ⇒ Array<Moonbase::Models::CallCreateParams::Participant>

An array of participants involved in the call.

Returns:

• (Array<Moonbase::Models::CallCreateParams::Participant>)

# File 'lib/moonbase/models/call_create_params.rb', line 20

required :participants, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::CallCreateParams::Participant] }

#provider ⇒ Symbol, Moonbase::Models::CallCreateParams::Provider

The name of the phone provider that handled the call (e.g., ‘openphone`).

Returns:

• (Symbol, Moonbase::Models::CallCreateParams::Provider)

# File 'lib/moonbase/models/call_create_params.rb', line 26

required :provider, enum: -> { Moonbase::CallCreateParams::Provider }

#provider_id ⇒ String

The unique identifier for the call from the provider’s system.

Returns:

• (String)

# File 'lib/moonbase/models/call_create_params.rb', line 32

required :provider_id, String

#provider_metadata ⇒ Hash{Symbol=>Object}^?

A hash of additional metadata from the provider.

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/moonbase/models/call_create_params.rb', line 62

optional :provider_metadata, Moonbase::Internal::Type::HashOf[Moonbase::Internal::Type::Unknown]

#provider_status ⇒ String

The status of the call.

Returns:

• (String)

# File 'lib/moonbase/models/call_create_params.rb', line 38

required :provider_status, String

#recordings ⇒ Array<Moonbase::Models::CallCreateParams::Recording>^?

Any recordings associated with the call.

Returns:

• (Array<Moonbase::Models::CallCreateParams::Recording>, nil)

# File 'lib/moonbase/models/call_create_params.rb', line 68

optional :recordings, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::CallCreateParams::Recording] }

#start_at ⇒ Time

The time the call started, as an ISO 8601 timestamp in UTC.

Returns:

• (Time)

# File 'lib/moonbase/models/call_create_params.rb', line 44

required :start_at, Time

#tags ⇒ Array<Moonbase::Models::TagPointerParam>^?

Optional list of tag pointers to assign to the call.

Returns:

• (Array<Moonbase::Models::TagPointerParam>, nil)

# File 'lib/moonbase/models/call_create_params.rb', line 74

optional :tags, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::TagPointerParam] }

#transcript ⇒ Moonbase::Models::CallCreateParams::Transcript^?

A transcript of the call.

Returns:

• (Moonbase::Models::CallCreateParams::Transcript, nil)

# File 'lib/moonbase/models/call_create_params.rb', line 80

optional :transcript, -> { Moonbase::CallCreateParams::Transcript }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/moonbase/models/call_create_params.rb', line 116