Class: Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload

Defined in:

lib/telnyx/models/call_payment_progress_webhook_event.rb,
sig/telnyx/models/call_payment_progress_webhook_event.rbs

Overview

See Also:

• Telnyx::Models::CallPaymentProgressWebhookEvent::Data#payload

Defined Under Namespace

Modules: ErrorType, PaymentCardType, PaymentMethod, PaymentStatus, PaymentStep

Instance Attribute Summary

• #attempt ⇒ Integer^?

  Current 1-based attempt number for the step.

• #bank_account_number ⇒ String^?

  Masked bank account number with only the last two digits visible.

• #bank_account_type ⇒ String^?

  Bank account type, when available.

• #bank_routing_number ⇒ String^?

  Bank routing number collected from the caller.

• #call_control_id ⇒ String^?

  Call ID used to issue commands via Call Control API.

• #call_leg_id ⇒ String^?

  ID unique to the call leg.

• #call_session_id ⇒ String^?

  ID shared by related call legs in the same call session.

• #client_state ⇒ String^?

  Base64-encoded state received from the command.

• #connection_id ⇒ String^?

  Call Control App ID used in the call.

• #error_type ⇒ Symbol, ...

  Step-level error when payment collection fails.

• #expiration_date ⇒ String^?

  Card expiration date in MMYY format.

• #from ⇒ String^?

  Number or SIP URI placing the call.

• #payment_card_number ⇒ String^?

  Masked card number with only the last four digits visible.

• #payment_card_postal_code ⇒ String^?

  Billing postal code collected from the caller.

• #payment_card_type ⇒ Symbol, ...

  Detected card type.

• #payment_connector ⇒ String^?

  Name of the Pay connector used.

• #payment_method ⇒ Symbol, ...

  Payment method being collected.

• #payment_status ⇒ Symbol, ...

  Status of the current payment step.

• #payment_step ⇒ Symbol, ...

  Current payment collection or processing step.

• #security_code ⇒ String^?

  Fully masked card security code.

• #to ⇒ String^?

  Destination number or SIP URI of the call.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(attempt: nil, bank_account_number: nil, bank_account_type: nil, bank_routing_number: nil, call_control_id: nil, call_leg_id: nil, call_session_id: nil, client_state: nil, connection_id: nil, error_type: nil, expiration_date: nil, from: nil, payment_card_number: nil, payment_card_postal_code: nil, payment_card_type: nil, payment_connector: nil, payment_method: nil, payment_status: nil, payment_step: nil, security_code: nil, to: nil) ⇒ Object constructor
• #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(attempt: nil, bank_account_number: nil, bank_account_type: nil, bank_routing_number: nil, call_control_id: nil, call_leg_id: nil, call_session_id: nil, client_state: nil, connection_id: nil, error_type: nil, expiration_date: nil, from: nil, payment_card_number: nil, payment_card_postal_code: nil, payment_card_type: nil, payment_connector: nil, payment_method: nil, payment_status: nil, payment_step: nil, security_code: nil, to: nil) ⇒ Object

Parameters:

• attempt (Integer) (defaults to: nil) —

  Current 1-based attempt number for the step.

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

  Masked bank account number with only the last two digits visible.

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

  Bank account type, when available.

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

  Bank routing number collected from the caller.

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

  Call ID used to issue commands via Call Control API.

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

  ID unique to the call leg.

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

  ID shared by related call legs in the same call session.

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

  Base64-encoded state received from the command.

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

  Call Control App ID used in the call.

• error_type (Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::ErrorType) (defaults to: nil) —

  Step-level error when payment collection fails.

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

  Card expiration date in MMYY format.

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

  Number or SIP URI placing the call.

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

  Masked card number with only the last four digits visible.

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

  Billing postal code collected from the caller.

• payment_card_type (Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentCardType) (defaults to: nil) —

  Detected card type. Present only for the recognized card brands listed below.

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

  Name of the Pay connector used.

• payment_method (Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentMethod) (defaults to: nil) —

  Payment method being collected.

• payment_status (Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStatus) (defaults to: nil) —

  Status of the current payment step.

• payment_step (Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStep) (defaults to: nil) —

  Current payment collection or processing step.

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

  Fully masked card security code.

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

  Destination number or SIP URI of the call.

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 199

Instance Attribute Details

#attempt ⇒ Integer^?

Current 1-based attempt number for the step.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 74

optional :attempt, Integer

#bank_account_number ⇒ String^?

Masked bank account number with only the last two digits visible.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 80

optional :bank_account_number, String

#bank_account_type ⇒ String^?

Bank account type, when available.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 86

optional :bank_account_type, String

#bank_routing_number ⇒ String^?

Bank routing number collected from the caller.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 92

optional :bank_routing_number, String

#call_control_id ⇒ String^?

Call ID used to issue commands via Call Control API.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 98

optional :call_control_id, String

#call_leg_id ⇒ String^?

ID unique to the call leg.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 104

optional :call_leg_id, String

#call_session_id ⇒ String^?

ID shared by related call legs in the same call session.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 110

optional :call_session_id, String

#client_state ⇒ String^?

Base64-encoded state received from the command.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 116

optional :client_state, String

#connection_id ⇒ String^?

Call Control App ID used in the call.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 122

optional :connection_id, String

#error_type ⇒ Symbol, ...

Step-level error when payment collection fails.

Returns:

• (Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::ErrorType, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 128

optional :error_type, enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::Payload::ErrorType }

#expiration_date ⇒ String^?

Card expiration date in MMYY format.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 134

optional :expiration_date, String

#from ⇒ String^?

Number or SIP URI placing the call.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 140

optional :from, String

#payment_card_number ⇒ String^?

Masked card number with only the last four digits visible.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 146

optional :payment_card_number, String

#payment_card_postal_code ⇒ String^?

Billing postal code collected from the caller.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 152

optional :payment_card_postal_code, String

#payment_card_type ⇒ Symbol, ...

Detected card type. Present only for the recognized card brands listed below.

Returns:

• (Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentCardType, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 158

optional :payment_card_type,
enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::Payload::PaymentCardType }

#payment_connector ⇒ String^?

Name of the Pay connector used.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 165

optional :payment_connector, String

#payment_method ⇒ Symbol, ...

Payment method being collected.

Returns:

• (Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentMethod, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 171

optional :payment_method,
enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::Payload::PaymentMethod }

#payment_status ⇒ Symbol, ...

Status of the current payment step.

Returns:

• (Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStatus, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 178

optional :payment_status,
enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStatus }

#payment_step ⇒ Symbol, ...

Current payment collection or processing step.

Returns:

• (Symbol, Telnyx::Models::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStep, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 185

optional :payment_step, enum: -> { Telnyx::CallPaymentProgressWebhookEvent::Data::Payload::PaymentStep }

#security_code ⇒ String^?

Fully masked card security code.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 191

optional :security_code, String

#to ⇒ String^?

Destination number or SIP URI of the call.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 197

optional :to, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/call_payment_progress_webhook_event.rb', line 257

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/call_payment_progress_webhook_event.rbs', line 225

def to_hash: -> {