Class: Weft::SearchFilterSpec

Inherits:
ApiModelBase show all
Defined in:
lib/weft/generated/models/search_filter_spec.rb

Overview

Structured hard constraints on the query — the weft-search-platform FilterSpec v1 typed subset, vendored verbatim (D1 contract). Every field is optional; an empty object is the no-filter query. Set fields are ANDed. Each sub-filter takes exactly one operator; unknown filter keys and unknown operators are rejected (422 INVALID_FILTERS). price (USD decimal strings) and price_atomic (integer micro-USD) are two representations of ONE price constraint — the reasoning form and the settlement form. They are MUTUALLY EXCLUSIVE: setting both is 422 INVALID_FILTERS. A JSON number in price is rejected (only decimal strings), so {lte: 5} can never be mis-read as 5 micro-dollars. The canonical enum value sets are pinned to the platform spec by the CI drift gate (docs/contracts/search-platform.openapi.yaml).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SearchFilterSpec

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 87

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Weft::SearchFilterSpec` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Weft::SearchFilterSpec`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'price')
    self.price = attributes[:'price']
  end

  if attributes.key?(:'price_atomic')
    self.price_atomic = attributes[:'price_atomic']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'protocol')
    self.protocol = attributes[:'protocol']
  end

  if attributes.key?(:'category')
    self.category = attributes[:'category']
  end

  if attributes.key?(:'method')
    self.method = attributes[:'method']
  end

  if attributes.key?(:'execution_mode')
    self.execution_mode = attributes[:'execution_mode']
  end

  if attributes.key?(:'weft_fetch_compatible')
    self.weft_fetch_compatible = attributes[:'weft_fetch_compatible']
  end

  if attributes.key?(:'include_unknown_prices')
    self.include_unknown_prices = attributes[:'include_unknown_prices']
  else
    self.include_unknown_prices = false
  end
end

Instance Attribute Details

#category ⇒ Object

Returns the value of attribute category.



27
28
29
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 27

def category
  @category
end

#execution_mode ⇒ Object

Returns the value of attribute execution_mode.



31
32
33
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 31

def execution_mode
  @execution_mode
end

#include_unknown_prices ⇒ Object

With a price constraint, also retain dynamic and unknown prices.



37
38
39
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 37

def include_unknown_prices
  @include_unknown_prices
end

#method ⇒ Object

Returns the value of attribute method.



29
30
31
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 29

def method
  @method
end

#price ⇒ Object

Returns the value of attribute price.



19
20
21
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 19

def price
  @price
end

#price_atomic ⇒ Object

Returns the value of attribute price_atomic.



21
22
23
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 21

def price_atomic
  @price_atomic
end

#protocol ⇒ Object

Returns the value of attribute protocol.



25
26
27
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 25

def protocol
  @protocol
end

#type ⇒ Object

Returns the value of attribute type.



23
24
25
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 23

def type
  @type
end

#weft_fetch_compatible ⇒ Object

True requires at least one access method whose paid request is supported by the current Weft fetch runtime. For async operations this can mean submission-only coverage followed by the provider workflow.



34
35
36
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 34

def weft_fetch_compatible
  @weft_fetch_compatible
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



55
56
57
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 55

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



60
61
62
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 60

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 40

def self.attribute_map
  {
    :'price' => :'price',
    :'price_atomic' => :'price_atomic',
    :'type' => :'type',
    :'protocol' => :'protocol',
    :'category' => :'category',
    :'method' => :'method',
    :'execution_mode' => :'execution_mode',
    :'weft_fetch_compatible' => :'weft_fetch_compatible',
    :'include_unknown_prices' => :'include_unknown_prices'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 186

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 80

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 65

def self.openapi_types
  {
    :'price' => :'SearchPriceUsdFilter',
    :'price_atomic' => :'SearchPriceAtomicFilter',
    :'type' => :'SearchResourceTypeFilter',
    :'protocol' => :'SearchProtocolFilter',
    :'category' => :'SearchStringSetFilter',
    :'method' => :'SearchMethodFilter',
    :'execution_mode' => :'SearchExecutionModeFilter',
    :'weft_fetch_compatible' => :'Boolean',
    :'include_unknown_prices' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 157

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      price == o.price &&
      price_atomic == o.price_atomic &&
      type == o.type &&
      protocol == o.protocol &&
      category == o.category &&
      method == o.method &&
      execution_mode == o.execution_mode &&
      weft_fetch_compatible == o.weft_fetch_compatible &&
      include_unknown_prices == o.include_unknown_prices
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


173
174
175
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



179
180
181
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 179

def hash
  [price, price_atomic, type, protocol, category, method, execution_mode, weft_fetch_compatible, include_unknown_prices].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



142
143
144
145
146
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 142

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 208

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



150
151
152
153
 
# File 'lib/weft/generated/models/search_filter_spec.rb', line 150

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end