Class: Telnyx::Resources::AvailablePhoneNumbers

Inherits:

Object

• Object
• Telnyx::Resources::AvailablePhoneNumbers

Defined in:

lib/telnyx/resources/available_phone_numbers.rb

Overview

Number search

Instance Method Summary

• #initialize(client:) ⇒ AvailablePhoneNumbers constructor private

  A new instance of AvailablePhoneNumbers.

• #list(filter: nil, request_options: {}) ⇒ Telnyx::Models::AvailablePhoneNumberListResponse

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

Constructor Details

#initialize(client:) ⇒ AvailablePhoneNumbers

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of AvailablePhoneNumbers.

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/available_phone_numbers.rb', line 36

def initialize(client:)
  @client = client
end

Instance Method Details

#list(filter: nil, request_options: {}) ⇒ Telnyx::Models::AvailablePhoneNumberListResponse

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

List available phone numbers

Parameters:

• filter (Telnyx::Models::AvailablePhoneNumberListParams::Filter) —

  Consolidated filter parameter (deepObject style). Originally: filter[phone_numbe

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Telnyx::Models::AvailablePhoneNumberListResponse)

See Also:

• Models::AvailablePhoneNumberListParams

# File 'lib/telnyx/resources/available_phone_numbers.rb', line 21

def list(params = {})
  parsed, options = Telnyx::AvailablePhoneNumberListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "available_phone_numbers",
    query: query,
    model: Telnyx::Models::AvailablePhoneNumberListResponse,
    options: options
  )
end