Class: Telnyx::Resources::MessagingProfileMetrics

Inherits:

Object

Object
Telnyx::Resources::MessagingProfileMetrics

show all

Defined in:: lib/telnyx/resources/messaging_profile_metrics.rb

Instance Method Summary collapse

#initialize(client:) ⇒ MessagingProfileMetrics constructor private

A new instance of MessagingProfileMetrics.
#list(time_frame: nil, request_options: {}) ⇒ Telnyx::Models::MessagingProfileMetricListResponse

List high-level metrics for all messaging profiles belonging to the authenticated user.

Constructor Details

#initialize(client:) ⇒ `MessagingProfileMetrics`

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

Parameters:

client (Telnyx::Client)



33
34
35

# File 'lib/telnyx/resources/messaging_profile_metrics.rb', line 33

def initialize(client:)
  @client = client
end

Instance Method Details

#list(time_frame: nil, request_options: {}) ⇒ `Telnyx::Models::MessagingProfileMetricListResponse`

List high-level metrics for all messaging profiles belonging to the authenticated user.

Parameters:

time_frame (Symbol, Telnyx::Models::MessagingProfileMetricListParams::TimeFrame) —

The time frame for metrics.
request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

(Telnyx::Models::MessagingProfileMetricListResponse)

See Also:

Models::MessagingProfileMetricListParams

# File 'lib/telnyx/resources/messaging_profile_metrics.rb', line 18

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