Class: Telnyx::Resources::GlobalIPUsage

Inherits:

Object

• Object
• Telnyx::Resources::GlobalIPUsage

Defined in:

lib/telnyx/resources/global_ip_usage.rb

Overview

Global IPs

Instance Method Summary

• #initialize(client:) ⇒ GlobalIPUsage constructor private

  A new instance of GlobalIPUsage.

• #retrieve(filter: nil, request_options: {}) ⇒ Telnyx::Models::GlobalIPUsageRetrieveResponse

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

Constructor Details

#initialize(client:) ⇒ GlobalIPUsage

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

Parameters:

• client (Telnyx::Client)

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

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(filter: nil, request_options: {}) ⇒ Telnyx::Models::GlobalIPUsageRetrieveResponse

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

Global IP Usage Metrics

Parameters:

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

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

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

Returns:

• (Telnyx::Models::GlobalIPUsageRetrieveResponse)

See Also:

• Models::GlobalIPUsageRetrieveParams

# File 'lib/telnyx/resources/global_ip_usage.rb', line 21

def retrieve(params = {})
  parsed, options = Telnyx::GlobalIPUsageRetrieveParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "global_ip_usage",
    query: query,
    model: Telnyx::Models::GlobalIPUsageRetrieveResponse,
    options: options
  )
end