Class: CityPayApiClient::TokenisationResponseModel

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TokenisationResponseModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#authen_result ⇒ Object

The result of any authentication using 3d_secure authorisation against ecommerce transactions. Values are: <table> <tr> <th>Value</th> <th>Description</th> </tr> <tr> <td>Y</td> <td>Authentication Successful. The Cardholder’s password was successfully validated.</td> </tr> <tr> <td>N</td> <td>Authentication Failed. Customer failed or cancelled authentication, transaction denied.</td> </tr> <tr> <td>A</td> <td>Attempts Processing Performed Authentication could not be completed but a proof of authentication attempt (CAVV) was generated.</td> </tr> <tr> <td>U</td> <td>Authentication Could Not Be Performed Authentication could not be completed, due to technical or other problem.</td> </tr> </table>



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

def authen_result
  @authen_result
end

#bin_commercial ⇒ Object

Determines whether the bin range was found to be a commercial or business card.



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

def bin_commercial
  @bin_commercial
end

#bin_debit ⇒ Object

Determines whether the bin range was found to be a debit card. If false the card was considered as a credit card.



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

def bin_debit
  @bin_debit
end

#bin_description ⇒ Object

A description of the bin range found for the card.



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

def bin_description
  @bin_description
end

#eci ⇒ Object

An Electronic Commerce Indicator (ECI) used to identify the result of authentication using 3DSecure.



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

def eci
  @eci
end

#identifier ⇒ Object

The identifier provided within the request.



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

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.



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

def maskedpan
  @maskedpan
end

#scheme ⇒ Object

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



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

def scheme
  @scheme
end

#sig_id ⇒ Object

A Base58 encoded SHA-256 digest generated from the token value Base58 decoded and appended with the nonce value UTF-8 decoded.



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

def sig_id
  @sig_id
end

#token ⇒ Object

The token used for presentment to authorisation later in the processing flow.



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

def token
  @token
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



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
276
277
278
279
280
281
282
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 245

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



64
65
66
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'authen_result' => :'authen_result',
    :'bin_commercial' => :'bin_commercial',
    :'bin_debit' => :'bin_debit',
    :'bin_description' => :'bin_description',
    :'eci' => :'eci',
    :'identifier' => :'identifier',
    :'maskedpan' => :'maskedpan',
    :'scheme' => :'scheme',
    :'sig_id' => :'sig_id',
    :'token' => :'token'
  }
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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 221

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



85
86
87
88
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 85

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

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 69

def self.openapi_types
  {
    :'authen_result' => :'String',
    :'bin_commercial' => :'Boolean',
    :'bin_debit' => :'Boolean',
    :'bin_description' => :'String',
    :'eci' => :'String',
    :'identifier' => :'String',
    :'maskedpan' => :'String',
    :'scheme' => :'String',
    :'sig_id' => :'String',
    :'token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authen_result == o.authen_result &&
      bin_commercial == o.bin_commercial &&
      bin_debit == o.bin_debit &&
      bin_description == o.bin_description &&
      eci == o.eci &&
      identifier == o.identifier &&
      maskedpan == o.maskedpan &&
      scheme == o.scheme &&
      sig_id == o.sig_id &&
      token == o.token
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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 316

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


208
209
210
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



214
215
216
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 214

def hash
  [authen_result, bin_commercial, bin_debit, bin_description, eci, identifier, maskedpan, scheme, sig_id, token].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



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 148

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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

  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



292
293
294
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 292

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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 298

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



286
287
288
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 286

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



164
165
166
167
168
169
 
# File 'lib/citypay_api_client/models/tokenisation_response_model.rb', line 164

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