Class: Telnyx::Resources::Reports::CdrUsageReports

Inherits:

Object

• Object
• Telnyx::Resources::Reports::CdrUsageReports

Defined in:

lib/telnyx/resources/reports/cdr_usage_reports.rb

Overview

Voice usage reports

Instance Method Summary

• #fetch_sync(aggregation_type:, product_breakdown:, connections: nil, end_date: nil, start_date: nil, request_options: {}) ⇒ Telnyx::Models::Reports::CdrUsageReportFetchSyncResponse

  Generate and fetch voice usage report synchronously.

• #initialize(client:) ⇒ CdrUsageReports constructor private

  A new instance of CdrUsageReports.

Constructor Details

#initialize(client:) ⇒ CdrUsageReports

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

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/reports/cdr_usage_reports.rb', line 39

def initialize(client:)
  @client = client
end

Instance Method Details

#fetch_sync(aggregation_type:, product_breakdown:, connections: nil, end_date: nil, start_date: nil, request_options: {}) ⇒ Telnyx::Models::Reports::CdrUsageReportFetchSyncResponse

Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.

Parameters:

• aggregation_type (Symbol, Telnyx::Models::Reports::CdrUsageReportFetchSyncParams::AggregationType)
• product_breakdown (Symbol, Telnyx::Models::Reports::CdrUsageReportFetchSyncParams::ProductBreakdown)
• connections (Array<Float>)
• end_date (Time)
• start_date (Time)
• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Telnyx::Models::Reports::CdrUsageReportFetchSyncResponse)

See Also:

• Models::Reports::CdrUsageReportFetchSyncParams

# File 'lib/telnyx/resources/reports/cdr_usage_reports.rb', line 24

def fetch_sync(params)
  parsed, options = Telnyx::Reports::CdrUsageReportFetchSyncParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "reports/cdr_usage_reports/sync",
    query: query,
    model: Telnyx::Models::Reports::CdrUsageReportFetchSyncResponse,
    options: options
  )
end