Class: Inttegro::Search::Filter

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/search/filter.rb

Overview

Typed representation of the filter object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#field ⇒ String (readonly)

Unqualified route-local field name documented by the selected endpoint.

Required in the API payload. Wire name: field.

Returns:

  • (String) 


36
37
38
39
40
 
# File 'lib/inttegro/search/filter.rb', line 36

class Filter < T::Struct
  const :field, String
  const :operator, Inttegro::Search::FilterOperator
  const :values, T::Array[String]
end

#operator ⇒ Inttegro::Search::FilterOperator (readonly)

eq requires exactly one value; in matches any supplied value.

Required in the API payload. Wire name: operator.

Returns:



36
37
38
39
40
 
# File 'lib/inttegro/search/filter.rb', line 36

class Filter < T::Struct
  const :field, String
  const :operator, Inttegro::Search::FilterOperator
  const :values, T::Array[String]
end

#values ⇒ Array<String> (readonly)

Value of the values field in the Inttegro API payload.

Required in the API payload. Wire name: values.

Returns:

  • (Array<String>) 


36
37
38
39
40
 
# File 'lib/inttegro/search/filter.rb', line 36

class Filter < T::Struct
  const :field, String
  const :operator, Inttegro::Search::FilterOperator
  const :values, T::Array[String]
end