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



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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 141

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?(:'auth_future_amount')
    self.auth_future_amount = attributes[:'auth_future_amount']
  end

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

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

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

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

  if attributes.has_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.has_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.has_key?(:'auto_order_cancel_minimum_rebill_count')
    self.auto_order_cancel_minimum_rebill_count = attributes[:'auto_order_cancel_minimum_rebill_count']
  end

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

  if attributes.has_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.has_key?(:'auto_order_paused')
    self.auto_order_paused = attributes[:'auto_order_paused']
  end

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

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

  if attributes.has_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.has_key?(:'auto_order_upsell')
    self.auto_order_upsell = attributes[:'auto_order_upsell']
  end

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

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

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

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

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

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

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



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

def auth_future_amount
  @auth_future_amount
end

#auth_test_amount ⇒ Object

Amount to try and test authorize



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

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



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

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



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

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



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

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.



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

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.



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

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.



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

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.



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

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



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

def auto_order_downgrade_items
  @auto_order_downgrade_items
end

#auto_order_paused ⇒ Object

True if the rebill processing of this item is paused



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

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.



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

def auto_order_prohibit_expiring_cards
  @auto_order_prohibit_expiring_cards
end

#auto_order_schedules ⇒ Object

The user selectable schedules that are available



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

def auto_order_schedules
  @auto_order_schedules
end

#auto_order_upgrade_items ⇒ Object

List of upgrade items presented to customer service representatives



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

def auto_order_upgrade_items
  @auto_order_upgrade_items
end

#auto_order_upsell ⇒ Object

True if this item uses a fixed upsell step schedule



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

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



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

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



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

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



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

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



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

def cancel_other_auto_orders
  @cancel_other_auto_orders
end

#free_shipping_auto_order ⇒ Object

True if the customer should be given free shipping



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

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.



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

def refund_other_auto_orders
  @refund_other_auto_orders
end

#steps ⇒ Object

The rebill steps if this auto order is an upsell



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

def steps
  @steps
end

Class Method Details

.attribute_map ⇒ Object

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



84
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
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 84

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

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 112

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 274

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



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
373
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 337

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



403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 403

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 316

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


303
304
305
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



309
310
311
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 309

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



246
247
248
249
250
251
252
253
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 246

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



383
384
385
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 383

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



389
390
391
392
393
394
395
396
397
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 389

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



377
378
379
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 377

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



257
258
259
260
 
# File 'lib/ultracart_api/models/item_auto_order.rb', line 257

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