Class: Telnyx::Resources::AvailablePhoneNumberBlocks

Inherits:

Object

Object
Telnyx::Resources::AvailablePhoneNumberBlocks

show all

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

Instance Method Summary collapse

#initialize(client:) ⇒ AvailablePhoneNumberBlocks constructor private

A new instance of AvailablePhoneNumberBlocks.
#list(filter: nil, request_options: {}) ⇒ Telnyx::Models::AvailablePhoneNumberBlockListResponse

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

Constructor Details

#initialize(client:) ⇒ `AvailablePhoneNumberBlocks`

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

Parameters:

client (Telnyx::Client)



34
35
36

# File 'lib/telnyx/resources/available_phone_number_blocks.rb', line 34

def initialize(client:)
  @client = client
end

Instance Method Details

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

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

List available phone number blocks

Parameters:

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

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

Returns:

(Telnyx::Models::AvailablePhoneNumberBlockListResponse)

See Also:

Models::AvailablePhoneNumberBlockListParams

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

def list(params = {})
  parsed, options = Telnyx::AvailablePhoneNumberBlockListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "available_phone_number_blocks",
    query: parsed,
    model: Telnyx::Models::AvailablePhoneNumberBlockListResponse,
    options: options
  )
end