Class: Telnyx::Resources::PhoneNumbersRegulatoryRequirements

Inherits:

Object

Object
Telnyx::Resources::PhoneNumbersRegulatoryRequirements

show all

Defined in:: lib/telnyx/resources/phone_numbers_regulatory_requirements.rb

Overview

Regulatory Requirements

Instance Method Summary collapse

#initialize(client:) ⇒ PhoneNumbersRegulatoryRequirements constructor private

A new instance of PhoneNumbersRegulatoryRequirements.
#retrieve(filter: nil, request_options: {}) ⇒ Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse

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

Constructor Details

#initialize(client:) ⇒ `PhoneNumbersRegulatoryRequirements`

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

Parameters:

client (Telnyx::Client)



37
38
39

# File 'lib/telnyx/resources/phone_numbers_regulatory_requirements.rb', line 37

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(filter: nil, request_options: {}) ⇒ `Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse`

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

Retrieve regulatory requirements for a list of phone numbers

Parameters:

filter (Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveParams::Filter) —

Consolidated filter parameter (deepObject style). Originally: filter[phone_numbe
request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

(Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse)

See Also:

Models::PhoneNumbersRegulatoryRequirementRetrieveParams

# File 'lib/telnyx/resources/phone_numbers_regulatory_requirements.rb', line 22

def retrieve(params = {})
  parsed, options = Telnyx::PhoneNumbersRegulatoryRequirementRetrieveParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "phone_numbers_regulatory_requirements",
    query: query,
    model: Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse,
    options: options
  )
end