Class: UltracartClient::AutoOrder

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutoOrder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
262
263
264
265
266
267
268
269
270
271
272
273
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
300
301
302
303
304
305
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
343
344
345
346
347
348
 
# File 'lib/ultracart_api/models/auto_order.rb', line 208

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#add_ons ⇒ Object

Array of addon objects instructing which items to add to auto order and how many times they should be added.



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

def add_ons
  @add_ons
end

#auto_order_code ⇒ Object

Unique code assigned to this auto order



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

def auto_order_code
  @auto_order_code
end

#auto_order_oid ⇒ Object

Auto order object identifier



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

def auto_order_oid
  @auto_order_oid
end

#cancel_after_next_x_orders ⇒ Object

Cancel this auto order after X additional rebills



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

def cancel_after_next_x_orders
  @cancel_after_next_x_orders
end

#cancel_downgrade ⇒ Object

True if the auto order was canceled because the customer purchased a downgrade item



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

def cancel_downgrade
  @cancel_downgrade
end

#cancel_reason ⇒ Object

The reason this auto order was canceled by either merchant or customer. Supplying this when setting enabled to false records the change as a cancellation rather than a disable.



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

def cancel_reason
  @cancel_reason
end

#cancel_upgrade ⇒ Object

True if the auto order was canceled because the customer purchased an upgrade item



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

def cancel_upgrade
  @cancel_upgrade
end

#canceled_by_user ⇒ Object

The user that canceled the auto order. Supplying this when setting enabled to false records the change as a cancellation rather than a disable.



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

def canceled_by_user
  @canceled_by_user
end

#canceled_dts ⇒ Object

The date/time that the auto order was canceled. Supply this to record an explicit cancellation time, otherwise it is stamped automatically when enabled is set to false along with cancel_reason or canceled_by_user.



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

def canceled_dts
  @canceled_dts
end

#completed ⇒ Object

True if the auto order ran successfully to completion



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

def completed
  @completed
end

#credit_card_attempt ⇒ Object

The number of credit card attempts that have taken place



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

def credit_card_attempt
  @credit_card_attempt
end

#disabled_dts ⇒ Object

The date/time the auto order was disabled, either by a failed rebill or by setting enabled to false without a cancellation



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

def disabled_dts
  @disabled_dts
end

#emails ⇒ Object

Email delivery records associated with this auto order.



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

def emails
  @emails
end

#enabled ⇒ Object

True if this auto order is enabled. Setting this to false along with cancel_reason or canceled_by_user records the change as a cancellation and fires the auto order cancel notifications. Setting it to false without either field records a disable instead.



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

def enabled
  @enabled
end

#failure_reason ⇒ Object

The reason this auto order failed during the last rebill attempt



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

def failure_reason
  @failure_reason
end

#items ⇒ Object

The items that are setup to rebill



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

def items
  @items
end

#logs ⇒ Object

Logs associated with this auto order



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

def logs
  @logs
end

#management ⇒ Object

Returns the value of attribute management.



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

def management
  @management
end

#merchant_id ⇒ Object

UltraCart merchant ID owning this order



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

def merchant_id
  @merchant_id
end

#merged_dts ⇒ Object

The date/time the auto order was merged into another auto order



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

def merged_dts
  @merged_dts
end

#merged_into_auto_order_oid ⇒ Object

The auto order that this auto order was merged into



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

def merged_into_auto_order_oid
  @merged_into_auto_order_oid
end

#next_attempt ⇒ Object

The next time that the auto order will be attempted for processing



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

def next_attempt
  @next_attempt
end

#original_order ⇒ Object

Returns the value of attribute original_order.



83
84
85
 
# File 'lib/ultracart_api/models/auto_order.rb', line 83

def original_order
  @original_order
end

#original_order_id ⇒ Object

The original order id that this auto order is associated with.



86
87
88
 
# File 'lib/ultracart_api/models/auto_order.rb', line 86

def original_order_id
  @original_order_id
end

#override_affiliate_id ⇒ Object

Override the affiliate id given credit for rebills of this auto order



89
90
91
 
# File 'lib/ultracart_api/models/auto_order.rb', line 89

def override_affiliate_id
  @override_affiliate_id
end

#properties ⇒ Object

Array of property objects



92
93
94
 
# File 'lib/ultracart_api/models/auto_order.rb', line 92

def properties
  @properties
end

#rebill_orders ⇒ Object

Rebill orders that have taken place on this auto order



95
96
97
 
# File 'lib/ultracart_api/models/auto_order.rb', line 95

def rebill_orders
  @rebill_orders
end

#rotating_transaction_gateway_code ⇒ Object

The RTG code associated with this order for future rebills



98
99
100
 
# File 'lib/ultracart_api/models/auto_order.rb', line 98

def rotating_transaction_gateway_code
  @rotating_transaction_gateway_code
end

#status ⇒ Object

The status of the auto order



101
102
103
 
# File 'lib/ultracart_api/models/auto_order.rb', line 101

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



161
162
163
 
# File 'lib/ultracart_api/models/auto_order.rb', line 161

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'add_ons' => :'add_ons',
    :'auto_order_code' => :'auto_order_code',
    :'auto_order_oid' => :'auto_order_oid',
    :'cancel_after_next_x_orders' => :'cancel_after_next_x_orders',
    :'cancel_downgrade' => :'cancel_downgrade',
    :'cancel_reason' => :'cancel_reason',
    :'cancel_upgrade' => :'cancel_upgrade',
    :'canceled_by_user' => :'canceled_by_user',
    :'canceled_dts' => :'canceled_dts',
    :'completed' => :'completed',
    :'credit_card_attempt' => :'credit_card_attempt',
    :'disabled_dts' => :'disabled_dts',
    :'emails' => :'emails',
    :'enabled' => :'enabled',
    :'failure_reason' => :'failure_reason',
    :'items' => :'items',
    :'logs' => :'logs',
    :'management' => :'management',
    :'merchant_id' => :'merchant_id',
    :'merged_dts' => :'merged_dts',
    :'merged_into_auto_order_oid' => :'merged_into_auto_order_oid',
    :'next_attempt' => :'next_attempt',
    :'original_order' => :'original_order',
    :'original_order_id' => :'original_order_id',
    :'override_affiliate_id' => :'override_affiliate_id',
    :'properties' => :'properties',
    :'rebill_orders' => :'rebill_orders',
    :'rotating_transaction_gateway_code' => :'rotating_transaction_gateway_code',
    :'status' => :'status'
  }
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



426
427
428
 
# File 'lib/ultracart_api/models/auto_order.rb', line 426

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



201
202
203
204
 
# File 'lib/ultracart_api/models/auto_order.rb', line 201

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'add_ons' => :'Array<AutoOrderAddonItem>',
    :'auto_order_code' => :'String',
    :'auto_order_oid' => :'Integer',
    :'cancel_after_next_x_orders' => :'Integer',
    :'cancel_downgrade' => :'Boolean',
    :'cancel_reason' => :'String',
    :'cancel_upgrade' => :'Boolean',
    :'canceled_by_user' => :'String',
    :'canceled_dts' => :'String',
    :'completed' => :'Boolean',
    :'credit_card_attempt' => :'Integer',
    :'disabled_dts' => :'String',
    :'emails' => :'Array<AutoOrderEmail>',
    :'enabled' => :'Boolean',
    :'failure_reason' => :'String',
    :'items' => :'Array<AutoOrderItem>',
    :'logs' => :'Array<AutoOrderLog>',
    :'management' => :'AutoOrderManagement',
    :'merchant_id' => :'String',
    :'merged_dts' => :'String',
    :'merged_into_auto_order_oid' => :'Integer',
    :'next_attempt' => :'String',
    :'original_order' => :'Order',
    :'original_order_id' => :'String',
    :'override_affiliate_id' => :'Integer',
    :'properties' => :'Array<AutoOrderProperty>',
    :'rebill_orders' => :'Array<Order>',
    :'rotating_transaction_gateway_code' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
404
405
406
407
408
409
 
# File 'lib/ultracart_api/models/auto_order.rb', line 377

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      add_ons == o.add_ons &&
      auto_order_code == o.auto_order_code &&
      auto_order_oid == o.auto_order_oid &&
      cancel_after_next_x_orders == o.cancel_after_next_x_orders &&
      cancel_downgrade == o.cancel_downgrade &&
      cancel_reason == o.cancel_reason &&
      cancel_upgrade == o.cancel_upgrade &&
      canceled_by_user == o.canceled_by_user &&
      canceled_dts == o.canceled_dts &&
      completed == o.completed &&
      credit_card_attempt == o.credit_card_attempt &&
      disabled_dts == o.disabled_dts &&
      emails == o.emails &&
      enabled == o.enabled &&
      failure_reason == o.failure_reason &&
      items == o.items &&
      logs == o.logs &&
      management == o.management &&
      merchant_id == o.merchant_id &&
      merged_dts == o.merged_dts &&
      merged_into_auto_order_oid == o.merged_into_auto_order_oid &&
      next_attempt == o.next_attempt &&
      original_order == o.original_order &&
      original_order_id == o.original_order_id &&
      override_affiliate_id == o.override_affiliate_id &&
      properties == o.properties &&
      rebill_orders == o.rebill_orders &&
      rotating_transaction_gateway_code == o.rotating_transaction_gateway_code &&
      status == o.status
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



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/ultracart_api/models/auto_order.rb', line 457

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



528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/ultracart_api/models/auto_order.rb', line 528

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



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/ultracart_api/models/auto_order.rb', line 433

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



419
420
421
 
# File 'lib/ultracart_api/models/auto_order.rb', line 419

def hash
  [add_ons, auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, emails, enabled, failure_reason, items, logs, management, merchant_id, merged_dts, merged_into_auto_order_oid, next_attempt, original_order, original_order_id, override_affiliate_id, properties, rebill_orders, rotating_transaction_gateway_code, status].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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



504
505
506
 
# File 'lib/ultracart_api/models/auto_order.rb', line 504

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



510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/ultracart_api/models/auto_order.rb', line 510

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



498
499
500
 
# File 'lib/ultracart_api/models/auto_order.rb', line 498

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



359
360
361
362
363
 
# File 'lib/ultracart_api/models/auto_order.rb', line 359

def valid?
  status_validator = EnumAttributeValidator.new('String', ["active", "canceled", "disabled", "merged"])
  return false unless status_validator.valid?(@status)
  true
end