Class: CityPayApiClient::BatchTransactionResultModel

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/models/batch_transaction_result_model.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchTransactionResultModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 112

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

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

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

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

  if attributes.key?(:'identifier')
    self.identifier = attributes[:'identifier']
  else
    self.identifier = nil
  end

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

  if attributes.key?(:'merchantid')
    self.merchantid = attributes[:'merchantid']
  else
    self.merchantid = nil
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  else
    self.message = nil
  end

  if attributes.key?(:'result')
    self.result = attributes[:'result']
  else
    self.result = nil
  end

  if attributes.key?(:'result_code')
    self.result_code = attributes[:'result_code']
  else
    self.result_code = nil
  end

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The card holder account id used for the transaction.



18
19
20
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 18

def 
  @account_id
end

#amount ⇒ Object

The amount of the transaction processed.



21
22
23
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 21

def amount
  @amount
end

#authcode ⇒ Object

The authorisation code of a successful transaction.



24
25
26
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 24

def authcode
  @authcode
end

#datetime ⇒ Object

The datetime that the transaction was processed.



27
28
29
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 27

def datetime
  @datetime
end

#identifier ⇒ Object

The identifier of the transaction.



30
31
32
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 30

def identifier
  @identifier
end

#maskedpan ⇒ Object

A masked value of the card number used for processing displaying limited values that can be used on a receipt.



33
34
35
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 33

def maskedpan
  @maskedpan
end

#merchantid ⇒ Object

The merchant id of the transaction.



36
37
38
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 36

def merchantid
  @merchantid
end

#message ⇒ Object

A response message pertaining to the transaction.



39
40
41
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 39

def message
  @message
end

#result ⇒ Object

An integer result that indicates the outcome of the transaction. The Code value below maps to the result value <table> <tr> <th>Code</th> <th>Abbrev</th> <th>Description</th> </tr> <tr><td>0</td><td>Declined</td><td>Declined</td></tr> <tr><td>1</td><td>Accepted</td><td>Accepted</td></tr> <tr><td>2</td><td>Rejected</td><td>Rejected</td></tr> <tr><td>3</td><td>Not Attempted</td><td>Not Attempted</td></tr> <tr><td>4</td><td>Referred</td><td>Referred</td></tr> <tr><td>5</td><td>PinRetry</td><td>Perform PIN Retry</td></tr> <tr><td>6</td><td>ForSigVer</td><td>Force Signature Verification</td></tr> <tr><td>7</td><td>Hold</td><td>Hold</td></tr> <tr><td>8</td><td>SecErr</td><td>Security Error</td></tr> <tr><td>9</td><td>CallAcq</td><td>Call Acquirer</td></tr> <tr><td>10</td><td>DNH</td><td>Do Not Honour</td></tr> <tr><td>11</td><td>RtnCrd</td><td>Retain Card</td></tr> <tr><td>12</td><td>ExprdCrd</td><td>Expired Card</td></tr> <tr><td>13</td><td>InvldCrd</td><td>Invalid Card No</td></tr> <tr><td>14</td><td>PinExcd</td><td>Pin Tries Exceeded</td></tr> <tr><td>15</td><td>PinInvld</td><td>Pin Invalid</td></tr> <tr><td>16</td><td>AuthReq</td><td>Authentication Required</td></tr> <tr><td>17</td><td>AuthenFail</td><td>Authentication Failed</td></tr> <tr><td>18</td><td>Verified</td><td>Card Verified</td></tr> <tr><td>19</td><td>Cancelled</td><td>Cancelled</td></tr> <tr><td>20</td><td>Un</td><td>Unknown</td></tr> <tr><td>21</td><td>Challenged</td><td>Challenged</td></tr> <tr><td>22</td><td>Decoupled</td><td>Decoupled</td></tr> <tr><td>23</td><td>Denied</td><td>Permission Denied</td></tr> </table>



42
43
44
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 42

def result
  @result
end

#result_code ⇒ Object

A result code of the transaction identifying the result of the transaction for success, rejection or decline.



45
46
47
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 45

def result_code
  @result_code
end

#scheme ⇒ Object

The name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.



48
49
50
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 48

def scheme
  @scheme
end

#scheme_id ⇒ Object

The name of the card scheme of the transaction such as VI or MC.



51
52
53
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 51

def scheme_id
  @scheme_id
end

#scheme_logo ⇒ Object

A url containing a logo of the card scheme.



54
55
56
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 54

def 
  @scheme_logo
end

#transno ⇒ Object

The resulting transaction number, ordered incrementally from 1 for every merchant_id. The value will default to less than 1 for transactions that do not have a transaction number issued.



57
58
59
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 57

def transno
  @transno
end

Class Method Details

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



365
366
367
368
369
370
371
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
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 365

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = CityPayApiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 60

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'amount' => :'amount',
    :'authcode' => :'authcode',
    :'datetime' => :'datetime',
    :'identifier' => :'identifier',
    :'maskedpan' => :'maskedpan',
    :'merchantid' => :'merchantid',
    :'message' => :'message',
    :'result' => :'result',
    :'result_code' => :'result_code',
    :'scheme' => :'scheme',
    :'scheme_id' => :'scheme_id',
    :'scheme_logo' => :'scheme_logo',
    :'transno' => :'transno'
  }
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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 341

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



105
106
107
108
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 105

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 85

def self.openapi_types
  {
    :'account_id' => :'String',
    :'amount' => :'Integer',
    :'authcode' => :'String',
    :'datetime' => :'Time',
    :'identifier' => :'String',
    :'maskedpan' => :'String',
    :'merchantid' => :'Integer',
    :'message' => :'String',
    :'result' => :'Integer',
    :'result_code' => :'String',
    :'scheme' => :'String',
    :'scheme_id' => :'String',
    :'scheme_logo' => :'String',
    :'transno' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 307

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      amount == o.amount &&
      authcode == o.authcode &&
      datetime == o.datetime &&
      identifier == o.identifier &&
      maskedpan == o.maskedpan &&
      merchantid == o.merchantid &&
      message == o.message &&
      result == o.result &&
      result_code == o.result_code &&
      scheme == o.scheme &&
      scheme_id == o.scheme_id &&
       == o. &&
      transno == o.transno
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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 436

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


328
329
330
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 328

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



334
335
336
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 334

def hash
  [, amount, authcode, datetime, identifier, maskedpan, merchantid, message, result, result_code, scheme, scheme_id, , transno].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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 196

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  if @account_id.to_s.length > 50
    invalid_properties.push('invalid value for "account_id", the character length must be smaller than or equal to 50.')
  end

  if @account_id.to_s.length < 5
    invalid_properties.push('invalid value for "account_id", the character length must be great than or equal to 5.')
  end

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

  if @identifier.to_s.length > 50
    invalid_properties.push('invalid value for "identifier", the character length must be smaller than or equal to 50.')
  end

  if @identifier.to_s.length < 4
    invalid_properties.push('invalid value for "identifier", the character length must be great than or equal to 4.')
  end

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

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

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

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



412
413
414
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 412

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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 418

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



406
407
408
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 406

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/citypay_api_client/models/batch_transaction_result_model.rb', line 244

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  return false if @account_id.to_s.length > 50
  return false if @account_id.to_s.length < 5
  return false if @identifier.nil?
  return false if @identifier.to_s.length > 50
  return false if @identifier.to_s.length < 4
  return false if @merchantid.nil?
  return false if @message.nil?
  return false if @result.nil?
  return false if @result_code.nil?
  true
end