Class: Telnyx::Resources::NumberOrders

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

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:



117
118
119
 
# File 'lib/telnyx/resources/number_orders.rb', line 117

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 a phone number order.

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:



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

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.

Get a paginated list of number orders.

Parameters:

Returns:

See Also:



101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/telnyx/resources/number_orders.rb', line 101

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

Get an existing phone number order.

Parameters:

  • number_order_id (String) —

    The number order ID.

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

Returns:

See Also:



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

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 a phone number order.

Parameters:

Returns:

See Also:



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

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