Class: Telnyx::Models::Legacy::Reporting::Filter

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Legacy::Reporting::Filter

Defined in:

lib/telnyx/models/legacy/reporting/filter.rb,
sig/telnyx/models/legacy/reporting/filter.rbs

Defined Under Namespace

Modules: CldFilter, CliFilter, FilterType

Instance Attribute Summary

• #billing_group ⇒ String^?

  Billing group UUID to filter by.

• #cld ⇒ String^?

  Called line identification (destination number).

• #cld_filter ⇒ Symbol, ...

  Filter type for CLD matching.

• #cli ⇒ String^?

  Calling line identification (caller ID).

• #cli_filter ⇒ Symbol, ...

  Filter type for CLI matching.

• #filter_type ⇒ Symbol, ...

  Logical operator for combining filters.

• #tags_list ⇒ String^?

  Tag name to filter by.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(billing_group: nil, cld: nil, cld_filter: nil, cli: nil, cli_filter: nil, filter_type: nil, tags_list: nil) ⇒ Object constructor

  Query filter criteria.

• #to_hash ⇒ {

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(billing_group: nil, cld: nil, cld_filter: nil, cli: nil, cli_filter: nil, filter_type: nil, tags_list: nil) ⇒ Object

Query filter criteria. Note: The first filter object must specify filter_type as 'and'. You cannot follow an 'or' with another 'and'.

Parameters:

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

  Billing group UUID to filter by

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

  Called line identification (destination number)

• cld_filter (Symbol, Telnyx::Models::Legacy::Reporting::Filter::CldFilter) (defaults to: nil) —

  Filter type for CLD matching

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

  Calling line identification (caller ID)

• cli_filter (Symbol, Telnyx::Models::Legacy::Reporting::Filter::CliFilter) (defaults to: nil) —

  Filter type for CLI matching

• filter_type (Symbol, Telnyx::Models::Legacy::Reporting::Filter::FilterType) (defaults to: nil) —

  Logical operator for combining filters

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

  Tag name to filter by

# File 'lib/telnyx/models/legacy/reporting/filter.rb', line 50

Instance Attribute Details

#billing_group ⇒ String^?

Billing group UUID to filter by

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/legacy/reporting/filter.rb', line 12

optional :billing_group, String

#cld ⇒ String^?

Called line identification (destination number)

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/legacy/reporting/filter.rb', line 18

optional :cld, String

#cld_filter ⇒ Symbol, ...

Filter type for CLD matching

Returns:

• (Symbol, Telnyx::Models::Legacy::Reporting::Filter::CldFilter, nil)

# File 'lib/telnyx/models/legacy/reporting/filter.rb', line 24

optional :cld_filter, enum: -> { Telnyx::Legacy::Reporting::Filter::CldFilter }

#cli ⇒ String^?

Calling line identification (caller ID)

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/legacy/reporting/filter.rb', line 30

optional :cli, String

#cli_filter ⇒ Symbol, ...

Filter type for CLI matching

Returns:

• (Symbol, Telnyx::Models::Legacy::Reporting::Filter::CliFilter, nil)

# File 'lib/telnyx/models/legacy/reporting/filter.rb', line 36

optional :cli_filter, enum: -> { Telnyx::Legacy::Reporting::Filter::CliFilter }

#filter_type ⇒ Symbol, ...

Logical operator for combining filters

Returns:

• (Symbol, Telnyx::Models::Legacy::Reporting::Filter::FilterType, nil)

# File 'lib/telnyx/models/legacy/reporting/filter.rb', line 42

optional :filter_type, enum: -> { Telnyx::Legacy::Reporting::Filter::FilterType }

#tags_list ⇒ String^?

Tag name to filter by

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :tags_list, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/legacy/reporting/filter.rb', line 78

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/legacy/reporting/filter.rbs', line 61

def to_hash: -> {