Class: Bfwd::Payment

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/models/payment.rb

Overview

Payment

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Payment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
209
210
211
212
213
 
# File 'lib/bf_ruby2/models/payment.rb', line 139

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#actual_value ⇒ Object

{ "description" : "Actual monetary value of the payment. This is real value of the payment amount, thus the amount of currency received for this payment. A coupon has a real value of zero, even though the nominal amount it pays may be greater than zero.", "verbs“: }



52
53
54
 
# File 'lib/bf_ruby2/models/payment.rb', line 52

def actual_value
  @actual_value
end

#changed_by ⇒ Object

{ "description" : "ID of the user who last updated the entity.", "verbs":[] }



22
23
24
 
# File 'lib/bf_ruby2/models/payment.rb', line 22

def changed_by
  @changed_by
end

#created ⇒ Object

{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }



19
20
21
 
# File 'lib/bf_ruby2/models/payment.rb', line 19

def created
  @created
end

#crm_id ⇒ Object

{ "description" : "CRM ID of the invoice.", "verbs“: }



31
32
33
 
# File 'lib/bf_ruby2/models/payment.rb', line 31

def crm_id
  @crm_id
end

#currency ⇒ Object

{ "description" : "The currency of the payment specified by a three character ISO 4217 currency code.", "verbs“: }



46
47
48
 
# File 'lib/bf_ruby2/models/payment.rb', line 46

def currency
  @currency
end

#gateway ⇒ Object

{ "description" : "Payment gateway associated with the payment", "verbs“: }



43
44
45
 
# File 'lib/bf_ruby2/models/payment.rb', line 43

def gateway
  @gateway
end

#id ⇒ Object

{ "description" : "ID of the payment.", "verbs“: }



28
29
30
 
# File 'lib/bf_ruby2/models/payment.rb', line 28

def id
  @id
end

#invoice_id ⇒ Object

{ "description" : "ID of the invoice associated with the payment. This may be null when a payment is not explicitly associated with an invoice. Payments may be used across multiple invoices.", "verbs“: }



37
38
39
 
# File 'lib/bf_ruby2/models/payment.rb', line 37

def invoice_id
  @invoice_id
end

#nominal_value ⇒ Object

{ "description" : "Nominal value of the payment. This is the theoretical value of the payment, thus the value this payment can pay off an invoice. For example a coupon has a nominal value of the discount, and the actual value is zero.", "verbs“: }



49
50
51
 
# File 'lib/bf_ruby2/models/payment.rb', line 49

def nominal_value
  @nominal_value
end

#organization_id ⇒ Object

{ "description" : "ID of the organization associated with the payment.", "verbs“: }



40
41
42
 
# File 'lib/bf_ruby2/models/payment.rb', line 40

def organization_id
  @organization_id
end

#payment_method_id ⇒ Object

{ "description" : "ID of the payment method associated with the payment.", "verbs“: }



34
35
36
 
# File 'lib/bf_ruby2/models/payment.rb', line 34

def payment_method_id
  @payment_method_id
end

#payment_received ⇒ Object

{ "description" : "UTC DateTime specifying when payment was received for the invoice.", "verbs“: }



58
59
60
 
# File 'lib/bf_ruby2/models/payment.rb', line 58

def payment_received
  @payment_received
end

#refund_id ⇒ Object

{ "description" : "ID of the refund associated with the payment.", "verbs“: }



64
65
66
 
# File 'lib/bf_ruby2/models/payment.rb', line 64

def refund_id
  @refund_id
end

#refunded_value ⇒ Object

{ "description" : "Refunded nominal value of the payment.", "verbs“: }



61
62
63
 
# File 'lib/bf_ruby2/models/payment.rb', line 61

def refunded_value
  @refunded_value
end

#remaining_nominal_value ⇒ Object

{ "description" : "Remaining nominal value of the payment not used. In the case when a payment is used across a range of invoices a payment may be used multiple times, each use reducing the available blance of the payment.", "verbs“: }



55
56
57
 
# File 'lib/bf_ruby2/models/payment.rb', line 55

def remaining_nominal_value
  @remaining_nominal_value
end

#type ⇒ Object

{ "description" : "Type of payment.", "verbs“: }



67
68
69
 
# File 'lib/bf_ruby2/models/payment.rb', line 67

def type
  @type
end

#updated ⇒ Object

{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }



25
26
27
 
# File 'lib/bf_ruby2/models/payment.rb', line 25

def updated
  @updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'created' => :'created',
    :'changed_by' => :'changedBy',
    :'updated' => :'updated',
    :'id' => :'id',
    :'crm_id' => :'crmID',
    :'payment_method_id' => :'paymentMethodID',
    :'invoice_id' => :'invoiceID',
    :'organization_id' => :'organizationID',
    :'gateway' => :'gateway',
    :'currency' => :'currency',
    :'nominal_value' => :'nominalValue',
    :'actual_value' => :'actualValue',
    :'remaining_nominal_value' => :'remainingNominalValue',
    :'payment_received' => :'paymentReceived',
    :'refunded_value' => :'refundedValue',
    :'refund_id' => :'refundID',
    :'type' => :'type'
  }
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
 
# File 'lib/bf_ruby2/models/payment.rb', line 115

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'changed_by' => :'String',
    :'updated' => :'DateTime',
    :'id' => :'String',
    :'crm_id' => :'String',
    :'payment_method_id' => :'String',
    :'invoice_id' => :'String',
    :'organization_id' => :'String',
    :'gateway' => :'String',
    :'currency' => :'String',
    :'nominal_value' => :'Float',
    :'actual_value' => :'Float',
    :'remaining_nominal_value' => :'Float',
    :'payment_received' => :'DateTime',
    :'refunded_value' => :'Float',
    :'refund_id' => :'String',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/bf_ruby2/models/payment.rb', line 314

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      changed_by == o.changed_by &&
      updated == o.updated &&
      id == o.id &&
      crm_id == o.crm_id &&
      payment_method_id == o.payment_method_id &&
      invoice_id == o.invoice_id &&
      organization_id == o.organization_id &&
      gateway == o.gateway &&
      currency == o.currency &&
      nominal_value == o.nominal_value &&
      actual_value == o.actual_value &&
      remaining_nominal_value == o.remaining_nominal_value &&
      payment_received == o.payment_received &&
      refunded_value == o.refunded_value &&
      refund_id == o.refund_id &&
      type == o.type
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



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
401
402
403
404
405
406
407
408
 
# File 'lib/bf_ruby2/models/payment.rb', line 372

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 = Bfwd.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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/bf_ruby2/models/payment.rb', line 438

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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/bf_ruby2/models/payment.rb', line 351

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


338
339
340
 
# File 'lib/bf_ruby2/models/payment.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



344
345
346
 
# File 'lib/bf_ruby2/models/payment.rb', line 344

def hash
  [created, changed_by, updated, id, crm_id, payment_method_id, invoice_id, organization_id, gateway, currency, nominal_value, actual_value, remaining_nominal_value, payment_received, refunded_value, refund_id, type].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



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
262
263
264
265
266
267
268
 
# File 'lib/bf_ruby2/models/payment.rb', line 217

def list_invalid_properties
  invalid_properties = Array.new
  if @crm_id.nil?
    invalid_properties.push("invalid value for 'crm_id', crm_id cannot be nil.")
  end

  if @payment_method_id.nil?
    invalid_properties.push("invalid value for 'payment_method_id', payment_method_id cannot be nil.")
  end

  if @invoice_id.nil?
    invalid_properties.push("invalid value for 'invoice_id', invoice_id cannot be nil.")
  end

  if @organization_id.nil?
    invalid_properties.push("invalid value for 'organization_id', organization_id cannot be nil.")
  end

  if @gateway.nil?
    invalid_properties.push("invalid value for 'gateway', gateway cannot be nil.")
  end

  if @currency.nil?
    invalid_properties.push("invalid value for 'currency', currency cannot be nil.")
  end

  if @nominal_value.nil?
    invalid_properties.push("invalid value for 'nominal_value', nominal_value cannot be nil.")
  end

  if @actual_value.nil?
    invalid_properties.push("invalid value for 'actual_value', actual_value cannot be nil.")
  end

  if @remaining_nominal_value.nil?
    invalid_properties.push("invalid value for 'remaining_nominal_value', remaining_nominal_value cannot be nil.")
  end

  if @refunded_value.nil?
    invalid_properties.push("invalid value for 'refunded_value', refunded_value cannot be nil.")
  end

  if @refund_id.nil?
    invalid_properties.push("invalid value for 'refund_id', refund_id cannot be nil.")
  end

  if @type.nil?
    invalid_properties.push("invalid value for 'type', type cannot be nil.")
  end

  return 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



418
419
420
 
# File 'lib/bf_ruby2/models/payment.rb', line 418

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



424
425
426
427
428
429
430
431
432
 
# File 'lib/bf_ruby2/models/payment.rb', line 424

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



412
413
414
 
# File 'lib/bf_ruby2/models/payment.rb', line 412

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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/bf_ruby2/models/payment.rb', line 272

def valid?
  return false if @crm_id.nil?
  return false if @payment_method_id.nil?
  return false if @invoice_id.nil?
  return false if @organization_id.nil?
  return false if @gateway.nil?
  gateway_validator = EnumAttributeValidator.new('String', ["cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash"])
  return false unless gateway_validator.valid?(@gateway)
  return false if @currency.nil?
  return false if @nominal_value.nil?
  return false if @actual_value.nil?
  return false if @remaining_nominal_value.nil?
  return false if @refunded_value.nil?
  return false if @refund_id.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["credit", "debit"])
  return false unless type_validator.valid?(@type)
  return true
end