Class: Zavudev::Models::PhoneNumberSearchAvailableParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/zavudev/models/phone_number_search_available_params.rb,
sig/zavudev/models/phone_number_search_available_params.rbs

Overview

See Also:

  • Zavudev::Resources::PhoneNumbers#search_available

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(country_code:, capabilities: nil, contains: nil, limit: nil, type: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Zavudev::Models::PhoneNumberSearchAvailableParams for more details.

Parameters:

  • country_code (String) —

    Two-letter ISO country code.

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

    Comma-separated capabilities the number must have: sms, voice, mms. Number

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

    Search for numbers containing this string.

  • limit (Integer) (defaults to: nil) —

    Maximum number of results to return.

  • type (Symbol, Zavudev::Models::PhoneNumberType) (defaults to: nil) —

    Type of phone number to search for.

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



# File 'lib/zavudev/models/phone_number_search_available_params.rb', line 41

Instance Attribute Details

#capabilities ⇒ String?

Comma-separated capabilities the number must have: sms, voice, mms. Numbers missing any of them are dropped.

Parameters:

  • (String)

Returns:

  • (String, nil) 


21
 
# File 'lib/zavudev/models/phone_number_search_available_params.rb', line 21

optional :capabilities, String

#contains ⇒ String?

Search for numbers containing this string.

Parameters:

  • (String)

Returns:

  • (String, nil) 


27
 
# File 'lib/zavudev/models/phone_number_search_available_params.rb', line 27

optional :contains, String

#country_code ⇒ String

Two-letter ISO country code.

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/zavudev/models/phone_number_search_available_params.rb', line 14

required :country_code, String

#limit ⇒ Integer?

Maximum number of results to return.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


33
 
# File 'lib/zavudev/models/phone_number_search_available_params.rb', line 33

optional :limit, Integer

#type ⇒ Symbol, ...

Type of phone number to search for.

Returns:



39
 
# File 'lib/zavudev/models/phone_number_search_available_params.rb', line 39

optional :type, enum: -> { Zavudev::PhoneNumberType }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


46
 
# File 'sig/zavudev/models/phone_number_search_available_params.rbs', line 46

def to_hash: -> {