Class: UltracartClient::ItemPricing

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/item_pricing.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemPricing

Initializes the object



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 133

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'tiers')
    if (value = attributes[:'tiers']).is_a?(Array)
      self.tiers = value
    end
  end
end

Instance Attribute Details

#allow_arbitrary_cost ⇒ Object

Allow arbitrary cost



19
20
21
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 19

def allow_arbitrary_cost
  @allow_arbitrary_cost
end

#arbitrary_cost_velocity_code ⇒ Object

Arbitrary cost velocity code



22
23
24
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 22

def arbitrary_cost_velocity_code
  @arbitrary_cost_velocity_code
end

#auto_order_cost ⇒ Object

Cost if customer selects to receive item on auto order. Set to zero to delete.



25
26
27
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 25

def auto_order_cost
  @auto_order_cost
end

#automatic_pricing_tier_name ⇒ Object

Automatic pricing tier name



28
29
30
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 28

def automatic_pricing_tier_name
  @automatic_pricing_tier_name
end

#automatic_pricing_tier_oid ⇒ Object

Automatic pricing tier object identifier



31
32
33
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 31

def automatic_pricing_tier_oid
  @automatic_pricing_tier_oid
end

#cogs ⇒ Object

Cost of goods sold



34
35
36
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 34

def cogs
  @cogs
end

#cost ⇒ Object

Cost



37
38
39
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 37

def cost
  @cost
end

#currency_code ⇒ Object

Currency code



40
41
42
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 40

def currency_code
  @currency_code
end

#manufacturer_suggested_retail_price ⇒ Object

Manufacturer suggested retail price



43
44
45
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 43

def manufacturer_suggested_retail_price
  @manufacturer_suggested_retail_price
end

#maximum_arbitrary_cost ⇒ Object

Maximum arbitrary cost



46
47
48
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 46

def maximum_arbitrary_cost
  @maximum_arbitrary_cost
end

#minimum_advertised_price ⇒ Object

Minimum advertised price



49
50
51
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 49

def minimum_advertised_price
  @minimum_advertised_price
end

#minimum_arbitrary_cost ⇒ Object

Minimum arbitrary cost



52
53
54
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 52

def minimum_arbitrary_cost
  @minimum_arbitrary_cost
end

#mix_and_match_group ⇒ Object

Mix and match group



55
56
57
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 55

def mix_and_match_group
  @mix_and_match_group
end

#mix_and_match_group_oid ⇒ Object

Mix and match group object identifier



58
59
60
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 58

def mix_and_match_group_oid
  @mix_and_match_group_oid
end

#sale_cost ⇒ Object

Sale cost



61
62
63
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 61

def sale_cost
  @sale_cost
end

#sale_end ⇒ Object

Sale end



64
65
66
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 64

def sale_end
  @sale_end
end

#sale_start ⇒ Object

Sale start



67
68
69
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 67

def sale_start
  @sale_start
end

#tiers ⇒ Object

Tiers



70
71
72
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 70

def tiers
  @tiers
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 73

def self.attribute_map
  {
    :'allow_arbitrary_cost' => :'allow_arbitrary_cost',
    :'arbitrary_cost_velocity_code' => :'arbitrary_cost_velocity_code',
    :'auto_order_cost' => :'auto_order_cost',
    :'automatic_pricing_tier_name' => :'automatic_pricing_tier_name',
    :'automatic_pricing_tier_oid' => :'automatic_pricing_tier_oid',
    :'cogs' => :'cogs',
    :'cost' => :'cost',
    :'currency_code' => :'currency_code',
    :'manufacturer_suggested_retail_price' => :'manufacturer_suggested_retail_price',
    :'maximum_arbitrary_cost' => :'maximum_arbitrary_cost',
    :'minimum_advertised_price' => :'minimum_advertised_price',
    :'minimum_arbitrary_cost' => :'minimum_arbitrary_cost',
    :'mix_and_match_group' => :'mix_and_match_group',
    :'mix_and_match_group_oid' => :'mix_and_match_group_oid',
    :'sale_cost' => :'sale_cost',
    :'sale_end' => :'sale_end',
    :'sale_start' => :'sale_start',
    :'tiers' => :'tiers'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



304
305
306
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 304

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 102

def self.openapi_types
  {
    :'allow_arbitrary_cost' => :'Boolean',
    :'arbitrary_cost_velocity_code' => :'String',
    :'auto_order_cost' => :'Float',
    :'automatic_pricing_tier_name' => :'String',
    :'automatic_pricing_tier_oid' => :'Integer',
    :'cogs' => :'Float',
    :'cost' => :'Float',
    :'currency_code' => :'String',
    :'manufacturer_suggested_retail_price' => :'Float',
    :'maximum_arbitrary_cost' => :'Float',
    :'minimum_advertised_price' => :'Float',
    :'minimum_arbitrary_cost' => :'Float',
    :'mix_and_match_group' => :'String',
    :'mix_and_match_group_oid' => :'Integer',
    :'sale_cost' => :'Float',
    :'sale_end' => :'String',
    :'sale_start' => :'String',
    :'tiers' => :'Array<ItemPricingTier>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_arbitrary_cost == o.allow_arbitrary_cost &&
      arbitrary_cost_velocity_code == o.arbitrary_cost_velocity_code &&
      auto_order_cost == o.auto_order_cost &&
      automatic_pricing_tier_name == o.automatic_pricing_tier_name &&
      automatic_pricing_tier_oid == o.automatic_pricing_tier_oid &&
      cogs == o.cogs &&
      cost == o.cost &&
      currency_code == o.currency_code &&
      manufacturer_suggested_retail_price == o.manufacturer_suggested_retail_price &&
      maximum_arbitrary_cost == o.maximum_arbitrary_cost &&
      minimum_advertised_price == o.minimum_advertised_price &&
      minimum_arbitrary_cost == o.minimum_arbitrary_cost &&
      mix_and_match_group == o.mix_and_match_group &&
      mix_and_match_group_oid == o.mix_and_match_group_oid &&
      sale_cost == o.sale_cost &&
      sale_end == o.sale_end &&
      sale_start == o.sale_start &&
      tiers == o.tiers
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 335

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 406

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 311

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


291
292
293
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



297
298
299
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 297

def hash
  [allow_arbitrary_cost, arbitrary_cost_velocity_code, auto_order_cost, automatic_pricing_tier_name, automatic_pricing_tier_oid, cogs, cost, currency_code, manufacturer_suggested_retail_price, maximum_arbitrary_cost, minimum_advertised_price, minimum_arbitrary_cost, mix_and_match_group, mix_and_match_group_oid, sale_cost, sale_end, sale_start, tiers].hash
end

#list_invalid_properties ⇒ Object

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



223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 223

def list_invalid_properties
  invalid_properties = Array.new
  if !@arbitrary_cost_velocity_code.nil? && @arbitrary_cost_velocity_code.to_s.length > 10000
    invalid_properties.push('invalid value for "arbitrary_cost_velocity_code", the character length must be smaller than or equal to 10000.')
  end

  if !@currency_code.nil? && @currency_code.to_s.length > 3
    invalid_properties.push('invalid value for "currency_code", the character length must be smaller than or equal to 3.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



382
383
384
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 382

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 388

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

#to_s ⇒ String

Returns the string representation of the object



376
377
378
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 376

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



238
239
240
241
242
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 238

def valid?
  return false if !@arbitrary_cost_velocity_code.nil? && @arbitrary_cost_velocity_code.to_s.length > 10000
  return false if !@currency_code.nil? && @currency_code.to_s.length > 3
  true
end