Class: UltracartClient::OrderAutoOrder

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderAutoOrder

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/order_auto_order.rb', line 165

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

#auto_order_code ⇒ Object

Unique code assigned to this auto order



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

def auto_order_code
  @auto_order_code
end

#auto_order_oid ⇒ Object

Auto order object identifier



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

def auto_order_oid
  @auto_order_oid
end

#cancel_after_next_x_orders ⇒ Object

Cancel this auto order after X additional rebills



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

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



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

def cancel_downgrade
  @cancel_downgrade
end

#cancel_reason ⇒ Object

The reason this auto order was canceled by either merchant or customer



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

def cancel_reason
  @cancel_reason
end

#cancel_upgrade ⇒ Object

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



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

def cancel_upgrade
  @cancel_upgrade
end

#canceled_by_user ⇒ Object

The user that canceled the auto order



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

def canceled_by_user
  @canceled_by_user
end

#canceled_dts ⇒ Object

The date/time that the auto order was canceled



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

def canceled_dts
  @canceled_dts
end

#completed ⇒ Object

True if the auto order ran successfully to completion



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

def completed
  @completed
end

#credit_card_attempt ⇒ Object

The number of credit card attempts that have taken place



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

def credit_card_attempt
  @credit_card_attempt
end

#disabled_dts ⇒ Object

The date/time the auto order was disabled due to failed rebills



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

def disabled_dts
  @disabled_dts
end

#enabled ⇒ Object

True if this auto order is enabled



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

def enabled
  @enabled
end

#failure_reason ⇒ Object

The reason this auto order failed during the last rebill attempt



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

def failure_reason
  @failure_reason
end

#items ⇒ Object

The items that are setup to rebill



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

def items
  @items
end

#next_attempt ⇒ Object

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



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

def next_attempt
  @next_attempt
end

#original_order_id ⇒ Object

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



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

def original_order_id
  @original_order_id
end

#override_affiliate_id ⇒ Object

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



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

def override_affiliate_id
  @override_affiliate_id
end

#rebill_orders ⇒ Object

Rebill orders that have taken place on this auto order



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

def rebill_orders
  @rebill_orders
end

#rotating_transaction_gateway_code ⇒ Object

The RTG code associated with this order for future rebills



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

def rotating_transaction_gateway_code
  @rotating_transaction_gateway_code
end

#status ⇒ Object

The status of the auto order



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

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'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',
    :'enabled' => :'enabled',
    :'failure_reason' => :'failure_reason',
    :'items' => :'items',
    :'next_attempt' => :'next_attempt',
    :'original_order_id' => :'original_order_id',
    :'override_affiliate_id' => :'override_affiliate_id',
    :'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



330
331
332
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 330

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



158
159
160
161
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 158

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

.openapi_types ⇒ Object

Attribute type mapping.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 132

def self.openapi_types
  {
    :'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',
    :'enabled' => :'Boolean',
    :'failure_reason' => :'String',
    :'items' => :'Array<AutoOrderItem>',
    :'next_attempt' => :'String',
    :'original_order_id' => :'String',
    :'override_affiliate_id' => :'Integer',
    :'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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 290

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      enabled == o.enabled &&
      failure_reason == o.failure_reason &&
      items == o.items &&
      next_attempt == o.next_attempt &&
      original_order_id == o.original_order_id &&
      override_affiliate_id == o.override_affiliate_id &&
      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



361
362
363
364
365
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
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 361

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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 432

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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 337

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


317
318
319
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



323
324
325
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 323

def hash
  [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, enabled, failure_reason, items, next_attempt, original_order_id, override_affiliate_id, 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



265
266
267
268
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 265

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



408
409
410
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 408

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 414

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



402
403
404
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 402

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



272
273
274
275
276
 
# File 'lib/ultracart_api/models/order_auto_order.rb', line 272

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