Class: Telnyx::Models::Legacy::Reporting::UsageReports::VoiceCreateParams

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

Overview

See Also:

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(end_time:, start_time:, aggregation_type: nil, connections: nil, managed_accounts: nil, product_breakdown: nil, select_all_managed_accounts: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Legacy::Reporting::UsageReports::VoiceCreateParams for more details.

Parameters:

  • end_time (Time) —

    End time in ISO format

  • start_time (Time) —

    Start time in ISO format

  • aggregation_type (Integer) (defaults to: nil) —

    Aggregation type: All = 0, By Connections = 1, By Tags = 2, By Billing Group = 3

  • connections (Array<Integer>) (defaults to: nil) —

    List of connections to filter by

  • managed_accounts (Array<String>) (defaults to: nil) —

    List of managed accounts to include

  • product_breakdown (Integer) (defaults to: nil) —

    Product breakdown type: No breakdown = 0, DID vs Toll-free = 1, Country = 2, DID

  • select_all_managed_accounts (Boolean) (defaults to: nil) —

    Whether to select all managed accounts

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



# File 'lib/telnyx/models/legacy/reporting/usage_reports/voice_create_params.rb', line 56

Instance Attribute Details

#aggregation_type ⇒ Integer?

Aggregation type: All = 0, By Connections = 1, By Tags = 2, By Billing Group = 3

Returns:

  • (Integer, nil) 


29
 
# File 'lib/telnyx/models/legacy/reporting/usage_reports/voice_create_params.rb', line 29

optional :aggregation_type, Integer

#connections ⇒ Array<Integer>?

List of connections to filter by

Returns:

  • (Array<Integer>, nil) 


35
 
# File 'lib/telnyx/models/legacy/reporting/usage_reports/voice_create_params.rb', line 35

optional :connections, Telnyx::Internal::Type::ArrayOf[Integer]

#end_time ⇒ Time

End time in ISO format

Returns:

  • (Time) 


17
 
# File 'lib/telnyx/models/legacy/reporting/usage_reports/voice_create_params.rb', line 17

required :end_time, Time

#managed_accounts ⇒ Array<String>?

List of managed accounts to include

Returns:

  • (Array<String>, nil) 


41
 
# File 'lib/telnyx/models/legacy/reporting/usage_reports/voice_create_params.rb', line 41

optional :managed_accounts, Telnyx::Internal::Type::ArrayOf[String]

#product_breakdown ⇒ Integer?

Product breakdown type: No breakdown = 0, DID vs Toll-free = 1, Country = 2, DID vs Toll-free per Country = 3

Returns:

  • (Integer, nil) 


48
 
# File 'lib/telnyx/models/legacy/reporting/usage_reports/voice_create_params.rb', line 48

optional :product_breakdown, Integer

#select_all_managed_accounts ⇒ Boolean?

Whether to select all managed accounts

Returns:

  • (Boolean, nil) 


54
 
# File 'lib/telnyx/models/legacy/reporting/usage_reports/voice_create_params.rb', line 54

optional :select_all_managed_accounts, Telnyx::Internal::Type::Boolean

#start_time ⇒ Time

Start time in ISO format

Returns:

  • (Time) 


23
 
# File 'lib/telnyx/models/legacy/reporting/usage_reports/voice_create_params.rb', line 23

required :start_time, Time