Class: SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call

Defined in:

lib/surge_api/models/recording_completed_webhook_event.rb,
sig/surge_api/models/recording_completed_webhook_event.rbs

Overview

See Also:

• SurgeAPI::Models::RecordingCompletedWebhookEvent::Data#call

Defined Under Namespace

Modules: Status

Instance Attribute Summary

• #contact ⇒ SurgeAPI::Models::Contact

  A contact who has consented to receive messages.

• #duration ⇒ Integer

  The duration of the call in seconds.

• #from ⇒ String^?

  The E.164 phone number of the caller.

• #id ⇒ String

  The unique identifier for the call.

• #initiated_at ⇒ Time

  When the call was initiated.

• #phone_number_id ⇒ String^?

  The Surge phone number ID (e.g. pn_...).

• #status ⇒ Symbol, SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call::Status

  The status of the call.

• #to ⇒ String^?

  The E.164 phone number of the callee.

Instance Method Summary

• #initialize(id:, contact:, duration:, initiated_at:, status:, from: nil, phone_number_id: nil, to: nil) ⇒ Object constructor

  The call that produced this recording.

• #to_hash ⇒ {

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:, contact:, duration:, initiated_at:, status:, from: nil, phone_number_id: nil, to: nil) ⇒ Object

The call that produced this recording

Parameters:

• id (String) —

  The unique identifier for the call

• contact (SurgeAPI::Models::Contact) —

  A contact who has consented to receive messages

• duration (Integer) —

  The duration of the call in seconds

• initiated_at (Time) —

  When the call was initiated

• status (Symbol, SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call::Status) —

  The status of the call

• from (String, nil) (defaults to: nil) —

  The E.164 phone number of the caller

• phone_number_id (String, nil) (defaults to: nil) —

  The Surge phone number ID (e.g. pn_...)

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

  The E.164 phone number of the callee

# File 'lib/surge_api/models/recording_completed_webhook_event.rb', line 118

Instance Attribute Details

#contact ⇒ SurgeAPI::Models::Contact

A contact who has consented to receive messages

Parameters:

• value (SurgeAPI::Contact)

Returns:

• (SurgeAPI::Models::Contact)

# File 'lib/surge_api/models/recording_completed_webhook_event.rb', line 80

required :contact, -> { SurgeAPI::Contact }

#duration ⇒ Integer

The duration of the call in seconds

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/surge_api/models/recording_completed_webhook_event.rb', line 86

required :duration, Integer

#from ⇒ String^?

The E.164 phone number of the caller

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/surge_api/models/recording_completed_webhook_event.rb', line 104

optional :from, String, nil?: true

#id ⇒ String

The unique identifier for the call

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/surge_api/models/recording_completed_webhook_event.rb', line 74

required :id, String

#initiated_at ⇒ Time

When the call was initiated

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/surge_api/models/recording_completed_webhook_event.rb', line 92

required :initiated_at, Time

#phone_number_id ⇒ String^?

The Surge phone number ID (e.g. pn_...)

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/surge_api/models/recording_completed_webhook_event.rb', line 110

optional :phone_number_id, String, nil?: true

#status ⇒ Symbol, SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call::Status

The status of the call

Parameters:

• value (SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call::status)

Returns:

• (Symbol, SurgeAPI::Models::RecordingCompletedWebhookEvent::Data::Call::Status)

# File 'lib/surge_api/models/recording_completed_webhook_event.rb', line 98

required :status, enum: -> { SurgeAPI::RecordingCompletedWebhookEvent::Data::Call::Status }

#to ⇒ String^?

The E.164 phone number of the callee

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/surge_api/models/recording_completed_webhook_event.rb', line 116

optional :to, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/surge_api/models/recording_completed_webhook_event.rbs', line 100

def to_hash: -> {