Class: Telnyx::Resources::PhoneNumbersRegulatoryRequirements

Inherits:

Object

• Object
• Telnyx::Resources::PhoneNumbersRegulatoryRequirements

Defined in:

lib/telnyx/resources/phone_numbers_regulatory_requirements.rb,
sig/telnyx/resources/phone_numbers_regulatory_requirements.rbs

Overview

Regulatory Requirements

Instance Method Summary

• #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)
• client: (Telnyx::Client)

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

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.

Returns the regulatory requirements that apply to the supplied comma-separated phone numbers. The response includes the matching requirement records and pagination metadata.

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 24

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