Class: UltracartClient::ItemAutoOrder

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemAutoOrder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 153

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auth_future_amount ⇒ Object

Amount to try and authorize for the future rebill



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

def auth_future_amount
  @auth_future_amount
end

#auth_test_amount ⇒ Object

Amount to try and test authorize



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

def auth_test_amount
  @auth_test_amount
end

#auto_order_cancel_charge_minimum_balance ⇒ Object

If true, the cost of the cancel item will be the remaining balance of the minimum rebill or lifetime value



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

def auto_order_cancel_charge_minimum_balance
  @auto_order_cancel_charge_minimum_balance
end

#auto_order_cancel_item_id ⇒ Object

Item id to attempt charging the customer for if they cancel



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

def auto_order_cancel_item_id
  @auto_order_cancel_item_id
end

#auto_order_cancel_item_oid ⇒ Object

Item object identifier to attempt charging the customer for if they cancel



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

def auto_order_cancel_item_oid
  @auto_order_cancel_item_oid
end

#auto_order_cancel_minimum_life_time_count ⇒ Object

The minimum life time count that must be billed in order to not be charged the cancellation item.



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

def auto_order_cancel_minimum_life_time_count
  @auto_order_cancel_minimum_life_time_count
end

#auto_order_cancel_minimum_life_time_value ⇒ Object

The minimum life time value that must be paid in order to not be charged the cancellation item.



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

def auto_order_cancel_minimum_life_time_value
  @auto_order_cancel_minimum_life_time_value
end

#auto_order_cancel_minimum_rebill_count ⇒ Object

The minimum rebill count that must be billed in order to not be charged the cancellation item.



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

def auto_order_cancel_minimum_rebill_count
  @auto_order_cancel_minimum_rebill_count
end

#auto_order_cancel_minimum_rebill_value ⇒ Object

The minimum rebill value that must be paid in order to not be charged the cancellation item.



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

def auto_order_cancel_minimum_rebill_value
  @auto_order_cancel_minimum_rebill_value
end

#auto_order_downgrade_items ⇒ Object

List of downgrade items presented to customer service representatives



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

def auto_order_downgrade_items
  @auto_order_downgrade_items
end

#auto_order_paused ⇒ Object

True if the rebill processing of this item is paused



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

def auto_order_paused
  @auto_order_paused
end

#auto_order_prohibit_expiring_cards ⇒ Object

Minimum number of months before expiration for the card. Overrides the account level setting if higher. Set to zero to disable.



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

def auto_order_prohibit_expiring_cards
  @auto_order_prohibit_expiring_cards
end

#auto_order_schedules ⇒ Object

The user selectable schedules that are available



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

def auto_order_schedules
  @auto_order_schedules
end

#auto_order_upgrade_items ⇒ Object

List of upgrade items presented to customer service representatives



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

def auto_order_upgrade_items
  @auto_order_upgrade_items
end

#auto_order_upsell ⇒ Object

True if this item uses a fixed upsell step schedule



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

def auto_order_upsell
  @auto_order_upsell
end

#auto_order_upsell_no_easy_cancel ⇒ Object

Do not send the easy cancel email to the customer



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

def auto_order_upsell_no_easy_cancel
  @auto_order_upsell_no_easy_cancel
end

#auto_order_upsell_one_per_customer ⇒ Object

Limit the purchase of this item to one per customer



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

def auto_order_upsell_one_per_customer
  @auto_order_upsell_one_per_customer
end

#auto_orderable ⇒ Object

True if this item can be automatically ordered by the customer



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

def auto_orderable
  @auto_orderable
end

#cancel_other_auto_orders ⇒ Object

True if other auto orders for this customer should be canceled when this item is ordered



73
74
75
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 73

def cancel_other_auto_orders
  @cancel_other_auto_orders
end

#free_shipping_auto_order ⇒ Object

True if the customer should be given free shipping



76
77
78
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 76

def free_shipping_auto_order
  @free_shipping_auto_order
end

#refund_other_auto_orders ⇒ Object

True if other auto orders for this customer should refunded if this item is refunded.



79
80
81
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 79

def refund_other_auto_orders
  @refund_other_auto_orders
end

#steps ⇒ Object

The rebill steps if this auto order is an upsell



82
83
84
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 82

def steps
  @steps
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



113
114
115
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 113

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 85

def self.attribute_map
  {
    :'auth_future_amount' => :'auth_future_amount',
    :'auth_test_amount' => :'auth_test_amount',
    :'auto_order_cancel_charge_minimum_balance' => :'auto_order_cancel_charge_minimum_balance',
    :'auto_order_cancel_item_id' => :'auto_order_cancel_item_id',
    :'auto_order_cancel_item_oid' => :'auto_order_cancel_item_oid',
    :'auto_order_cancel_minimum_life_time_count' => :'auto_order_cancel_minimum_life_time_count',
    :'auto_order_cancel_minimum_life_time_value' => :'auto_order_cancel_minimum_life_time_value',
    :'auto_order_cancel_minimum_rebill_count' => :'auto_order_cancel_minimum_rebill_count',
    :'auto_order_cancel_minimum_rebill_value' => :'auto_order_cancel_minimum_rebill_value',
    :'auto_order_downgrade_items' => :'auto_order_downgrade_items',
    :'auto_order_paused' => :'auto_order_paused',
    :'auto_order_prohibit_expiring_cards' => :'auto_order_prohibit_expiring_cards',
    :'auto_order_schedules' => :'auto_order_schedules',
    :'auto_order_upgrade_items' => :'auto_order_upgrade_items',
    :'auto_order_upsell' => :'auto_order_upsell',
    :'auto_order_upsell_no_easy_cancel' => :'auto_order_upsell_no_easy_cancel',
    :'auto_order_upsell_one_per_customer' => :'auto_order_upsell_one_per_customer',
    :'auto_orderable' => :'auto_orderable',
    :'cancel_other_auto_orders' => :'cancel_other_auto_orders',
    :'free_shipping_auto_order' => :'free_shipping_auto_order',
    :'refund_other_auto_orders' => :'refund_other_auto_orders',
    :'steps' => :'steps'
  }
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



335
336
337
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 335

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



146
147
148
149
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 146

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

.openapi_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 118

def self.openapi_types
  {
    :'auth_future_amount' => :'Float',
    :'auth_test_amount' => :'Float',
    :'auto_order_cancel_charge_minimum_balance' => :'Boolean',
    :'auto_order_cancel_item_id' => :'String',
    :'auto_order_cancel_item_oid' => :'Integer',
    :'auto_order_cancel_minimum_life_time_count' => :'Integer',
    :'auto_order_cancel_minimum_life_time_value' => :'Float',
    :'auto_order_cancel_minimum_rebill_count' => :'Integer',
    :'auto_order_cancel_minimum_rebill_value' => :'Float',
    :'auto_order_downgrade_items' => :'Array<String>',
    :'auto_order_paused' => :'Boolean',
    :'auto_order_prohibit_expiring_cards' => :'Integer',
    :'auto_order_schedules' => :'Array<String>',
    :'auto_order_upgrade_items' => :'Array<String>',
    :'auto_order_upsell' => :'Boolean',
    :'auto_order_upsell_no_easy_cancel' => :'Boolean',
    :'auto_order_upsell_one_per_customer' => :'Boolean',
    :'auto_orderable' => :'Boolean',
    :'cancel_other_auto_orders' => :'Boolean',
    :'free_shipping_auto_order' => :'Boolean',
    :'refund_other_auto_orders' => :'Boolean',
    :'steps' => :'Array<ItemAutoOrderStep>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 293

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auth_future_amount == o.auth_future_amount &&
      auth_test_amount == o.auth_test_amount &&
      auto_order_cancel_charge_minimum_balance == o.auto_order_cancel_charge_minimum_balance &&
      auto_order_cancel_item_id == o.auto_order_cancel_item_id &&
      auto_order_cancel_item_oid == o.auto_order_cancel_item_oid &&
      auto_order_cancel_minimum_life_time_count == o.auto_order_cancel_minimum_life_time_count &&
      auto_order_cancel_minimum_life_time_value == o.auto_order_cancel_minimum_life_time_value &&
      auto_order_cancel_minimum_rebill_count == o.auto_order_cancel_minimum_rebill_count &&
      auto_order_cancel_minimum_rebill_value == o.auto_order_cancel_minimum_rebill_value &&
      auto_order_downgrade_items == o.auto_order_downgrade_items &&
      auto_order_paused == o.auto_order_paused &&
      auto_order_prohibit_expiring_cards == o.auto_order_prohibit_expiring_cards &&
      auto_order_schedules == o.auto_order_schedules &&
      auto_order_upgrade_items == o.auto_order_upgrade_items &&
      auto_order_upsell == o.auto_order_upsell &&
      auto_order_upsell_no_easy_cancel == o.auto_order_upsell_no_easy_cancel &&
      auto_order_upsell_one_per_customer == o.auto_order_upsell_one_per_customer &&
      auto_orderable == o.auto_orderable &&
      cancel_other_auto_orders == o.cancel_other_auto_orders &&
      free_shipping_auto_order == o.free_shipping_auto_order &&
      refund_other_auto_orders == o.refund_other_auto_orders &&
      steps == o.steps
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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 366

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 437

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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 342

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


322
323
324
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 322

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



328
329
330
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 328

def hash
  [auth_future_amount, auth_test_amount, auto_order_cancel_charge_minimum_balance, auto_order_cancel_item_id, auto_order_cancel_item_oid, auto_order_cancel_minimum_life_time_count, auto_order_cancel_minimum_life_time_value, auto_order_cancel_minimum_rebill_count, auto_order_cancel_minimum_rebill_value, auto_order_downgrade_items, auto_order_paused, auto_order_prohibit_expiring_cards, auto_order_schedules, auto_order_upgrade_items, auto_order_upsell, auto_order_upsell_no_easy_cancel, auto_order_upsell_one_per_customer, auto_orderable, cancel_other_auto_orders, free_shipping_auto_order, refund_other_auto_orders, steps].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



265
266
267
268
269
270
271
272
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 265

def list_invalid_properties
  invalid_properties = Array.new
  if !@auto_order_cancel_item_id.nil? && @auto_order_cancel_item_id.to_s.length > 20
    invalid_properties.push('invalid value for "auto_order_cancel_item_id", the character length must be smaller than or equal to 20.')
  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



413
414
415
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 413

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 419

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

Returns:

  • (String) —

    String presentation of the object



407
408
409
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 407

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



276
277
278
279
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 276

def valid?
  return false if !@auto_order_cancel_item_id.nil? && @auto_order_cancel_item_id.to_s.length > 20
  true
end