Class: Telnyx::Resources::AdvancedOrders

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ AdvancedOrders

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

Parameters:



120
121
122
 
# File 'lib/telnyx/resources/advanced_orders.rb', line 120

def initialize(client:)
  @client = client
end

Instance Method Details

#create(area_code: nil, comments: nil, country_code: nil, customer_reference: nil, features: nil, phone_number_type: nil, quantity: nil, requirement_group_id: nil, request_options: {}) ⇒ Telnyx::Models::AdvancedOrderCreateResponse

Create Advanced Order

Parameters:

Returns:

See Also:



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

def create(params = {})
  parsed, options = Telnyx::AdvancedOrderCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "advanced_orders",
    body: parsed,
    model: Telnyx::Models::AdvancedOrderCreateResponse,
    options: options
  )
end

#list(request_options: {}) ⇒ Telnyx::Models::AdvancedOrderListResponse

List Advanced Orders

Parameters:

Returns:

See Also:



70
71
72
73
74
75
76
77
 
# File 'lib/telnyx/resources/advanced_orders.rb', line 70

def list(params = {})
  @client.request(
    method: :get,
    path: "advanced_orders",
    model: Telnyx::Models::AdvancedOrderListResponse,
    options: params[:request_options]
  )
end

#retrieve(order_id, request_options: {}) ⇒ Telnyx::Models::AdvancedOrderRetrieveResponse

Get Advanced Order

Parameters:

Returns:

See Also:



52
53
54
55
56
57
58
59
 
# File 'lib/telnyx/resources/advanced_orders.rb', line 52

def retrieve(order_id, params = {})
  @client.request(
    method: :get,
    path: ["advanced_orders/%1$s", order_id],
    model: Telnyx::Models::AdvancedOrderRetrieveResponse,
    options: params[:request_options]
  )
end

#update_requirement_group(advanced_order_id, area_code: nil, comments: nil, country_code: nil, customer_reference: nil, features: nil, phone_number_type: nil, quantity: nil, requirement_group_id: nil, request_options: {}) ⇒ Telnyx::Models::AdvancedOrderUpdateRequirementGroupResponse

Update Advanced Order

Parameters:

Returns:

See Also:



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/telnyx/resources/advanced_orders.rb', line 106

def update_requirement_group(advanced_order_id, params = {})
  parsed, options = Telnyx::AdvancedOrderUpdateRequirementGroupParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["advanced_orders/%1$s/requirement_group", advanced_order_id],
    body: parsed,
    model: Telnyx::Models::AdvancedOrderUpdateRequirementGroupResponse,
    options: options
  )
end