Class: Telnyx::Resources::NumberLookup

Inherits:

Object

• Object
• Telnyx::Resources::NumberLookup

Defined in:

lib/telnyx/resources/number_lookup.rb

Overview

Look up phone number data

Instance Method Summary

• #initialize(client:) ⇒ NumberLookup constructor private

  A new instance of NumberLookup.

• #retrieve(phone_number, type: nil, request_options: {}) ⇒ Telnyx::Models::NumberLookupRetrieveResponse

  Returns information about the provided phone number.

Constructor Details

#initialize(client:) ⇒ NumberLookup

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 NumberLookup.

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/number_lookup.rb', line 35

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(phone_number, type: nil, request_options: {}) ⇒ Telnyx::Models::NumberLookupRetrieveResponse

Returns information about the provided phone number.

Parameters:

• phone_number (String) —

  The phone number to be looked up

• type (Symbol, Telnyx::Models::NumberLookupRetrieveParams::Type) —

  Specifies the type of number lookup to be performed

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

Returns:

• (Telnyx::Models::NumberLookupRetrieveResponse)

See Also:

• Models::NumberLookupRetrieveParams

# File 'lib/telnyx/resources/number_lookup.rb', line 20

def retrieve(phone_number, params = {})
  parsed, options = Telnyx::NumberLookupRetrieveParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["number_lookup/%1$s", phone_number],
    query: query,
    model: Telnyx::Models::NumberLookupRetrieveResponse,
    options: options
  )
end