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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auto_order_code ⇒ Object

Unique code assigned to this auto order



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

def auto_order_code
  @auto_order_code
end

#auto_order_oid ⇒ Object

Auto order object identifier



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

def auto_order_oid
  @auto_order_oid
end

#cancel_after_next_x_orders ⇒ Object

Cancel this auto order after X additional rebills



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

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



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

def cancel_downgrade
  @cancel_downgrade
end

#cancel_upgrade ⇒ Object

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



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

def cancel_upgrade
  @cancel_upgrade
end

#canceled_by_user ⇒ Object

The user that canceled the auto order



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

def canceled_by_user
  @canceled_by_user
end

#canceled_dts ⇒ Object

The date/time that the auto order was canceled



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

def canceled_dts
  @canceled_dts
end

#completed ⇒ Object

True if the auto order ran successfully to completion



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

def completed
  @completed
end

#credit_card_attempt ⇒ Object

The number of credit card attempts that have taken place



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

def credit_card_attempt
  @credit_card_attempt
end

#disabled_dts ⇒ Object

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



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

def disabled_dts
  @disabled_dts
end

#enabled ⇒ Object

True if this auto order is enabled



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

def enabled
  @enabled
end

#failure_reason ⇒ Object

The reason this auto order failed during the last rebill attempt



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

def failure_reason
  @failure_reason
end

#items ⇒ Object

The items that are setup to rebill



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

def items
  @items
end

#next_attempt ⇒ Object

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



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

def next_attempt
  @next_attempt
end

#original_order ⇒ Object

Returns the value of attribute original_order.



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

def original_order
  @original_order
end

#original_order_id ⇒ Object

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



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

def original_order_id
  @original_order_id
end

#override_affiliate_id ⇒ Object

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



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

def override_affiliate_id
  @override_affiliate_id
end

#rebill_orders ⇒ Object

Rebill orders that have taken place on this auto order



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

def rebill_orders
  @rebill_orders
end

#rotating_transaction_gateway_code ⇒ Object

The RTG code associated with this order for future rebills



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

def rotating_transaction_gateway_code
  @rotating_transaction_gateway_code
end

#status ⇒ Object

The status of the auto order



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

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



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

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_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' => :'original_order',
    :'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

.swagger_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ultracart_api/models/auto_order.rb', line 125

def self.swagger_types
  {
    :'auto_order_code' => :'String',
    :'auto_order_oid' => :'Integer',
    :'cancel_after_next_x_orders' => :'Integer',
    :'cancel_downgrade' => :'BOOLEAN',
    :'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' => :'Order',
    :'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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/ultracart_api/models/auto_order.rb', line 270

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_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 == o.original_order &&
      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



331
332
333
334
335
336
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
 
# File 'lib/ultracart_api/models/auto_order.rb', line 331

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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/ultracart_api/models/auto_order.rb', line 397

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/ultracart_api/models/auto_order.rb', line 310

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


297
298
299
 
# File 'lib/ultracart_api/models/auto_order.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, next_attempt, original_order, 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



245
246
247
248
 
# File 'lib/ultracart_api/models/auto_order.rb', line 245

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



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

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



383
384
385
386
387
388
389
390
391
 
# File 'lib/ultracart_api/models/auto_order.rb', line 383

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



371
372
373
 
# File 'lib/ultracart_api/models/auto_order.rb', line 371

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



252
253
254
255
256
 
# File 'lib/ultracart_api/models/auto_order.rb', line 252

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