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

Parameters:

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

    Model attributes in the form of hash



121
122
123
124
125
126
127
128
129
130
131
132
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
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 121

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_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



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

def allow_arbitrary_cost
  @allow_arbitrary_cost
end

#arbitrary_cost_velocity_code ⇒ Object

Arbitrary cost velocity code



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

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.



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

def auto_order_cost
  @auto_order_cost
end

#automatic_pricing_tier_name ⇒ Object

Automatic pricing tier name



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

def automatic_pricing_tier_name
  @automatic_pricing_tier_name
end

#automatic_pricing_tier_oid ⇒ Object

Automatic pricing tier object identifier



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

def automatic_pricing_tier_oid
  @automatic_pricing_tier_oid
end

#cogs ⇒ Object

Cost of goods sold



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

def cogs
  @cogs
end

#cost ⇒ Object

Cost



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

def cost
  @cost
end

#currency_code ⇒ Object

Currency code



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

def currency_code
  @currency_code
end

#manufacturer_suggested_retail_price ⇒ Object

Manufacturer suggested retail price



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

def manufacturer_suggested_retail_price
  @manufacturer_suggested_retail_price
end

#maximum_arbitrary_cost ⇒ Object

Maximum arbitrary cost



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

def maximum_arbitrary_cost
  @maximum_arbitrary_cost
end

#minimum_advertised_price ⇒ Object

Minimum advertised price



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

def minimum_advertised_price
  @minimum_advertised_price
end

#minimum_arbitrary_cost ⇒ Object

Minimum arbitrary cost



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

def minimum_arbitrary_cost
  @minimum_arbitrary_cost
end

#mix_and_match_group ⇒ Object

Mix and match group



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

def mix_and_match_group
  @mix_and_match_group
end

#mix_and_match_group_oid ⇒ Object

Mix and match group object identifier



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

def mix_and_match_group_oid
  @mix_and_match_group_oid
end

#sale_cost ⇒ Object

Sale cost



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

def sale_cost
  @sale_cost
end

#sale_end ⇒ Object

Sale end



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

def sale_end
  @sale_end
end

#sale_start ⇒ Object

Sale start



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

def sale_start
  @sale_start
end

#tiers ⇒ Object

Tiers



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

def tiers
  @tiers
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 96

def self.swagger_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.

Parameters:

  • Object (Object) —

    to be compared



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 247

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

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 306

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = UltracartClient.const_get(type).new
    temp_model.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 372

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 285

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



278
279
280
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 278

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?

Returns:

  • Array for valid properties with the reasons



204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 204

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



352
353
354
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 352

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



358
359
360
361
362
363
364
365
366
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 358

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



346
347
348
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 346

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



219
220
221
222
223
 
# File 'lib/ultracart_api/models/item_pricing.rb', line 219

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