Class: PreludeSDK::Resources::Lookup

Inherits:

Object

• Object
• PreludeSDK::Resources::Lookup

Defined in:

lib/prelude_sdk/resources/lookup.rb

Overview

Retrieve detailed information about a phone number including carrier data, line type, and portability status.

Instance Method Summary

• #initialize(client:) ⇒ Lookup constructor private

  A new instance of Lookup.

• #lookup(phone_number, type: nil, request_options: {}) ⇒ PreludeSDK::Models::LookupLookupResponse

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

Constructor Details

#initialize(client:) ⇒ Lookup

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

Parameters:

• client (PreludeSDK::Client)

# File 'lib/prelude_sdk/resources/lookup.rb', line 40

def initialize(client:)
  @client = client
end

Instance Method Details

#lookup(phone_number, type: nil, request_options: {}) ⇒ PreludeSDK::Models::LookupLookupResponse

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

Retrieve detailed information about a phone number including carrier data, line type, and portability status.

Parameters:

• phone_number (String) —

  An E.164 formatted phone number to look up.

• type (Array<Symbol, PreludeSDK::Models::LookupLookupParams::Type>) —

  Optional features. Possible values are:

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

Returns:

• (PreludeSDK::Models::LookupLookupResponse)

See Also:

• Models::LookupLookupParams

# File 'lib/prelude_sdk/resources/lookup.rb', line 25

def lookup(phone_number, params = {})
  parsed, options = PreludeSDK::LookupLookupParams.dump_request(params)
  query = PreludeSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["v2/lookup/%1$s", phone_number],
    query: query,
    model: PreludeSDK::Models::LookupLookupResponse,
    options: options
  )
end