Class: SurgeAPI::Models::PhoneNumberListAvailableNumbersParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• SurgeAPI::Models::PhoneNumberListAvailableNumbersParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/surge_api/models/phone_number_list_available_numbers_params.rb,
sig/surge_api/models/phone_number_list_available_numbers_params.rbs

Overview

See Also:

• SurgeAPI::Resources::PhoneNumbers#list_available_numbers

Defined Under Namespace

Modules: Country, Type

Instance Attribute Summary

• #account_id ⇒ String

  The account ID to list available phone numbers for.

• #after ⇒ String^?

  Cursor for forward pagination.

• #area_code ⇒ String^?

  Filter by 3-digit area code.

• #before ⇒ String^?

  Cursor for backward pagination.

• #country ⇒ Symbol, ...

  ISO country code to search in.

• #type ⇒ Symbol, SurgeAPI::Models::PhoneNumberListAvailableNumbersParams::Type

  Whether to search for local or toll-free numbers.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(account_id:, type:, after: nil, area_code: nil, before: nil, country: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see PhoneNumberListAvailableNumbersParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(account_id:, type:, after: nil, area_code: nil, before: nil, country: nil, request_options: {}) ⇒ Object

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

Parameters:

• account_id (String) —

  The account ID to list available phone numbers for.

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

  Whether to search for local or toll-free numbers.

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

  Cursor for forward pagination. Use the next_cursor from a previous response.

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

  Filter by 3-digit area code.

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

  Cursor for backward pagination. Use the previous_cursor from a previous response

• country (Symbol, SurgeAPI::Models::PhoneNumberListAvailableNumbersParams::Country) (defaults to: nil) —

  ISO country code to search in.

• request_options (SurgeAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/surge_api/models/phone_number_list_available_numbers_params.rb', line 47

Instance Attribute Details

#account_id ⇒ String

The account ID to list available phone numbers for.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/surge_api/models/phone_number_list_available_numbers_params.rb', line 14

required :account_id, String

#after ⇒ String^?

Cursor for forward pagination. Use the next_cursor from a previous response.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :after, String

#area_code ⇒ String^?

Filter by 3-digit area code.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :area_code, String

#before ⇒ String^?

Cursor for backward pagination. Use the previous_cursor from a previous response.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/surge_api/models/phone_number_list_available_numbers_params.rb', line 39

optional :before, String

#country ⇒ Symbol, ...

ISO country code to search in.

Returns:

• (Symbol, SurgeAPI::Models::PhoneNumberListAvailableNumbersParams::Country, nil)

# File 'lib/surge_api/models/phone_number_list_available_numbers_params.rb', line 45

optional :country, enum: -> { SurgeAPI::PhoneNumberListAvailableNumbersParams::Country }

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

Whether to search for local or toll-free numbers.

Parameters:

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

Returns:

• (Symbol, SurgeAPI::Models::PhoneNumberListAvailableNumbersParams::Type)

# File 'lib/surge_api/models/phone_number_list_available_numbers_params.rb', line 20

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/surge_api/models/phone_number_list_available_numbers_params.rb', line 72

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/surge_api/models/phone_number_list_available_numbers_params.rbs', line 50

def to_hash: -> {