Class: Telnyx::Resources::NumberOrders

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/number_orders.rb,
sig/telnyx/resources/number_orders.rbs

Overview

Number orders

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ NumberOrders

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

Parameters:



121
122
123
 
# File 'lib/telnyx/resources/number_orders.rb', line 121

def initialize(client:)
  @client = client
end

Instance Method Details

#create(billing_group_id: nil, connection_id: nil, customer_reference: nil, messaging_profile_id: nil, phone_numbers: nil, request_options: {}) ⇒ Telnyx::Models::NumberOrderCreateResponse

Creates an order to purchase the specified phone numbers and returns the created order. Track fulfillment through the order's status.

Parameters:

  • billing_group_id (String) —

    Identifies the billing group associated with the phone number.

  • connection_id (String) —

    Identifies the connection associated with this phone number.

  • customer_reference (String) —

    A customer reference string for customer look ups.

  • messaging_profile_id (String) —

    Identifies the messaging profile associated with the phone number.

  • phone_numbers (Array<Telnyx::Models::NumberOrderCreateParams::PhoneNumber>)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/telnyx/resources/number_orders.rb', line 27

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

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

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

Returns a paginated list of your phone number orders, with support for filtering.

Parameters:

Returns:

See Also:



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

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

#retrieve(number_order_id, request_options: {}) ⇒ Telnyx::Models::NumberOrderRetrieveResponse

Returns the details of an existing phone number order, including its status and the numbers included.

Parameters:

  • number_order_id (String) —

    The number order ID.

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

Returns:

See Also:



50
51
52
53
54
55
56
57
 
# File 'lib/telnyx/resources/number_orders.rb', line 50

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

#update(number_order_id, customer_reference: nil, regulatory_requirements: nil, request_options: {}) ⇒ Telnyx::Models::NumberOrderUpdateResponse

Updates an existing phone number order, for example to satisfy regulatory requirements attached to the order, and returns the updated order.

Parameters:

Returns:

See Also:



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/telnyx/resources/number_orders.rb', line 75

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