Class: Inttegro::Search::Sort

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

Overview

Typed representation of the sort 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

#direction ⇒ Inttegro::Search::SortDirection (readonly)

Relevance supports descending order only.

Required in the API payload. Wire name: direction.

Returns:



31
32
33
34
 
# File 'lib/inttegro/search/sort.rb', line 31

class Sort < T::Struct
  const :field, Inttegro::Search::SortField
  const :direction, Inttegro::Search::SortDirection
end

#field ⇒ Inttegro::Search::SortField (readonly)

published_at is supported only by product search.

Required in the API payload. Wire name: field.

Returns:



31
32
33
34
 
# File 'lib/inttegro/search/sort.rb', line 31

class Sort < T::Struct
  const :field, Inttegro::Search::SortField
  const :direction, Inttegro::Search::SortDirection
end