Class: SurgeAPI::Models::Message::Conversation::PhoneNumber

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/surge_api/models/message.rb

Overview

See Also:

Defined Under Namespace

Modules: Type

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:, name:, number:, type:) ⇒ Object

This is the phone number tied to the Surge account.

Parameters:

  • id (String) —

    Unique identifier for the phone number

  • name (String, nil) —

    A human-readable name for the phone number

  • number (String) —

    The canonical format of the phone number.

  • type (Symbol, SurgeAPI::Models::Message::Conversation::PhoneNumber::Type) —

    Whether the phone number is local, toll-free, or short code




# File 'lib/surge_api/models/message.rb', line 160

Instance Attribute Details

#id ⇒ String

Unique identifier for the phone number

Returns:

  • (String) 


140
 
# File 'lib/surge_api/models/message.rb', line 140

required :id, String

#name ⇒ String?

A human-readable name for the phone number

Returns:

  • (String, nil) 


146
 
# File 'lib/surge_api/models/message.rb', line 146

required :name, String, nil?: true

#number ⇒ String

The canonical format of the phone number.

Returns:

  • (String) 


152
 
# File 'lib/surge_api/models/message.rb', line 152

required :number, String

#type ⇒ Symbol, SurgeAPI::Models::Message::Conversation::PhoneNumber::Type

Whether the phone number is local, toll-free, or short code

Returns:



158
 
# File 'lib/surge_api/models/message.rb', line 158

required :type, enum: -> { SurgeAPI::Message::Conversation::PhoneNumber::Type }