Class: Telnyx::Models::Portouts::EventRetrieveResponse::Data::WebhookPortoutStatusChanged::Payload

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/telnyx/models/portouts/event_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Method Summary collapse

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: nil, attempted_pin: nil, carrier_name: nil, phone_numbers: nil, rejection_reason: nil, spid: nil, status: nil, subscriber_name: nil, user_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Portouts::EventRetrieveResponse::Data::WebhookPortoutStatusChanged::Payload for more details.

The webhook payload for the portout.status_changed event

Parameters:

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

    Identifies the port out that was moved.

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

    The PIN that was attempted to be used to authorize the port out.

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

    Carrier the number will be ported out to

  • phone_numbers (Array<String>) (defaults to: nil) —

    Phone numbers associated with this port-out order

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

    The reason why the order is being rejected by the user. If the order is authoriz

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

    The new carrier SPID.

  • status (Symbol, Telnyx::Models::Portouts::EventRetrieveResponse::Data::WebhookPortoutStatusChanged::Payload::Status) (defaults to: nil) —

    The new status of the port out.

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

    The name of the port-out’s end user.

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

    Identifies the user that the port-out order belongs to.




# File 'lib/telnyx/models/portouts/event_retrieve_response.rb', line 194

Instance Attribute Details

#attempted_pin ⇒ String?

The PIN that was attempted to be used to authorize the port out.

Returns:

  • (String, nil) 


148
 
# File 'lib/telnyx/models/portouts/event_retrieve_response.rb', line 148

optional :attempted_pin, String

#carrier_name ⇒ String?

Carrier the number will be ported out to

Returns:

  • (String, nil) 


154
 
# File 'lib/telnyx/models/portouts/event_retrieve_response.rb', line 154

optional :carrier_name, String

#id ⇒ String?

Identifies the port out that was moved.

Returns:

  • (String, nil) 


142
 
# File 'lib/telnyx/models/portouts/event_retrieve_response.rb', line 142

optional :id, String

#phone_numbers ⇒ Array<String>?

Phone numbers associated with this port-out order

Returns:

  • (Array<String>, nil) 


160
 
# File 'lib/telnyx/models/portouts/event_retrieve_response.rb', line 160

optional :phone_numbers, Telnyx::Internal::Type::ArrayOf[String]

#rejection_reason ⇒ String?

The reason why the order is being rejected by the user. If the order is authorized, this field can be left null

Returns:

  • (String, nil) 


167
 
# File 'lib/telnyx/models/portouts/event_retrieve_response.rb', line 167

optional :rejection_reason, String, nil?: true

#spid ⇒ String?

The new carrier SPID.

Returns:

  • (String, nil) 


173
 
# File 'lib/telnyx/models/portouts/event_retrieve_response.rb', line 173

optional :spid, String

#status ⇒ Symbol, ...

The new status of the port out.

Returns:



179
180
 
# File 'lib/telnyx/models/portouts/event_retrieve_response.rb', line 179

optional :status,
enum: -> { Telnyx::Models::Portouts::EventRetrieveResponse::Data::WebhookPortoutStatusChanged::Payload::Status }

#subscriber_name ⇒ String?

The name of the port-out’s end user.

Returns:

  • (String, nil) 


186
 
# File 'lib/telnyx/models/portouts/event_retrieve_response.rb', line 186

optional :subscriber_name, String

#user_id ⇒ String?

Identifies the user that the port-out order belongs to.

Returns:

  • (String, nil) 


192
 
# File 'lib/telnyx/models/portouts/event_retrieve_response.rb', line 192

optional :user_id, String