Class: Trycourier::Models::FilterConfig

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/trycourier/models/filter_config.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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(operator:, filters: nil, path: nil, value: nil) ⇒ Object

Some parameter documentations has been truncated, see Trycourier::Models::FilterConfig for more details.

A filter rule that can be either a single condition (with path/value) or a nested group (with filters array). Use comparison operators (EQ, GT, etc.) for single conditions, and logical operators (AND, OR) for nested groups.

Parameters:

  • operator (String)

    The operator for this filter. Use comparison operators (EQ, GT, LT, GTE, LTE, N

  • filters (Array<Trycourier::Models::FilterConfig>) (defaults to: nil)

    Nested filter rules to combine with AND/OR. Required for nested filter groups, n

  • path (String) (defaults to: nil)

    The attribute path from the user profile to filter on. Required for single filt

  • value (String) (defaults to: nil)

    The value to compare against. Required for single filter conditions, not used f



# File 'lib/trycourier/models/filter_config.rb', line 35


Instance Attribute Details

#filtersArray<Trycourier::Models::FilterConfig>?

Nested filter rules to combine with AND/OR. Required for nested filter groups, not used for single filter conditions.

Returns:



19
# File 'lib/trycourier/models/filter_config.rb', line 19

optional :filters, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::FilterConfig] }

#operatorString

The operator for this filter. Use comparison operators (EQ, GT, LT, GTE, LTE, NEQ, EXISTS, INCLUDES, STARTS_WITH, ENDS_WITH, IS_BEFORE, IS_AFTER, OMIT) for single conditions, or logical operators (AND, OR) for nested filter groups.

Returns:

  • (String)


12
# File 'lib/trycourier/models/filter_config.rb', line 12

required :operator, String

#pathString?

The attribute path from the user profile to filter on. Required for single filter conditions, not used for nested filter groups.

Returns:

  • (String, nil)


26
# File 'lib/trycourier/models/filter_config.rb', line 26

optional :path, String

#valueString?

The value to compare against. Required for single filter conditions, not used for nested filter groups.

Returns:

  • (String, nil)


33
# File 'lib/trycourier/models/filter_config.rb', line 33

optional :value, String