Class: Yapstone::PaymentDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/yapstone-payments/models/payment_details.rb

Overview

The payment method and any additional PII Yapstone may need to collect for risk purposes in order to process this payment.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 86

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

  if attributes.key?(:'authorization_type')
    self.authorization_type = attributes[:'authorization_type']
  else
    self.authorization_type = 'FINALAUTH'
  end

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

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

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

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

  if attributes.key?(:'instrument_owner')
    self.instrument_owner = attributes[:'instrument_owner']
  else
    self.instrument_owner = true
  end
end

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



29
30
31
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 29

def amount
  @amount
end

#authorization_type ⇒ Object

Used to list the authorization type. If it is PRIORAUTH this is a pre-authorization that places a hold on your customer’s credit card for a specified dollar amount based on a projected sale amount. FINALAUTH is when you have completed all work checking the card and the customer and you are ready to actually withdraw the payment.



22
23
24
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 22

def authorization_type
  @authorization_type
end

#custom_soft_descriptor ⇒ Object

The descriptor that will be shown on the customer’s bank statement after the transaction has been authorized.



25
26
27
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 25

def custom_soft_descriptor
  @custom_soft_descriptor
end

#installment_plan ⇒ Object

Returns the value of attribute installment_plan.



27
28
29
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 27

def installment_plan
  @installment_plan
end

#instrument_owner ⇒ Object

This indicates whether it is true that the payment method a customer wants to use belongs to the customer or not.



34
35
36
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 34

def instrument_owner
  @instrument_owner
end

#line_items ⇒ Object

If your payment is for multiple line items, detail them here. The sum of your line item amounts must equal the amount given at the root of the request body.



19
20
21
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 19

def line_items
  @line_items
end

#payment_instrument ⇒ Object

Returns the value of attribute payment_instrument.



31
32
33
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 31

def payment_instrument
  @payment_instrument
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 59

def self.attribute_map
  {
    :'line_items' => :'lineItems',
    :'authorization_type' => :'authorizationType',
    :'custom_soft_descriptor' => :'customSoftDescriptor',
    :'installment_plan' => :'installmentPlan',
    :'amount' => :'amount',
    :'payment_instrument' => :'paymentInstrument',
    :'instrument_owner' => :'instrumentOwner'
  }
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



212
213
214
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 212

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 72

def self.openapi_types
  {
    :'line_items' => :'Array<OfferingDetails>',
    :'authorization_type' => :'String',
    :'custom_soft_descriptor' => :'String',
    :'installment_plan' => :'InstallmentPlan',
    :'amount' => :'Amount',
    :'payment_instrument' => :'PaymentInstrument',
    :'instrument_owner' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      line_items == o.line_items &&
      authorization_type == o.authorization_type &&
      custom_soft_descriptor == o.custom_soft_descriptor &&
      installment_plan == o.installment_plan &&
      amount == o.amount &&
      payment_instrument == o.payment_instrument &&
      instrument_owner == o.instrument_owner
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



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
269
270
271
272
273
274
275
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 240

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
    Yapstone.const_get(type).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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 305

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 219

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


199
200
201
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 205

def hash
  [line_items, authorization_type, custom_soft_descriptor, installment_plan, amount, payment_instrument, instrument_owner].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



136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 136

def list_invalid_properties
  invalid_properties = Array.new
  if !@custom_soft_descriptor.nil? && @custom_soft_descriptor.to_s.length > 36
    invalid_properties.push('invalid value for "custom_soft_descriptor", the character length must be smaller than or equal to 36.')
  end

  if !@custom_soft_descriptor.nil? && @custom_soft_descriptor.to_s.length < 0
    invalid_properties.push('invalid value for "custom_soft_descriptor", the character length must be great than or equal to 0.')
  end

  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



285
286
287
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 285

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



291
292
293
294
295
296
297
298
299
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 291

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



279
280
281
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 279

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



151
152
153
154
155
156
157
 
# File 'lib/yapstone-payments/models/payment_details.rb', line 151

def valid?
  authorization_type_validator = EnumAttributeValidator.new('String', ["FINALAUTH", "PRIORAUTH", ""])
  return false unless authorization_type_validator.valid?(@authorization_type)
  return false if !@custom_soft_descriptor.nil? && @custom_soft_descriptor.to_s.length > 36
  return false if !@custom_soft_descriptor.nil? && @custom_soft_descriptor.to_s.length < 0
  true
end