Class: SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse

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

Overview

See Also:

  • SurgeAPI::Resources::PhoneNumbers#list_available_numbers

Defined Under Namespace

Modules: Country, Type

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

A phone number available for purchase from Surge inventory

Parameters:




# File 'lib/surge_api/models/phone_number_list_available_numbers_response.rb', line 25

Instance Attribute Details

#country ⇒ Symbol, SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Country

ISO country code for the phone number

Parameters:

  • value (SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::country)

Returns:



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

required :country, enum: -> { SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Country }

#number ⇒ String

The phone number in E.164 format

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :number, String

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

Whether the phone number is local or toll-free

Parameters:

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

Returns:



23
 
# File 'lib/surge_api/models/phone_number_list_available_numbers_response.rb', line 23

required :type, enum: -> { SurgeAPI::Models::PhoneNumberListAvailableNumbersResponse::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/surge_api/models/phone_number_list_available_numbers_response.rb', line 43

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


23
 
# File 'sig/surge_api/models/phone_number_list_available_numbers_response.rbs', line 23

def to_hash: -> {