Class: Telnyx::Resources::SubNumberOrders

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ SubNumberOrders

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

Parameters:



131
132
133
 
# File 'lib/telnyx/resources/sub_number_orders.rb', line 131

def initialize(client:)
  @client = client
end

Instance Method Details

#cancel(sub_number_order_id, request_options: {}) ⇒ Telnyx::Models::SubNumberOrderCancelResponse

Allows you to cancel a sub number order in ‘pending’ status.

Parameters:

  • sub_number_order_id (String) —

    The ID of the sub number order.

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

Returns:

See Also:



95
96
97
98
99
100
101
102
 
# File 'lib/telnyx/resources/sub_number_orders.rb', line 95

def cancel(sub_number_order_id, params = {})
  @client.request(
    method: :patch,
    path: ["sub_number_orders/%1$s/cancel", sub_number_order_id],
    model: Telnyx::Models::SubNumberOrderCancelResponse,
    options: params[:request_options]
  )
end

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

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

Get a paginated list of sub number orders.

Parameters:

Returns:

See Also:



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/telnyx/resources/sub_number_orders.rb', line 72

def list(params = {})
  parsed, options = Telnyx::SubNumberOrderListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "sub_number_orders",
    query: query,
    model: Telnyx::Models::SubNumberOrderListResponse,
    options: options
  )
end

#retrieve(sub_number_order_id, filter: nil, request_options: {}) ⇒ Telnyx::Models::SubNumberOrderRetrieveResponse

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

Get an existing sub number order.

Parameters:

Returns:

See Also:



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/telnyx/resources/sub_number_orders.rb', line 22

def retrieve(sub_number_order_id, params = {})
  parsed, options = Telnyx::SubNumberOrderRetrieveParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["sub_number_orders/%1$s", sub_number_order_id],
    query: query,
    model: Telnyx::Models::SubNumberOrderRetrieveResponse,
    options: options
  )
end

#update(sub_number_order_id, regulatory_requirements: nil, request_options: {}) ⇒ Telnyx::Models::SubNumberOrderUpdateResponse

Updates a sub number order.

Parameters:

Returns:

See Also:



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/telnyx/resources/sub_number_orders.rb', line 47

def update(sub_number_order_id, params = {})
  parsed, options = Telnyx::SubNumberOrderUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["sub_number_orders/%1$s", sub_number_order_id],
    body: parsed,
    model: Telnyx::Models::SubNumberOrderUpdateResponse,
    options: options
  )
end

#update_requirement_group(id, requirement_group_id:, request_options: {}) ⇒ Telnyx::Models::SubNumberOrderUpdateRequirementGroupResponse

Update requirement group for a sub number order

Parameters:

  • id (String) —

    The ID of the sub number order

  • requirement_group_id (String) —

    The ID of the requirement group to associate

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

Returns:

See Also:



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/telnyx/resources/sub_number_orders.rb', line 117

def update_requirement_group(id, params)
  parsed, options = Telnyx::SubNumberOrderUpdateRequirementGroupParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["sub_number_orders/%1$s/requirement_group", id],
    body: parsed,
    model: Telnyx::Models::SubNumberOrderUpdateRequirementGroupResponse,
    options: options
  )
end