Class: Telnyx::Models::Legacy::Reporting::UsageReports::MessagingCreateParams

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/messaging_create_params.rb

Overview

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

Parameters:

  • aggregation_type (Integer)

    Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2

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

    List of managed accounts to include

  • profiles (Array<String>) (defaults to: nil)

    List of messaging profile IDs to filter by

  • select_all_managed_accounts (Boolean) (defaults to: nil)
  • start_time (Time) (defaults to: nil)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})


# File 'lib/telnyx/models/legacy/reporting/usage_reports/messaging_create_params.rb', line 46

Instance Attribute Details

#aggregation_typeInteger

Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2

Returns:

  • (Integer)


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

required :aggregation_type, Integer

#end_timeTime?

Returns:

  • (Time, nil)


22
# File 'lib/telnyx/models/legacy/reporting/usage_reports/messaging_create_params.rb', line 22

optional :end_time, Time

#managed_accountsArray<String>?

List of managed accounts to include

Returns:

  • (Array<String>, nil)


28
# File 'lib/telnyx/models/legacy/reporting/usage_reports/messaging_create_params.rb', line 28

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

#profilesArray<String>?

List of messaging profile IDs to filter by

Returns:

  • (Array<String>, nil)


34
# File 'lib/telnyx/models/legacy/reporting/usage_reports/messaging_create_params.rb', line 34

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

#select_all_managed_accountsBoolean?

Returns:

  • (Boolean, nil)


39
# File 'lib/telnyx/models/legacy/reporting/usage_reports/messaging_create_params.rb', line 39

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

#start_timeTime?

Returns:

  • (Time, nil)


44
# File 'lib/telnyx/models/legacy/reporting/usage_reports/messaging_create_params.rb', line 44

optional :start_time, Time