Class: OpenapiClient::ProcessorData

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

Overview

Model for processor data.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProcessorData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/openapi_client/models/processor_data.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#association_response_code ⇒ Object

Raw response code from issuer.



31
32
33
 
# File 'lib/openapi_client/models/processor_data.rb', line 31

def association_response_code
  @association_response_code
end

#authorization_code ⇒ Object

Code returned to confirm transaction.



22
23
24
 
# File 'lib/openapi_client/models/processor_data.rb', line 22

def authorization_code
  @authorization_code
end

#avs_response ⇒ Object

Returns the value of attribute avs_response.



36
37
38
 
# File 'lib/openapi_client/models/processor_data.rb', line 36

def avs_response
  @avs_response
end

#debit_receipt_number ⇒ Object

Receipt number from debit network provider.



48
49
50
 
# File 'lib/openapi_client/models/processor_data.rb', line 48

def debit_receipt_number
  @debit_receipt_number
end

#merchant_advice_code_indicator ⇒ Object

Code to map merchant advice code to ISO specification.



42
43
44
 
# File 'lib/openapi_client/models/processor_data.rb', line 42

def merchant_advice_code_indicator
  @merchant_advice_code_indicator
end

#network ⇒ Object

Network used for transaction.



28
29
30
 
# File 'lib/openapi_client/models/processor_data.rb', line 28

def network
  @network
end

#reference_number ⇒ Object

Reference transaction ID.



19
20
21
 
# File 'lib/openapi_client/models/processor_data.rb', line 19

def reference_number
  @reference_number
end

#response_code ⇒ Object

Response code from endpoints.



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

def response_code
  @response_code
end

#response_indicator ⇒ Object

Indicates whether the transaction was routed through the payment card’s own network or through a different network.



45
46
47
 
# File 'lib/openapi_client/models/processor_data.rb', line 45

def response_indicator
  @response_indicator
end

#response_message ⇒ Object

Message returned from endpoints.



34
35
36
 
# File 'lib/openapi_client/models/processor_data.rb', line 34

def response_message
  @response_message
end

#security_code_response ⇒ Object

Code returned for CVV.



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

def security_code_response
  @security_code_response
end

#transaction_integrity_class ⇒ Object

MasterCard provided Transaction Integrity Class for Point of Sale (POS) Purchase and Purchase with Cash Back transactions initiated on the Authorization Platform.



51
52
53
 
# File 'lib/openapi_client/models/processor_data.rb', line 51

def transaction_integrity_class
  @transaction_integrity_class
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/openapi_client/models/processor_data.rb', line 76

def self.attribute_map
  {
    :'reference_number' => :'referenceNumber',
    :'authorization_code' => :'authorizationCode',
    :'response_code' => :'responseCode',
    :'network' => :'network',
    :'association_response_code' => :'associationResponseCode',
    :'response_message' => :'responseMessage',
    :'avs_response' => :'avsResponse',
    :'security_code_response' => :'securityCodeResponse',
    :'merchant_advice_code_indicator' => :'merchantAdviceCodeIndicator',
    :'response_indicator' => :'responseIndicator',
    :'debit_receipt_number' => :'debitReceiptNumber',
    :'transaction_integrity_class' => :'transactionIntegrityClass'
  }
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



251
252
253
 
# File 'lib/openapi_client/models/processor_data.rb', line 251

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/openapi_client/models/processor_data.rb', line 94

def self.openapi_types
  {
    :'reference_number' => :'String',
    :'authorization_code' => :'String',
    :'response_code' => :'String',
    :'network' => :'String',
    :'association_response_code' => :'String',
    :'response_message' => :'String',
    :'avs_response' => :'AVSResponse',
    :'security_code_response' => :'String',
    :'merchant_advice_code_indicator' => :'String',
    :'response_indicator' => :'String',
    :'debit_receipt_number' => :'String',
    :'transaction_integrity_class' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reference_number == o.reference_number &&
      authorization_code == o.authorization_code &&
      response_code == o.response_code &&
      network == o.network &&
      association_response_code == o.association_response_code &&
      response_message == o.response_message &&
      avs_response == o.avs_response &&
      security_code_response == o.security_code_response &&
      merchant_advice_code_indicator == o.merchant_advice_code_indicator &&
      response_indicator == o.response_indicator &&
      debit_receipt_number == o.debit_receipt_number &&
      transaction_integrity_class == o.transaction_integrity_class
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/openapi_client/models/processor_data.rb', line 279

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/openapi_client/models/processor_data.rb', line 353

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/openapi_client/models/processor_data.rb', line 258

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


238
239
240
 
# File 'lib/openapi_client/models/processor_data.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/openapi_client/models/processor_data.rb', line 244

def hash
  [reference_number, authorization_code, response_code, network, association_response_code, response_message, avs_response, security_code_response, merchant_advice_code_indicator, response_indicator, debit_receipt_number, transaction_integrity_class].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



177
178
179
180
181
182
183
184
185
 
# File 'lib/openapi_client/models/processor_data.rb', line 177

def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/[0-9]{2}/)
  if !@merchant_advice_code_indicator.nil? && @merchant_advice_code_indicator !~ pattern
    invalid_properties.push("invalid value for \"merchant_advice_code_indicator\", must conform to the pattern #{pattern}.")
  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



329
330
331
 
# File 'lib/openapi_client/models/processor_data.rb', line 329

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/openapi_client/models/processor_data.rb', line 335

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



323
324
325
 
# File 'lib/openapi_client/models/processor_data.rb', line 323

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



189
190
191
192
193
194
 
# File 'lib/openapi_client/models/processor_data.rb', line 189

def valid?
  security_code_response_validator = EnumAttributeValidator.new('String', ["MATCHED", "NOT_MATCHED", "NOT_PROCESSED", "NOT_PRESENT", "NOT_CERTIFIED", "NOT_CHECKED"])
  return false unless security_code_response_validator.valid?(@security_code_response)
  return false if !@merchant_advice_code_indicator.nil? && @merchant_advice_code_indicator !~ Regexp.new(/[0-9]{2}/)
  true
end