Class: Weft::SearchPriceUsdFilter

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

Overview

Price constraint in USD, as decimal STRINGS (the reasoning form). Set exactly one operator: a scalar (lte / gte / eq) OR a range (range_gte + range_lte together, lower ≤ upper). Each value is a string matching ^\\d+(\\.\\d{1,6})?$ (≤ 6 decimals, ≥ 0); a JSON number is rejected. Mutually exclusive with price_atomic. An unpriced resource is excluded from any price-filtered query.

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 = {}) ⇒ SearchPriceUsdFilter

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 74

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Weft::SearchPriceUsdFilter` 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::SearchPriceUsdFilter`. 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?(:'lte')
    self.lte = attributes[:'lte']
  end

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

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

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

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

Instance Attribute Details

#eq ⇒ Object

Price exactly this many USD, e.g. "1.5".



26
27
28
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 26

def eq
  @eq
end

#gte ⇒ Object

Price ≥ this many USD (inclusive floor), e.g. "0.001".



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

def gte
  @gte
end

#lte ⇒ Object

Price ≤ this many USD (inclusive ceiling), e.g. "0.009".



20
21
22
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 20

def lte
  @lte
end

#range_gte ⇒ Object

Range lower bound (inclusive), USD. Set with range_lte.



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

def range_gte
  @range_gte
end

#range_lte ⇒ Object

Range upper bound (inclusive), USD. Set with range_gte.



32
33
34
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 32

def range_lte
  @range_lte
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



46
47
48
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 46

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 51

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 35

def self.attribute_map
  {
    :'lte' => :'lte',
    :'gte' => :'gte',
    :'eq' => :'eq',
    :'range_gte' => :'range_gte',
    :'range_lte' => :'range_lte'
  }
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 256

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



67
68
69
70
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 56

def self.openapi_types
  {
    :'lte' => :'String',
    :'gte' => :'String',
    :'eq' => :'String',
    :'range_gte' => :'String',
    :'range_lte' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      lte == o.lte &&
      gte == o.gte &&
      eq == o.eq &&
      range_gte == o.range_gte &&
      range_lte == o.range_lte
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


243
244
245
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 249

def hash
  [lte, gte, eq, range_gte, range_lte].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



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
139
140
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 111

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^\d+(\.\d{1,6})?$/)
  if !@lte.nil? && @lte !~ pattern
    invalid_properties.push("invalid value for \"lte\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d+(\.\d{1,6})?$/)
  if !@gte.nil? && @gte !~ pattern
    invalid_properties.push("invalid value for \"gte\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d+(\.\d{1,6})?$/)
  if !@eq.nil? && @eq !~ pattern
    invalid_properties.push("invalid value for \"eq\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d+(\.\d{1,6})?$/)
  if !@range_gte.nil? && @range_gte !~ pattern
    invalid_properties.push("invalid value for \"range_gte\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d+(\.\d{1,6})?$/)
  if !@range_lte.nil? && @range_lte !~ pattern
    invalid_properties.push("invalid value for \"range_lte\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 278

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



144
145
146
147
148
149
150
151
152
 
# File 'lib/weft/generated/models/search_price_usd_filter.rb', line 144

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@lte.nil? && @lte !~ Regexp.new(/^\d+(\.\d{1,6})?$/)
  return false if !@gte.nil? && @gte !~ Regexp.new(/^\d+(\.\d{1,6})?$/)
  return false if !@eq.nil? && @eq !~ Regexp.new(/^\d+(\.\d{1,6})?$/)
  return false if !@range_gte.nil? && @range_gte !~ Regexp.new(/^\d+(\.\d{1,6})?$/)
  return false if !@range_lte.nil? && @range_lte !~ Regexp.new(/^\d+(\.\d{1,6})?$/)
  true
end