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

Overview

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

Parameters:

  • country_code (String)

    Two-letter ISO country code.

  • 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 34

Instance Attribute Details

#containsString?

Search for numbers containing this string.

Returns:

  • (String, nil)


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

optional :contains, String

#country_codeString

Two-letter ISO country code.

Returns:

  • (String)


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

required :country_code, String

#limitInteger?

Maximum number of results to return.

Returns:

  • (Integer, nil)


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

optional :limit, Integer

#typeSymbol, ...

Type of phone number to search for.

Returns:



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

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