Class: CityPayApiClient::AuthReference

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthReference

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The amount of the transaction in decimal currency format.



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

def amount
  @amount
end

#amount_value ⇒ Object

The amount of the transaction in integer/request format.



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

def amount_value
  @amount_value
end

#atrn ⇒ Object

A reference number provided by the acquiring services.



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

def atrn
  @atrn
end

#authcode ⇒ Object

The authorisation code of the transaction returned by the acquirer or card issuer.



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

def authcode
  @authcode
end

#batchno ⇒ Object

A batch number which the transaction has been end of day batched towards.



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

def batchno
  @batchno
end

#currency ⇒ Object

The currency of the transaction in ISO 4217 code format.



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

def currency
  @currency
end

#datetime ⇒ Object

The date and time of the transaction.



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

def datetime
  @datetime
end

#identifier ⇒ Object

The identifier of the transaction used to process the transaction.



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

def identifier
  @identifier
end

#maskedpan ⇒ Object

A masking of the card number which was used to process the tranasction.



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

def maskedpan
  @maskedpan
end

#merchantid ⇒ Object

The merchant id of the transaction result.



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

def merchantid
  @merchantid
end

#result ⇒ Object

The result of the transaction.



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

def result
  @result
end

#trans_status ⇒ Object

The current status of the transaction through it’s lifecycle.



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

def trans_status
  @trans_status
end

#trans_type ⇒ Object

The type of transaction that was processed.



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

def trans_type
  @trans_type
end

#transno ⇒ Object

The transaction number of the transaction.



57
58
59
 
# File 'lib/citypay_api_client/models/auth_reference.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



361
362
363
364
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
 
# File 'lib/citypay_api_client/models/auth_reference.rb', line 361

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/auth_reference.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/auth_reference.rb', line 60

def self.attribute_map
  {
    :'amount' => :'amount',
    :'amount_value' => :'amount_value',
    :'atrn' => :'atrn',
    :'authcode' => :'authcode',
    :'batchno' => :'batchno',
    :'currency' => :'currency',
    :'datetime' => :'datetime',
    :'identifier' => :'identifier',
    :'maskedpan' => :'maskedpan',
    :'merchantid' => :'merchantid',
    :'result' => :'result',
    :'trans_status' => :'trans_status',
    :'trans_type' => :'trans_type',
    :'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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/citypay_api_client/models/auth_reference.rb', line 337

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/auth_reference.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/auth_reference.rb', line 85

def self.openapi_types
  {
    :'amount' => :'String',
    :'amount_value' => :'Integer',
    :'atrn' => :'String',
    :'authcode' => :'String',
    :'batchno' => :'String',
    :'currency' => :'String',
    :'datetime' => :'Time',
    :'identifier' => :'String',
    :'maskedpan' => :'String',
    :'merchantid' => :'Integer',
    :'result' => :'String',
    :'trans_status' => :'String',
    :'trans_type' => :'String',
    :'transno' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/citypay_api_client/models/auth_reference.rb', line 303

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      amount_value == o.amount_value &&
      atrn == o.atrn &&
      authcode == o.authcode &&
      batchno == o.batchno &&
      currency == o.currency &&
      datetime == o.datetime &&
      identifier == o.identifier &&
      maskedpan == o.maskedpan &&
      merchantid == o.merchantid &&
      result == o.result &&
      trans_status == o.trans_status &&
      trans_type == o.trans_type &&
      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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/citypay_api_client/models/auth_reference.rb', line 432

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


324
325
326
 
# File 'lib/citypay_api_client/models/auth_reference.rb', line 324

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



330
331
332
 
# File 'lib/citypay_api_client/models/auth_reference.rb', line 330

def hash
  [amount, amount_value, atrn, authcode, batchno, currency, datetime, identifier, maskedpan, merchantid, result, trans_status, trans_type, 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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@amount.nil? && @amount.to_s.length > 10
    invalid_properties.push('invalid value for "amount", the character length must be smaller than or equal to 10.')
  end

  if !@currency.nil? && @currency.to_s.length > 3
    invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
  end

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

  if !@identifier.nil? && @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.nil? && @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 !@trans_type.nil? && @trans_type.to_s.length > 1
    invalid_properties.push('invalid value for "trans_type", the character length must be smaller than or equal to 1.')
  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



408
409
410
 
# File 'lib/citypay_api_client/models/auth_reference.rb', line 408

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/citypay_api_client/models/auth_reference.rb', line 414

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



402
403
404
 
# File 'lib/citypay_api_client/models/auth_reference.rb', line 402

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



216
217
218
219
220
221
222
223
224
225
 
# File 'lib/citypay_api_client/models/auth_reference.rb', line 216

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@amount.nil? && @amount.to_s.length > 10
  return false if !@currency.nil? && @currency.to_s.length > 3
  return false if !@currency.nil? && @currency.to_s.length < 3
  return false if !@identifier.nil? && @identifier.to_s.length > 50
  return false if !@identifier.nil? && @identifier.to_s.length < 4
  return false if !@trans_type.nil? && @trans_type.to_s.length > 1
  true
end