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



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

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

#hold_for_fraud_review ⇒ Object

True if order has been held for fraud review



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

def hold_for_fraud_review
  @hold_for_fraud_review
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



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

def payment_dts
  @payment_dts
end

#payment_method ⇒ Object

Payment method



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

def payment_method
  @payment_method
end

#payment_method_accounting_code ⇒ Object

Payment method QuickBooks code



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

def payment_method_accounting_code
  @payment_method_accounting_code
end

#payment_method_deposit_to_account ⇒ Object

Payment method QuickBooks deposit account



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

def 
  @payment_method_deposit_to_account
end

#payment_status ⇒ Object

Payment status



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

def payment_status
  @payment_status
end

#purchase_order ⇒ Object

Returns the value of attribute purchase_order.



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

def purchase_order
  @purchase_order
end

#rotating_transaction_gateway_code ⇒ Object

Rotating transaction gateway code used to process this order



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

def rotating_transaction_gateway_code
  @rotating_transaction_gateway_code
end

#surcharge ⇒ Object

Returns the value of attribute surcharge.



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

def surcharge
  @surcharge
end

#surcharge_accounting_code ⇒ Object

Surcharge accounting code



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

def surcharge_accounting_code
  @surcharge_accounting_code
end

#surcharge_transaction_fee ⇒ Object

Surcharge transaction fee



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

def surcharge_transaction_fee
  @surcharge_transaction_fee
end

#surcharge_transaction_percentage ⇒ Object

Surcharge transaction percentage



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

def surcharge_transaction_percentage
  @surcharge_transaction_percentage
end

#test_order ⇒ Object

True if this is a test order



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

def test_order
  @test_order
end

#transactions ⇒ Object

Transactions associated with processing this payment



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

def transactions
  @transactions
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/ultracart_api/models/order_payment.rb', line 86

def self.attribute_map
  {
    :'check' => :'check',
    :'credit_card' => :'credit_card',
    :'echeck' => :'echeck',
    :'hold_for_fraud_review' => :'hold_for_fraud_review',
    :'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.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/ultracart_api/models/order_payment.rb', line 109

def self.swagger_types
  {
    :'check' => :'OrderPaymentCheck',
    :'credit_card' => :'OrderPaymentCreditCard',
    :'echeck' => :'OrderPaymentECheck',
    :'hold_for_fraud_review' => :'BOOLEAN',
    :'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.

Parameters:

  • Object (Object) —

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/ultracart_api/models/order_payment.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      check == o.check &&
      credit_card == o.credit_card &&
      echeck == o.echeck &&
      hold_for_fraud_review == o.hold_for_fraud_review &&
      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

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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

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



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

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ultracart_api/models/order_payment.rb', line 286

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


273
274
275
 
# File 'lib/ultracart_api/models/order_payment.rb', line 273

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



279
280
281
 
# File 'lib/ultracart_api/models/order_payment.rb', line 279

def hash
  [check, credit_card, echeck, hold_for_fraud_review, 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?

Returns:

  • Array for valid properties with the reasons



212
213
214
215
 
# File 'lib/ultracart_api/models/order_payment.rb', line 212

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



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

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



359
360
361
362
363
364
365
366
367
 
# File 'lib/ultracart_api/models/order_payment.rb', line 359

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



347
348
349
 
# File 'lib/ultracart_api/models/order_payment.rb', line 347

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



219
220
221
222
223
224
225
 
# File 'lib/ultracart_api/models/order_payment.rb', line 219

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