Class: Telnyx::Resources::ChargesBreakdown

Inherits:

Object

• Object
• Telnyx::Resources::ChargesBreakdown

Defined in:

lib/telnyx/resources/charges_breakdown.rb

Instance Method Summary

• #initialize(client:) ⇒ ChargesBreakdown constructor private

  A new instance of ChargesBreakdown.

• #retrieve(start_date:, end_date: nil, format_: nil, request_options: {}) ⇒ Telnyx::Models::ChargesBreakdownRetrieveResponse

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

Constructor Details

#initialize(client:) ⇒ ChargesBreakdown

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

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/charges_breakdown.rb', line 40

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(start_date:, end_date: nil, format_: nil, request_options: {}) ⇒ Telnyx::Models::ChargesBreakdownRetrieveResponse

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

Retrieve a detailed breakdown of monthly charges for phone numbers in a specified date range. The date range cannot exceed 31 days.

Parameters:

• start_date (Date) —

  Start date for the charges breakdown in ISO date format (YYYY-MM-DD)

• end_date (Date) —

  End date for the charges breakdown in ISO date format (YYYY-MM-DD). If not provi

• format_ (Symbol, Telnyx::Models::ChargesBreakdownRetrieveParams::Format) —

  Response format

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

Returns:

• (Telnyx::Models::ChargesBreakdownRetrieveResponse)

See Also:

• Models::ChargesBreakdownRetrieveParams

# File 'lib/telnyx/resources/charges_breakdown.rb', line 25

def retrieve(params)
  parsed, options = Telnyx::ChargesBreakdownRetrieveParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "charges_breakdown",
    query: query.transform_keys(format_: "format"),
    model: Telnyx::Models::ChargesBreakdownRetrieveResponse,
    options: options
  )
end