Class: CityPayApiClient::Card

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Card

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
193
194
195
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
 
# File 'lib/citypay_api_client/models/card.rb', line 142

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

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

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

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

  if attributes.key?(:'bin_currency')
    self.bin_currency = attributes[:'bin_currency']
  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?(:'bin_eu')
    self.bin_eu = attributes[:'bin_eu']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bin_commercial ⇒ Object

Defines whether the card is a commercial card.



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

def bin_commercial
  @bin_commercial
end

#bin_corporate ⇒ Object

Defines whether the card is a corporate business card.



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

def bin_corporate
  @bin_corporate
end

#bin_country_issued ⇒ Object

The determined country where the card was issued.



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

def bin_country_issued
  @bin_country_issued
end

#bin_credit ⇒ Object

Defines whether the card is a credit card.



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

def bin_credit
  @bin_credit
end

#bin_currency ⇒ Object

The default currency determined for the card.



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

def bin_currency
  @bin_currency
end

#bin_debit ⇒ Object

Defines whether the card is a debit card.



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

def bin_debit
  @bin_debit
end

#bin_description ⇒ Object

A description of the bin on the card to identify what type of product the card is.



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

def bin_description
  @bin_description
end

#bin_eu ⇒ Object

Defines whether the card is regulated within the EU.



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

def bin_eu
  @bin_eu
end

#card_id ⇒ Object

The id of the card that is returned. Should be used for referencing the card when perform any changes.



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

def card_id
  @card_id
end

#card_status ⇒ Object

The status of the card such, valid values are - ACTIVE the card is active for processing - INACTIVE the card is not active for processing - EXPIRED for cards that have passed their expiry date.



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

def card_status
  @card_status
end

#date_created ⇒ Object

The date time of when the card was created.



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

def date_created
  @date_created
end

#default ⇒ Object

Determines if the card is the default card for the account and should be regarded as the first option to be used for processing.



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

def default
  @default
end

#expmonth ⇒ Object

The expiry month of the card.



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

def expmonth
  @expmonth
end

#expyear ⇒ Object

The expiry year of the card.



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

def expyear
  @expyear
end

#label ⇒ Object

A label which identifies this card.



60
61
62
 
# File 'lib/citypay_api_client/models/card.rb', line 60

def label
  @label
end

#label2 ⇒ Object

A label which also provides the expiry date of the card.



63
64
65
 
# File 'lib/citypay_api_client/models/card.rb', line 63

def label2
  @label2
end

#last4digits ⇒ Object

The last 4 digits of the card to aid in identification.



66
67
68
 
# File 'lib/citypay_api_client/models/card.rb', line 66

def last4digits
  @last4digits
end

#name_on_card ⇒ Object

The name on the card.



69
70
71
 
# File 'lib/citypay_api_client/models/card.rb', line 69

def name_on_card
  @name_on_card
end

#scheme ⇒ Object

The scheme that issued the card.



72
73
74
 
# File 'lib/citypay_api_client/models/card.rb', line 72

def scheme
  @scheme
end

#token ⇒ Object

A token that can be used to process against the card.



75
76
77
 
# File 'lib/citypay_api_client/models/card.rb', line 75

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



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/citypay_api_client/models/card.rb', line 401

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



104
105
106
 
# File 'lib/citypay_api_client/models/card.rb', line 104

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/citypay_api_client/models/card.rb', line 78

def self.attribute_map
  {
    :'bin_commercial' => :'bin_commercial',
    :'bin_corporate' => :'bin_corporate',
    :'bin_country_issued' => :'bin_country_issued',
    :'bin_credit' => :'bin_credit',
    :'bin_currency' => :'bin_currency',
    :'bin_debit' => :'bin_debit',
    :'bin_description' => :'bin_description',
    :'bin_eu' => :'bin_eu',
    :'card_id' => :'card_id',
    :'card_status' => :'card_status',
    :'date_created' => :'date_created',
    :'default' => :'default',
    :'expmonth' => :'expmonth',
    :'expyear' => :'expyear',
    :'label' => :'label',
    :'label2' => :'label2',
    :'last4digits' => :'last4digits',
    :'name_on_card' => :'name_on_card',
    :'scheme' => :'scheme',
    :'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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/citypay_api_client/models/card.rb', line 377

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



135
136
137
138
 
# File 'lib/citypay_api_client/models/card.rb', line 135

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

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/citypay_api_client/models/card.rb', line 109

def self.openapi_types
  {
    :'bin_commercial' => :'Boolean',
    :'bin_corporate' => :'Boolean',
    :'bin_country_issued' => :'String',
    :'bin_credit' => :'Boolean',
    :'bin_currency' => :'String',
    :'bin_debit' => :'Boolean',
    :'bin_description' => :'String',
    :'bin_eu' => :'Boolean',
    :'card_id' => :'String',
    :'card_status' => :'String',
    :'date_created' => :'Time',
    :'default' => :'Boolean',
    :'expmonth' => :'Integer',
    :'expyear' => :'Integer',
    :'label' => :'String',
    :'label2' => :'String',
    :'last4digits' => :'String',
    :'name_on_card' => :'String',
    :'scheme' => :'String',
    :'token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bin_commercial == o.bin_commercial &&
      bin_corporate == o.bin_corporate &&
      bin_country_issued == o.bin_country_issued &&
      bin_credit == o.bin_credit &&
      bin_currency == o.bin_currency &&
      bin_debit == o.bin_debit &&
      bin_description == o.bin_description &&
      bin_eu == o.bin_eu &&
      card_id == o.card_id &&
      card_status == o.card_status &&
      date_created == o.date_created &&
      default == o.default &&
      expmonth == o.expmonth &&
      expyear == o.expyear &&
      label == o.label &&
      label2 == o.label2 &&
      last4digits == o.last4digits &&
      name_on_card == o.name_on_card &&
      scheme == o.scheme &&
      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



472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/citypay_api_client/models/card.rb', line 472

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


364
365
366
 
# File 'lib/citypay_api_client/models/card.rb', line 364

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



370
371
372
 
# File 'lib/citypay_api_client/models/card.rb', line 370

def hash
  [bin_commercial, bin_corporate, bin_country_issued, bin_credit, bin_currency, bin_debit, bin_description, bin_eu, card_id, card_status, date_created, default, expmonth, expyear, label, label2, last4digits, name_on_card, scheme, 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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/citypay_api_client/models/card.rb', line 238

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

  if !@expmonth.nil? && @expmonth < 1
    invalid_properties.push('invalid value for "expmonth", must be greater than or equal to 1.')
  end

  if !@expyear.nil? && @expyear > 2100
    invalid_properties.push('invalid value for "expyear", must be smaller than or equal to 2100.')
  end

  if !@expyear.nil? && @expyear < 2000
    invalid_properties.push('invalid value for "expyear", must be greater than or equal to 2000.')
  end

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

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



448
449
450
 
# File 'lib/citypay_api_client/models/card.rb', line 448

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



454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/citypay_api_client/models/card.rb', line 454

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



442
443
444
 
# File 'lib/citypay_api_client/models/card.rb', line 442

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



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/citypay_api_client/models/card.rb', line 270

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@expmonth.nil? && @expmonth > 12
  return false if !@expmonth.nil? && @expmonth < 1
  return false if !@expyear.nil? && @expyear > 2100
  return false if !@expyear.nil? && @expyear < 2000
  return false if !@name_on_card.nil? && @name_on_card.to_s.length > 45
  return false if !@name_on_card.nil? && @name_on_card.to_s.length < 2
  true
end