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



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
 
# File 'lib/ultracart_api/models/order_payment.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?(:'check')
    self.check = attributes[:'check']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

def check
  @check
end

#credit_card ⇒ Object

Returns the value of attribute credit_card.



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

def credit_card
  @credit_card
end

#echeck ⇒ Object

Returns the value of attribute echeck.



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

def echeck
  @echeck
end

#health_benefit_card ⇒ Object

Returns the value of attribute health_benefit_card.



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

def health_benefit_card
  @health_benefit_card
end

#hold_for_fraud_review ⇒ Object

True if order has been held for fraud review



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

def hold_for_fraud_review
  @hold_for_fraud_review
end

#insurance ⇒ Object

Returns the value of attribute insurance.



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

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



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

def payment_dts
  @payment_dts
end

#payment_method ⇒ Object

Payment method



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

def payment_method
  @payment_method
end

#payment_method_accounting_code ⇒ Object

Payment method QuickBooks code



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

def payment_method_accounting_code
  @payment_method_accounting_code
end

#payment_method_deposit_to_account ⇒ Object

Payment method QuickBooks deposit account



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

def 
  
end

#payment_status ⇒ Object

Payment status



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

def payment_status
  @payment_status
end

#purchase_order ⇒ Object

Returns the value of attribute purchase_order.



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

def purchase_order
  @purchase_order
end

#rotating_transaction_gateway_code ⇒ Object

Rotating transaction gateway code used to process this order



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

def rotating_transaction_gateway_code
  @rotating_transaction_gateway_code
end

#surcharge ⇒ Object

Returns the value of attribute surcharge.



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

def surcharge
  @surcharge
end

#surcharge_accounting_code ⇒ Object

Surcharge accounting code



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

def surcharge_accounting_code
  @surcharge_accounting_code
end

#surcharge_transaction_fee ⇒ Object

Surcharge transaction fee



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

def surcharge_transaction_fee
  @surcharge_transaction_fee
end

#surcharge_transaction_percentage ⇒ Object

Surcharge transaction percentage



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

def surcharge_transaction_percentage
  @surcharge_transaction_percentage
end

#test_order ⇒ Object

True if this is a test order



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

def test_order
  @test_order
end

#transactions ⇒ Object

Transactions associated with processing this payment



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

def transactions
  @transactions
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    :'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

.swagger_types ⇒ Object

Attribute type mapping.



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/order_payment.rb', line 115

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ultracart_api/models/order_payment.rb', line 265

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 &&
      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



325
326
327
328
329
330
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
 
# File 'lib/ultracart_api/models/order_payment.rb', line 325

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/ultracart_api/models/order_payment.rb', line 391

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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/ultracart_api/models/order_payment.rb', line 304

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

See Also:

  • `==` method


291
292
293
 
# File 'lib/ultracart_api/models/order_payment.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



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

def hash
  [check, credit_card, echeck, health_benefit_card, hold_for_fraud_review, insurance, payment_dts, payment_method, payment_method_accounting_code, , payment_status, 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?



228
229
230
231
 
# File 'lib/ultracart_api/models/order_payment.rb', line 228

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



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

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



377
378
379
380
381
382
383
384
385
 
# File 'lib/ultracart_api/models/order_payment.rb', line 377

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



365
366
367
 
# File 'lib/ultracart_api/models/order_payment.rb', line 365

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



235
236
237
238
239
240
241
 
# File 'lib/ultracart_api/models/order_payment.rb', line 235

def valid?
  payment_method_validator = EnumAttributeValidator.new('String', ['Affirm', 'Amazon', 'Amazon SC', 'Cash', 'Check', 'COD', 'Credit Card', 'eBay', 'eCheck', 'Google Shopping', 'Insurance', 'LoanHero', 'Money Order', 'PayPal', 'Purchase Order', 'Quote Request', 'Unknown', 'Wire Transfer', 'Walmart', 'Shop.com', 'Sezzle', 'Venmo', 'Apple Pay', 'Google Pay', 'Health Benefit Card'])
  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