Class: Telnyx::Resources::PortingOrders::ActionRequirements

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/porting_orders/action_requirements.rb

Overview

Endpoints related to porting orders management.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ActionRequirements

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

Parameters:



80
81
82
 
# File 'lib/telnyx/resources/porting_orders/action_requirements.rb', line 80

def initialize(client:)
  @client = client
end

Instance Method Details

#initiate(id, porting_order_id:, params:, request_options: {}) ⇒ Telnyx::Models::PortingOrders::ActionRequirementInitiateResponse

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

Initiates a specific action requirement for a porting order.

Parameters:

Returns:

See Also:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/telnyx/resources/porting_orders/action_requirements.rb', line 62

def initiate(id, params)
  parsed, options = Telnyx::PortingOrders::ActionRequirementInitiateParams.dump_request(params)
  porting_order_id =
    parsed.delete(:porting_order_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["porting_orders/%1$s/action_requirements/%2$s/initiate", porting_order_id, id],
    body: parsed,
    model: Telnyx::Models::PortingOrders::ActionRequirementInitiateResponse,
    options: options
  )
end

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

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

Returns a list of action requirements for a specific porting order.

Parameters:

Returns:

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/telnyx/resources/porting_orders/action_requirements.rb', line 30

def list(porting_order_id, params = {})
  parsed, options = Telnyx::PortingOrders::ActionRequirementListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["porting_orders/%1$s/action_requirements", porting_order_id],
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::PortingOrders::ActionRequirementListResponse,
    options: options
  )
end