Class: Telnyx::Resources::VirtualCrossConnectsCoverage

Inherits:

Object

• Object
• Telnyx::Resources::VirtualCrossConnectsCoverage

Defined in:

lib/telnyx/resources/virtual_cross_connects_coverage.rb

Overview

Virtual Cross Connect operations

Instance Method Summary

• #initialize(client:) ⇒ VirtualCrossConnectsCoverage constructor private

  A new instance of VirtualCrossConnectsCoverage.

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

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

Constructor Details

#initialize(client:) ⇒ VirtualCrossConnectsCoverage

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

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/virtual_cross_connects_coverage.rb', line 45

def initialize(client:)
  @client = client
end

Instance Method Details

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

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

List Virtual Cross Connects Cloud Coverage.<br /><br />This endpoint shows which cloud regions are available for the ‘location_code` your Virtual Cross Connect will be provisioned in.

Parameters:

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

  Consolidated filter parameter (deepObject style). Originally: filter[cloud_provi

• filters (Telnyx::Models::VirtualCrossConnectsCoverageListParams::Filters) —

  Consolidated filters parameter (deepObject style). Originally: filters[available

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

Returns:

• (Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::VirtualCrossConnectsCoverageListResponse>)

See Also:

• Models::VirtualCrossConnectsCoverageListParams

# File 'lib/telnyx/resources/virtual_cross_connects_coverage.rb', line 29

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