Class: Telnyx::Resources::SimCardOrderPreview

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

Overview

SIM Card Orders operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ SimCardOrderPreview

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

Parameters:



37
38
39
 
# File 'lib/telnyx/resources/sim_card_order_preview.rb', line 37

def initialize(client:)
  @client = client
end

Instance Method Details

#preview(address_id:, quantity:, request_options: {}) ⇒ Telnyx::Models::SimCardOrderPreviewPreviewResponse

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

Preview SIM card order purchases.

Parameters:

  • address_id (String) —

    Uniquely identifies the address for the order.

  • quantity (Integer) —

    The amount of SIM cards that the user would like to purchase in the SIM card ord

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

Returns:

See Also:



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

def preview(params)
  parsed, options = Telnyx::SimCardOrderPreviewPreviewParams.dump_request(params)
  @client.request(
    method: :post,
    path: "sim_card_order_preview",
    body: parsed,
    model: Telnyx::Models::SimCardOrderPreviewPreviewResponse,
    options: options
  )
end