Class: Telnyx::Resources::InventoryCoverage

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

Overview

Inventory Level

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InventoryCoverage

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

Parameters:



38
39
40
 
# File 'lib/telnyx/resources/inventory_coverage.rb', line 38

def initialize(client:)
  @client = client
end

Instance Method Details

#list(filter: nil, request_options: {}) ⇒ Telnyx::Models::InventoryCoverageListResponse

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

Creates an inventory coverage request. If locality, npa or national_destination_code is used in groupBy, and no region or locality filters are used, the whole paginated set is returned.

Parameters:

Returns:

See Also:



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

def list(params = {})
  parsed, options = Telnyx::InventoryCoverageListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "inventory_coverage",
    query: query,
    model: Telnyx::Models::InventoryCoverageListResponse,
    options: options
  )
end