Class: Telnyx::Models::Legacy::Reporting::BatchDetailRecords::VoiceCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/legacy/reporting/batch_detail_records/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:, call_types: nil, connections: nil, fields: nil, filters: nil, include_all_metadata: nil, managed_accounts: nil, record_types: nil, report_name: nil, select_all_managed_accounts: nil, source: nil, timezone: nil, request_options: {}) ⇒ Object

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

Parameters:

  • end_time (Time) —

    End time in ISO format

  • start_time (Time) —

    Start time in ISO format

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

    List of call types to filter by (Inbound = 1, Outbound = 2)

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

    List of connections to filter by

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

    Set of fields to include in the report

  • filters (Array<Telnyx::Models::Legacy::Reporting::Filter>) (defaults to: nil) —

    List of filters to apply

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

    Whether to include all metadata

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

    List of managed accounts to include

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

    List of record types to filter by (Complete = 1, Incomplete = 2, Errors = 3)

  • report_name (String) (defaults to: nil) —

    Name of the report

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

    Whether to select all managed accounts

  • source (String) (defaults to: nil) —

    Source of the report. Valid values: calls (default), call-control, fax-api, webr

  • timezone (String) (defaults to: nil) —

    Timezone for the report

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



# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/voice_create_params.rb', line 92

Instance Attribute Details

#call_types ⇒ Array<Integer>?

List of call types to filter by (Inbound = 1, Outbound = 2)

Returns:

  • (Array<Integer>, nil) 


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

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

#connections ⇒ Array<Integer>?

List of connections to filter by

Returns:

  • (Array<Integer>, nil) 


35
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/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/batch_detail_records/voice_create_params.rb', line 17

required :end_time, Time

#fields ⇒ Array<String>?

Set of fields to include in the report

Returns:

  • (Array<String>, nil) 


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

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

#filters ⇒ Array<Telnyx::Models::Legacy::Reporting::Filter>?

List of filters to apply

Returns:



47
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/voice_create_params.rb', line 47

optional :filters, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Legacy::Reporting::Filter] }

#include_all_metadata ⇒ Boolean?

Whether to include all metadata

Returns:

  • (Boolean, nil) 


53
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/voice_create_params.rb', line 53

optional :include_all_metadata, Telnyx::Internal::Type::Boolean

#managed_accounts ⇒ Array<String>?

List of managed accounts to include

Returns:

  • (Array<String>, nil) 


59
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/voice_create_params.rb', line 59

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

#record_types ⇒ Array<Integer>?

List of record types to filter by (Complete = 1, Incomplete = 2, Errors = 3)

Returns:

  • (Array<Integer>, nil) 


65
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/voice_create_params.rb', line 65

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

#report_name ⇒ String?

Name of the report

Returns:

  • (String, nil) 


71
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/voice_create_params.rb', line 71

optional :report_name, String

#select_all_managed_accounts ⇒ Boolean?

Whether to select all managed accounts

Returns:

  • (Boolean, nil) 


77
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/voice_create_params.rb', line 77

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

#source ⇒ String?

Source of the report. Valid values: calls (default), call-control, fax-api, webrtc

Returns:

  • (String, nil) 


84
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/voice_create_params.rb', line 84

optional :source, String

#start_time ⇒ Time

Start time in ISO format

Returns:

  • (Time) 


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

required :start_time, Time

#timezone ⇒ String?

Timezone for the report

Returns:

  • (String, nil) 


90
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/voice_create_params.rb', line 90

optional :timezone, String