Class: OpenapiClient::PaymentDevice

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

Overview

Information from the payment device including the blob data and its mode of entry.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentDevice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
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
 
# File 'lib/openapi_client/models/payment_device.rb', line 83

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

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

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

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

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

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

Instance Attribute Details

#brand ⇒ Object

The card brand.



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

def brand
  @brand
end

#card_function ⇒ Object

Returns the value of attribute card_function.



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

def card_function
  @card_function
end

#cardholder_name ⇒ Object

Name of cardholder.



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

def cardholder_name
  @cardholder_name
end

#data ⇒ Object

Data from device containing, at a minimum, a transaction-unique key serial number (KSN) and track 2 card data.



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

def data
  @data
end

#device_type ⇒ Object

The data format.



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

def device_type
  @device_type
end

#security_code ⇒ Object

Card verification value/number.



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

def security_code
  @security_code
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/openapi_client/models/payment_device.rb', line 58

def self.attribute_map
  {
    :'device_type' => :'deviceType',
    :'data' => :'data',
    :'security_code' => :'securityCode',
    :'cardholder_name' => :'cardholderName',
    :'card_function' => :'cardFunction',
    :'brand' => :'brand'
  }
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



229
230
231
 
# File 'lib/openapi_client/models/payment_device.rb', line 229

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/openapi_client/models/payment_device.rb', line 70

def self.openapi_types
  {
    :'device_type' => :'String',
    :'data' => :'String',
    :'security_code' => :'String',
    :'cardholder_name' => :'String',
    :'card_function' => :'CardFunction',
    :'brand' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/openapi_client/models/payment_device.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      device_type == o.device_type &&
      data == o.data &&
      security_code == o.security_code &&
      cardholder_name == o.cardholder_name &&
      card_function == o.card_function &&
      brand == o.brand
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



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
293
294
295
296
297
 
# File 'lib/openapi_client/models/payment_device.rb', line 257

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/openapi_client/models/payment_device.rb', line 331

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/openapi_client/models/payment_device.rb', line 236

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


216
217
218
 
# File 'lib/openapi_client/models/payment_device.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



222
223
224
 
# File 'lib/openapi_client/models/payment_device.rb', line 222

def hash
  [device_type, data, security_code, cardholder_name, card_function, brand].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



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
 
# File 'lib/openapi_client/models/payment_device.rb', line 123

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

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

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @data !~ pattern
    invalid_properties.push("invalid value for \"data\", must conform to the pattern #{pattern}.")
  end

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

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



307
308
309
 
# File 'lib/openapi_client/models/payment_device.rb', line 307

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/openapi_client/models/payment_device.rb', line 313

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



301
302
303
 
# File 'lib/openapi_client/models/payment_device.rb', line 301

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



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/openapi_client/models/payment_device.rb', line 151

def valid?
  return false if @device_type.nil?
  device_type_validator = EnumAttributeValidator.new('String', ["SWIPE"])
  return false unless device_type_validator.valid?(@device_type)
  return false if @data.nil?
  return false if @data !~ Regexp.new(/^(?!\s*$).+/)
  return false if !@security_code.nil? && @security_code.to_s.length > 4
  return false if !@security_code.nil? && @security_code.to_s.length < 3
  true
end