Class: Telnyx::Resources::PortingPhoneNumbers

Inherits:

Object

• Object
• Telnyx::Resources::PortingPhoneNumbers

Defined in:

lib/telnyx/resources/porting_phone_numbers.rb

Instance Method Summary

• #initialize(client:) ⇒ PortingPhoneNumbers constructor private

  A new instance of PortingPhoneNumbers.

• #list(filter: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::PortingPhoneNumberListResponse>

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

Constructor Details

#initialize(client:) ⇒ PortingPhoneNumbers

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

Parameters:

• client (Telnyx::Client)

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

def initialize(client:)
  @client = client
end

Instance Method Details

#list(filter: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::PortingPhoneNumberListResponse>

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

Returns a list of your porting phone numbers.

Parameters:

• filter (Telnyx::Models::PortingPhoneNumberListParams::Filter) —

  Consolidated filter parameter (deepObject style). Originally: filter[porting_ord

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

Returns:

• (Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::PortingPhoneNumberListResponse>)

See Also:

• Models::PortingPhoneNumberListParams

# File 'lib/telnyx/resources/porting_phone_numbers.rb', line 24

def list(params = {})
  parsed, options = Telnyx::PortingPhoneNumberListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "porting_phone_numbers",
    query: parsed.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::PortingPhoneNumberListResponse,
    options: options
  )
end