Class: Telnyx::Models::Legacy::Reporting::BatchDetailRecords::MessagingCreateParams

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/messaging_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:, connections: nil, directions: nil, filters: nil, include_message_body: nil, managed_accounts: nil, profiles: nil, record_types: nil, report_name: nil, select_all_managed_accounts: nil, timezone: nil, request_options: {}) ⇒ Object

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

Parameters:

  • end_time (Time) —

    End time in ISO format. Note: If end time includes the last 4 hours, some MDRs m

  • start_time (Time) —

    Start time in ISO format

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

    List of connections to filter by

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

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

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

    List of filters to apply

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

    Whether to include message body in the report

  • 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

  • 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

  • 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/messaging_create_params.rb', line 87

Instance Attribute Details

#connections ⇒ Array<Integer>?

List of connections to filter by

Returns:

  • (Array<Integer>, nil) 


31
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 31

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

#directions ⇒ Array<Integer>?

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

Returns:

  • (Array<Integer>, nil) 


37
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 37

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

#end_time ⇒ Time

End time in ISO format. Note: If end time includes the last 4 hours, some MDRs might not appear in this report, due to wait time for downstream message delivery confirmation

Returns:

  • (Time) 


19
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 19

required :end_time, Time

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

List of filters to apply

Returns:



43
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 43

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

#include_message_body ⇒ Boolean?

Whether to include message body in the report

Returns:

  • (Boolean, nil) 


49
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 49

optional :include_message_body, Telnyx::Internal::Type::Boolean

#managed_accounts ⇒ Array<String>?

List of managed accounts to include

Returns:

  • (Array<String>, nil) 


55
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 55

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

#profiles ⇒ Array<String>?

List of messaging profile IDs to filter by

Returns:

  • (Array<String>, nil) 


61
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 61

optional :profiles, 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) 


67
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 67

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

#report_name ⇒ String?

Name of the report

Returns:

  • (String, nil) 


73
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 73

optional :report_name, String

#select_all_managed_accounts ⇒ Boolean?

Whether to select all managed accounts

Returns:

  • (Boolean, nil) 


79
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 79

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

#start_time ⇒ Time

Start time in ISO format

Returns:

  • (Time) 


25
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 25

required :start_time, Time

#timezone ⇒ String?

Timezone for the report

Returns:

  • (String, nil) 


85
 
# File 'lib/telnyx/models/legacy/reporting/batch_detail_records/messaging_create_params.rb', line 85

optional :timezone, String