Class: Telnyx::Models::Reports::MdrUsageReportFetchSyncParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Reports::MdrUsageReportFetchSyncParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/reports/mdr_usage_report_fetch_sync_params.rb

Overview

See Also:

• Resources::Reports::MdrUsageReports#fetch_sync

Defined Under Namespace

Modules: AggregationType

Instance Attribute Summary

• #aggregation_type ⇒ Symbol, Telnyx::Models::Reports::MdrUsageReportFetchSyncParams::AggregationType

  Type of aggregation to apply to the results.

• #end_date ⇒ Time^?

  End of the date range filter (inclusive, ISO 8601).

• #profiles ⇒ Array<String>^?

  Filter results by profile.

• #start_date ⇒ Time^?

  Start of the date range filter (inclusive, ISO 8601).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(aggregation_type:, end_date: nil, profiles: nil, start_date: nil, request_options: {}) ⇒ Object constructor

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_date: nil, profiles: nil, start_date: nil, request_options: {}) ⇒ Object

Parameters:

• aggregation_type (Symbol, Telnyx::Models::Reports::MdrUsageReportFetchSyncParams::AggregationType) —

  Type of aggregation to apply to the results.

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

  End of the date range filter (inclusive, ISO 8601).

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

  Filter results by profile.

• start_date (Time) (defaults to: nil) —

  Start of the date range filter (inclusive, ISO 8601).

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

# File 'lib/telnyx/models/reports/mdr_usage_report_fetch_sync_params.rb', line 35

Instance Attribute Details

#aggregation_type ⇒ Symbol, Telnyx::Models::Reports::MdrUsageReportFetchSyncParams::AggregationType

Type of aggregation to apply to the results.

Returns:

• (Symbol, Telnyx::Models::Reports::MdrUsageReportFetchSyncParams::AggregationType)

# File 'lib/telnyx/models/reports/mdr_usage_report_fetch_sync_params.rb', line 15

required :aggregation_type, enum: -> { Telnyx::Reports::MdrUsageReportFetchSyncParams::AggregationType }

#end_date ⇒ Time^?

End of the date range filter (inclusive, ISO 8601).

Returns:

• (Time, nil)

# File 'lib/telnyx/models/reports/mdr_usage_report_fetch_sync_params.rb', line 21

optional :end_date, Time

#profiles ⇒ Array<String>^?

Filter results by profile.

Returns:

• (Array<String>, nil)

# File 'lib/telnyx/models/reports/mdr_usage_report_fetch_sync_params.rb', line 27

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

#start_date ⇒ Time^?

Start of the date range filter (inclusive, ISO 8601).

Returns:

• (Time, nil)

# File 'lib/telnyx/models/reports/mdr_usage_report_fetch_sync_params.rb', line 33

optional :start_date, Time