Class: Telnyx::Resources::NumberBlockOrders

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ NumberBlockOrders

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

Parameters:



90
91
92
 
# File 'lib/telnyx/resources/number_block_orders.rb', line 90

def initialize(client:)
  @client = client
end

Instance Method Details

#create(range:, starting_number:, connection_id: nil, customer_reference: nil, messaging_profile_id: nil, request_options: {}) ⇒ Telnyx::Models::NumberBlockOrderCreateResponse

Creates a phone number block order.

Parameters:

  • range (Integer) —

    The phone number range included in the block.

  • starting_number (String) —

    Starting phone number block

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

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

Returns:

See Also:



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

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

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

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

Get a paginated list of number block orders.

Parameters:

Returns:

See Also:



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

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

#retrieve(number_block_order_id, request_options: {}) ⇒ Telnyx::Models::NumberBlockOrderRetrieveResponse

Get an existing phone number block order.

Parameters:

  • number_block_order_id (String) —

    The number block order ID.

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

Returns:

See Also:



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

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