Class: Telnyx::Resources::InventoryCoverage

Inherits:

Object

• Object
• Telnyx::Resources::InventoryCoverage

Defined in:

lib/telnyx/resources/inventory_coverage.rb

Instance Method Summary

• #initialize(client:) ⇒ InventoryCoverage constructor private

  A new instance of InventoryCoverage.

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

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

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:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/inventory_coverage.rb', line 36

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:

• filter (Telnyx::Models::InventoryCoverageListParams::Filter) —

  Consolidated filter parameter (deepObject style). Originally: filter, filte

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

Returns:

• (Telnyx::Models::InventoryCoverageListResponse)

See Also:

• Models::InventoryCoverageListParams

# File 'lib/telnyx/resources/inventory_coverage.rb', line 22

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