Class: Telnyx::Resources::PortingOrders::PhoneNumberBlocks

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

Overview

Endpoints related to porting orders management.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PhoneNumberBlocks

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

Parameters:



102
103
104
 
# File 'lib/telnyx/resources/porting_orders/phone_number_blocks.rb', line 102

def initialize(client:)
  @client = client
end

Instance Method Details

#create(porting_order_id, activation_ranges:, phone_number_range:, request_options: {}) ⇒ Telnyx::Models::PortingOrders::PhoneNumberBlockCreateResponse

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

Creates a new phone number block.

Parameters:

Returns:

See Also:



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

def create(porting_order_id, params)
  parsed, options = Telnyx::PortingOrders::PhoneNumberBlockCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["porting_orders/%1$s/phone_number_blocks", porting_order_id],
    body: parsed,
    model: Telnyx::Models::PortingOrders::PhoneNumberBlockCreateResponse,
    options: options
  )
end

#delete(id, porting_order_id:, request_options: {}) ⇒ Telnyx::Models::PortingOrders::PhoneNumberBlockDeleteResponse

Deletes a phone number block.

Parameters:

  • id (String) —

    Identifies the phone number block to be deleted

  • porting_order_id (String) —

    Identifies the Porting Order associated with the phone number block

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

Returns:

See Also:



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/telnyx/resources/porting_orders/phone_number_blocks.rb', line 85

def delete(id, params)
  parsed, options = Telnyx::PortingOrders::PhoneNumberBlockDeleteParams.dump_request(params)
  porting_order_id =
    parsed.delete(:porting_order_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["porting_orders/%1$s/phone_number_blocks/%2$s", porting_order_id, id],
    model: Telnyx::Models::PortingOrders::PhoneNumberBlockDeleteResponse,
    options: options
  )
end

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

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

Returns a list of all phone number blocks of a porting order.

Parameters:

Returns:

See Also:



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/telnyx/resources/porting_orders/phone_number_blocks.rb', line 59

def list(porting_order_id, params = {})
  parsed, options = Telnyx::PortingOrders::PhoneNumberBlockListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["porting_orders/%1$s/phone_number_blocks", porting_order_id],
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::PortingOrders::PortingPhoneNumberBlock,
    options: options
  )
end