Class: OpenapiClient::PaymentRegistration

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/payment_registration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentRegistration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/openapi_client/models/payment_registration.rb', line 90

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#customer ⇒ Object

Returns the value of attribute customer.



23
24
25
 
# File 'lib/openapi_client/models/payment_registration.rb', line 23

def customer
  @customer
end

#device ⇒ Object

Returns the value of attribute device.



27
28
29
 
# File 'lib/openapi_client/models/payment_registration.rb', line 27

def device
  @device
end

#issuer_response ⇒ Object

Returns the value of attribute issuer_response.



35
36
37
 
# File 'lib/openapi_client/models/payment_registration.rb', line 35

def issuer_response
  @issuer_response
end

#merchant ⇒ Object

Returns the value of attribute merchant.



25
26
27
 
# File 'lib/openapi_client/models/payment_registration.rb', line 25

def merchant
  @merchant
end

#merchant_ref ⇒ Object

Merchant reference code. Used by FirstAPI and reflected in settlement records and webhook notifications. Typically, the merchantRef field is the purchase order number or unique sequence value associated to a given transaction.



18
19
20
 
# File 'lib/openapi_client/models/payment_registration.rb', line 18

def merchant_ref
  @merchant_ref
end

#original_transaction_type ⇒ Object

Defines the type of the original transaction that is being evaluated for the Fraud Score.



33
34
35
 
# File 'lib/openapi_client/models/payment_registration.rb', line 33

def original_transaction_type
  @original_transaction_type
end

#registration_method ⇒ Object

Returns the value of attribute registration_method.



43
44
45
 
# File 'lib/openapi_client/models/payment_registration.rb', line 43

def registration_method
  @registration_method
end

#transaction_type ⇒ Object

Type of transaction merchant wants to process.



21
22
23
 
# File 'lib/openapi_client/models/payment_registration.rb', line 21

def transaction_type
  @transaction_type
end

#user_defined ⇒ Object

A JSON object that can carry any additional information that might be helpful for fraud detection.



30
31
32
 
# File 'lib/openapi_client/models/payment_registration.rb', line 30

def user_defined
  @user_defined
end

#verification3ds ⇒ Object

Returns the value of attribute verification3ds.



39
40
41
 
# File 'lib/openapi_client/models/payment_registration.rb', line 39

def verification3ds
  @verification3ds
end

#verification_avs ⇒ Object

Returns the value of attribute verification_avs.



37
38
39
 
# File 'lib/openapi_client/models/payment_registration.rb', line 37

def verification_avs
  @verification_avs
end

#verification_cvv ⇒ Object

Returns the value of attribute verification_cvv.



41
42
43
 
# File 'lib/openapi_client/models/payment_registration.rb', line 41

def verification_cvv
  @verification_cvv
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/openapi_client/models/payment_registration.rb', line 46

def self.attribute_map
  {
    :'merchant_ref' => :'merchantRef',
    :'transaction_type' => :'transactionType',
    :'customer' => :'customer',
    :'merchant' => :'merchant',
    :'device' => :'device',
    :'user_defined' => :'userDefined',
    :'original_transaction_type' => :'originalTransactionType',
    :'issuer_response' => :'issuerResponse',
    :'verification_avs' => :'verificationAvs',
    :'verification3ds' => :'verification3ds',
    :'verification_cvv' => :'verificationCvv',
    :'registration_method' => :'registrationMethod'
  }
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



224
225
226
 
# File 'lib/openapi_client/models/payment_registration.rb', line 224

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



82
83
84
85
86
 
# File 'lib/openapi_client/models/payment_registration.rb', line 82

def self.openapi_all_of
  [
  :'FraudRegistration'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/openapi_client/models/payment_registration.rb', line 64

def self.openapi_types
  {
    :'merchant_ref' => :'String',
    :'transaction_type' => :'String',
    :'customer' => :'Customer',
    :'merchant' => :'Merchant',
    :'device' => :'FraudRegistrationDevice',
    :'user_defined' => :'Object',
    :'original_transaction_type' => :'String',
    :'issuer_response' => :'IssuerResponse',
    :'verification_avs' => :'VerificationAvs',
    :'verification3ds' => :'Verification3ds',
    :'verification_cvv' => :'VerificationCvv',
    :'registration_method' => :'RegistrationMethod'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/openapi_client/models/payment_registration.rb', line 192

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      merchant_ref == o.merchant_ref &&
      transaction_type == o.transaction_type &&
      customer == o.customer &&
      merchant == o.merchant &&
      device == o.device &&
      user_defined == o.user_defined &&
      original_transaction_type == o.original_transaction_type &&
      issuer_response == o.issuer_response &&
      verification_avs == o.verification_avs &&
      verification3ds == o.verification3ds &&
      verification_cvv == o.verification_cvv &&
      registration_method == o.registration_method
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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/openapi_client/models/payment_registration.rb', line 252

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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/openapi_client/models/payment_registration.rb', line 326

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/openapi_client/models/payment_registration.rb', line 231

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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


211
212
213
 
# File 'lib/openapi_client/models/payment_registration.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



217
218
219
 
# File 'lib/openapi_client/models/payment_registration.rb', line 217

def hash
  [merchant_ref, transaction_type, customer, merchant, device, user_defined, original_transaction_type, issuer_response, verification_avs, verification3ds, verification_cvv, registration_method].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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/openapi_client/models/payment_registration.rb', line 154

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

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

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

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

  if @registration_method.nil?
    invalid_properties.push('invalid value for "registration_method", registration_method cannot be nil.')
  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



302
303
304
 
# File 'lib/openapi_client/models/payment_registration.rb', line 302

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/openapi_client/models/payment_registration.rb', line 308

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = 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



296
297
298
 
# File 'lib/openapi_client/models/payment_registration.rb', line 296

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



181
182
183
184
185
186
187
188
 
# File 'lib/openapi_client/models/payment_registration.rb', line 181

def valid?
  return false if @transaction_type.nil?
  return false if @customer.nil?
  return false if @merchant.nil?
  return false if @original_transaction_type.nil?
  return false if @registration_method.nil?
  true
end