Class: Telnyx::Models::ChargesBreakdownRetrieveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/charges_breakdown_retrieve_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Format

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(start_date:, end_date: nil, format_: nil, request_options: {}) ⇒ Object

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

Parameters:

  • start_date (Date) —

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

  • end_date (Date) (defaults to: nil) —

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

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

    Response format

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



# File 'lib/telnyx/models/charges_breakdown_retrieve_params.rb', line 31

Instance Attribute Details

#end_date ⇒ Date?

End date for the charges breakdown in ISO date format (YYYY-MM-DD). If not provided, defaults to start_date + 1 month. The date is exclusive, data for the end_date itself is not included in the report. The interval between start_date and end_date cannot exceed 31 days.

Returns:

  • (Date, nil) 


23
 
# File 'lib/telnyx/models/charges_breakdown_retrieve_params.rb', line 23

optional :end_date, Date

#format_ ⇒ Symbol, ...

Response format

Returns:



29
 
# File 'lib/telnyx/models/charges_breakdown_retrieve_params.rb', line 29

optional :format_, enum: -> { Telnyx::ChargesBreakdownRetrieveParams::Format }

#start_date ⇒ Date

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

Returns:

  • (Date) 


14
 
# File 'lib/telnyx/models/charges_breakdown_retrieve_params.rb', line 14

required :start_date, Date