Class: SurgeAPI::Models::PhoneNumber

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/surge_api/models/phone_number.rb,
sig/surge_api/models/phone_number.rbs

Overview

See Also:

  • SurgeAPI::Resources::PhoneNumbers#retrieve

Defined Under Namespace

Modules: Type Classes: Campaign

Instance Attribute Summary collapse

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

Some parameter documentations has been truncated, see SurgeAPI::Models::PhoneNumber for more details.

A phone number that can be used to send and receive messages and calls

Parameters:

  • id (String) —

    Unique identifier for the phone number

  • campaign (SurgeAPI::Models::PhoneNumber::Campaign, nil) —

    Campaign attachment details for a domestic local phone number

  • campaign_id (String, nil) —

    Deprecated. The unique identifier of the campaign this phone number is attached

  • name (String, nil) —

    A human-readable name for the phone number

  • number (String) —

    The phone number in E.164 format

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

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




# File 'lib/surge_api/models/phone_number.rb', line 46

Instance Attribute Details

#campaign ⇒ SurgeAPI::Models::PhoneNumber::Campaign?

Campaign attachment details for a domestic local phone number

Parameters:

  • value (SurgeAPI::PhoneNumber::Campaign, nil)

Returns:



17
 
# File 'lib/surge_api/models/phone_number.rb', line 17

required :campaign, -> { SurgeAPI::PhoneNumber::Campaign }, nil?: true

#campaign_id ⇒ String?

Deprecated.

Use campaign.id instead.

Deprecated. The unique identifier of the campaign this phone number is attached to, if any

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


26
 
# File 'lib/surge_api/models/phone_number.rb', line 26

required :campaign_id, String, nil?: true

#id ⇒ String

Unique identifier for the phone number

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/surge_api/models/phone_number.rb', line 11

required :id, String

#name ⇒ String?

A human-readable name for the phone number

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


32
 
# File 'lib/surge_api/models/phone_number.rb', line 32

required :name, String, nil?: true

#number ⇒ String

The phone number in E.164 format

Parameters:

  • value (String)

Returns:

  • (String) 


38
 
# File 'lib/surge_api/models/phone_number.rb', line 38

required :number, String

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

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

Parameters:

  • value (SurgeAPI::Models::PhoneNumber::type_)

Returns:



44
 
# File 'lib/surge_api/models/phone_number.rb', line 44

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/surge_api/models/phone_number.rb', line 96

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


35
 
# File 'sig/surge_api/models/phone_number.rbs', line 35

def to_hash: -> {