Class: UltracartClient::OrderPayment

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderPayment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#check ⇒ Object

Returns the value of attribute check.



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

def check
  @check
end

#credit_card ⇒ Object

Returns the value of attribute credit_card.



20
21
22
 
# File 'lib/ultracart_api/models/order_payment.rb', line 20

def credit_card
  @credit_card
end

#echeck ⇒ Object

Returns the value of attribute echeck.



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

def echeck
  @echeck
end

#health_benefit_card ⇒ Object

Returns the value of attribute health_benefit_card.



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

def health_benefit_card
  @health_benefit_card
end

#hold_for_fraud_review ⇒ Object

True if order has been held for fraud review



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

def hold_for_fraud_review
  @hold_for_fraud_review
end

#insurance ⇒ Object

Returns the value of attribute insurance.



29
30
31
 
# File 'lib/ultracart_api/models/order_payment.rb', line 29

def insurance
  @insurance
end

#payment_dts ⇒ Object

Date/time that the payment was successfully processed, for new orders, this field is only considered if channel_partner.skip_payment_processing is true



32
33
34
 
# File 'lib/ultracart_api/models/order_payment.rb', line 32

def payment_dts
  @payment_dts
end

#payment_method ⇒ Object

Payment method



35
36
37
 
# File 'lib/ultracart_api/models/order_payment.rb', line 35

def payment_method
  @payment_method
end

#payment_method_accounting_code ⇒ Object

Payment method QuickBooks code



38
39
40
 
# File 'lib/ultracart_api/models/order_payment.rb', line 38

def payment_method_accounting_code
  @payment_method_accounting_code
end

#payment_method_deposit_to_account ⇒ Object

Payment method QuickBooks deposit account



41
42
43
 
# File 'lib/ultracart_api/models/order_payment.rb', line 41

def 
  @payment_method_deposit_to_account
end

#payment_status ⇒ Object

Payment status



44
45
46
 
# File 'lib/ultracart_api/models/order_payment.rb', line 44

def payment_status
  @payment_status
end

#paypal ⇒ Object

Returns the value of attribute paypal.



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

def paypal
  @paypal
end

#purchase_order ⇒ Object

Returns the value of attribute purchase_order.



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

def purchase_order
  @purchase_order
end

#rotating_transaction_gateway_code ⇒ Object

Rotating transaction gateway code used to process this order



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

def rotating_transaction_gateway_code
  @rotating_transaction_gateway_code
end

#surcharge ⇒ Object

Returns the value of attribute surcharge.



53
54
55
 
# File 'lib/ultracart_api/models/order_payment.rb', line 53

def surcharge
  @surcharge
end

#surcharge_accounting_code ⇒ Object

Surcharge accounting code



56
57
58
 
# File 'lib/ultracart_api/models/order_payment.rb', line 56

def surcharge_accounting_code
  @surcharge_accounting_code
end

#surcharge_transaction_fee ⇒ Object

Surcharge transaction fee



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

def surcharge_transaction_fee
  @surcharge_transaction_fee
end

#surcharge_transaction_percentage ⇒ Object

Surcharge transaction percentage



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

def surcharge_transaction_percentage
  @surcharge_transaction_percentage
end

#test_order ⇒ Object

True if this is a test order



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

def test_order
  @test_order
end

#transactions ⇒ Object

Transactions associated with processing this payment



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

def transactions
  @transactions
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



119
120
121
 
# File 'lib/ultracart_api/models/order_payment.rb', line 119

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/ultracart_api/models/order_payment.rb', line 93

def self.attribute_map
  {
    :'check' => :'check',
    :'credit_card' => :'credit_card',
    :'echeck' => :'echeck',
    :'health_benefit_card' => :'health_benefit_card',
    :'hold_for_fraud_review' => :'hold_for_fraud_review',
    :'insurance' => :'insurance',
    :'payment_dts' => :'payment_dts',
    :'payment_method' => :'payment_method',
    :'payment_method_accounting_code' => :'payment_method_accounting_code',
    :'payment_method_deposit_to_account' => :'payment_method_deposit_to_account',
    :'payment_status' => :'payment_status',
    :'paypal' => :'paypal',
    :'purchase_order' => :'purchase_order',
    :'rotating_transaction_gateway_code' => :'rotating_transaction_gateway_code',
    :'surcharge' => :'surcharge',
    :'surcharge_accounting_code' => :'surcharge_accounting_code',
    :'surcharge_transaction_fee' => :'surcharge_transaction_fee',
    :'surcharge_transaction_percentage' => :'surcharge_transaction_percentage',
    :'test_order' => :'test_order',
    :'transactions' => :'transactions'
  }
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



332
333
334
 
# File 'lib/ultracart_api/models/order_payment.rb', line 332

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



150
151
152
153
 
# File 'lib/ultracart_api/models/order_payment.rb', line 150

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'check' => :'OrderPaymentCheck',
    :'credit_card' => :'OrderPaymentCreditCard',
    :'echeck' => :'OrderPaymentECheck',
    :'health_benefit_card' => :'OrderPaymentHealthBenefitCard',
    :'hold_for_fraud_review' => :'Boolean',
    :'insurance' => :'OrderPaymentInsurance',
    :'payment_dts' => :'String',
    :'payment_method' => :'String',
    :'payment_method_accounting_code' => :'String',
    :'payment_method_deposit_to_account' => :'String',
    :'payment_status' => :'String',
    :'paypal' => :'OrderPaymentPayPal',
    :'purchase_order' => :'OrderPaymentPurchaseOrder',
    :'rotating_transaction_gateway_code' => :'String',
    :'surcharge' => :'Currency',
    :'surcharge_accounting_code' => :'String',
    :'surcharge_transaction_fee' => :'Float',
    :'surcharge_transaction_percentage' => :'Float',
    :'test_order' => :'Boolean',
    :'transactions' => :'Array<OrderPaymentTransaction>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      check == o.check &&
      credit_card == o.credit_card &&
      echeck == o.echeck &&
      health_benefit_card == o.health_benefit_card &&
      hold_for_fraud_review == o.hold_for_fraud_review &&
      insurance == o.insurance &&
      payment_dts == o.payment_dts &&
      payment_method == o.payment_method &&
      payment_method_accounting_code == o.payment_method_accounting_code &&
       == o. &&
      payment_status == o.payment_status &&
      paypal == o.paypal &&
      purchase_order == o.purchase_order &&
      rotating_transaction_gateway_code == o.rotating_transaction_gateway_code &&
      surcharge == o.surcharge &&
      surcharge_accounting_code == o.surcharge_accounting_code &&
      surcharge_transaction_fee == o.surcharge_transaction_fee &&
      surcharge_transaction_percentage == o.surcharge_transaction_percentage &&
      test_order == o.test_order &&
      transactions == o.transactions
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



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
399
400
 
# File 'lib/ultracart_api/models/order_payment.rb', line 363

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



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/ultracart_api/models/order_payment.rb', line 434

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



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

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


319
320
321
 
# File 'lib/ultracart_api/models/order_payment.rb', line 319

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



325
326
327
 
# File 'lib/ultracart_api/models/order_payment.rb', line 325

def hash
  [check, credit_card, echeck, health_benefit_card, hold_for_fraud_review, insurance, payment_dts, payment_method, payment_method_accounting_code, , payment_status, paypal, purchase_order, rotating_transaction_gateway_code, surcharge, surcharge_accounting_code, surcharge_transaction_fee, surcharge_transaction_percentage, test_order, transactions].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



255
256
257
258
 
# File 'lib/ultracart_api/models/order_payment.rb', line 255

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



410
411
412
 
# File 'lib/ultracart_api/models/order_payment.rb', line 410

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



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/ultracart_api/models/order_payment.rb', line 416

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



404
405
406
 
# File 'lib/ultracart_api/models/order_payment.rb', line 404

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



262
263
264
265
266
267
268
 
# File 'lib/ultracart_api/models/order_payment.rb', line 262

def valid?
  payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eBay", "eCheck", "Google Shopping", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane"])
  return false unless payment_method_validator.valid?(@payment_method)
  payment_status_validator = EnumAttributeValidator.new('String', ["Unprocessed", "Authorized", "Capture Failed", "Processed", "Declined", "Voided", "Refunded", "Skipped"])
  return false unless payment_status_validator.valid?(@payment_status)
  true
end