Class: Telnyx::Resources::SimCardOrders

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

Overview

SIM Card Orders operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ SimCardOrders

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

Parameters:



85
86
87
 
# File 'lib/telnyx/resources/sim_card_orders.rb', line 85

def initialize(client:)
  @client = client
end

Instance Method Details

#create(address_id:, quantity:, request_options: {}) ⇒ Telnyx::Models::SimCardOrderCreateResponse

Creates a new order for SIM cards.

Parameters:

  • address_id (String) —

    Uniquely identifies the address for the order.

  • quantity (Integer) —

    The amount of SIM cards to order.

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

Returns:

See Also:



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/telnyx/resources/sim_card_orders.rb', line 20

def create(params)
  parsed, options = Telnyx::SimCardOrderCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "sim_card_orders",
    body: parsed,
    model: Telnyx::Models::SimCardOrderCreateResponse,
    options: options
  )
end

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

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

Get all SIM card orders according to filters.

Parameters:

Returns:

See Also:



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/telnyx/resources/sim_card_orders.rb', line 69

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

#retrieve(id, request_options: {}) ⇒ Telnyx::Models::SimCardOrderRetrieveResponse

Get a single SIM card order by its ID.

Parameters:

  • id (String) —

    Identifies the resource.

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

Returns:

See Also:



42
43
44
45
46
47
48
49
 
# File 'lib/telnyx/resources/sim_card_orders.rb', line 42

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