Class: SyncteraRubySdk::PhysicalCard

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/models/physical_card.rb

Overview

Details pertaining to issuing a new physical card

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PhysicalCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
235
236
237
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
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 169

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'is_pin_set')
    self.is_pin_set = attributes[:'is_pin_set']
  else
    self.is_pin_set = false
  end

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

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

  if attributes.key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the account to which the card will be linked



23
24
25
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 23

def 
  @account_id
end

#card_image_id ⇒ Object

The ID of the custom card image used for this card



70
71
72
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 70

def card_image_id
  @card_image_id
end

#card_product_id ⇒ Object

The card product to which the card is attached



26
27
28
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 26

def card_product_id
  @card_product_id
end

#creation_time ⇒ Object

The timestamp representing when the card issuance request was made



29
30
31
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 29

def creation_time
  @creation_time
end

#customer_id ⇒ Object

The ID of the customer to whom the card will be issued



32
33
34
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 32

def customer_id
  @customer_id
end

#emboss_name ⇒ Object

Returns the value of attribute emboss_name.



34
35
36
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 34

def emboss_name
  @emboss_name
end

#expiration_month ⇒ Object

Returns the value of attribute expiration_month.



36
37
38
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 36

def expiration_month
  @expiration_month
end

#expiration_time ⇒ Object

The timestamp representing when the card would expire at



39
40
41
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 39

def expiration_time
  @expiration_time
end

#expiration_year ⇒ Object

Returns the value of attribute expiration_year.



41
42
43
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 41

def expiration_year
  @expiration_year
end

#form ⇒ Object

PHYSICAL or VIRTUAL.



20
21
22
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 20

def form
  @form
end

#id ⇒ Object

Card ID



44
45
46
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 44

def id
  @id
end

#is_pin_set ⇒ Object

indicates whether a pin has been set on the card



47
48
49
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 47

def is_pin_set
  @is_pin_set
end

#last_four ⇒ Object

The last 4 digits of the card PAN



50
51
52
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 50

def last_four
  @last_four
end

#last_modified_time ⇒ Object

The timestamp representing when the card was last modified at



53
54
55
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 53

def last_modified_time
  @last_modified_time
end

#metadata ⇒ Object

Additional data to include in the request structured as key-value pairs



56
57
58
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 56

def metadata
  @metadata
end

#reissue_reason ⇒ Object

This is the reason the card needs to be reissued, if any. The reason determines several behaviours: - whether or not the new card will use the same PAN as the original card - the old card will be terminated and if so, when it will be terminated Reason | Same PAN | Terminate Old Card ———————- | ——– | —————— EXPIRATION | yes | on activation LOST | no | immediately STOLEN | no | immediately DAMAGED | yes | on activation VIRTUAL_TO_PHYSICAL(*) | yes | on activation PRODUCT_CHANGE | yes | on activation NAME_CHANGE(**) | yes | on activation APPEARANCE | yes | on activation (*) VIRTUAL_TO_PHYSICAL is deprecated. Please use PRODUCT_CHANGE whenever reissuing from one card product to another, including from a virtual product to a physical product. (**) NAME_CHANGE is deprecated. Please use APPEARANCE whenever reissuing in order to change the appearance of a card, such as the printed name or custom image. For all reasons, the new card will use the same PIN as the original card and digital wallet tokens will reassigned to the new card



59
60
61
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 59

def reissue_reason
  @reissue_reason
end

#reissued_from_id ⇒ Object

When reissuing a card, specify the card to be replaced here. When getting a card’s details, if this card was issued as a reissuance of another card, this ID refers to the card was replaced. If this field is set, then reissue_reason must also be set.



62
63
64
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 62

def reissued_from_id
  @reissued_from_id
end

#reissued_to_id ⇒ Object

If this card was reissued, this ID refers to the card that replaced it.



65
66
67
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 65

def reissued_to_id
  @reissued_to_id
end

#shipping ⇒ Object

Returns the value of attribute shipping.



72
73
74
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 72

def shipping
  @shipping
end

#type ⇒ Object

Returns the value of attribute type.



67
68
69
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 67

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



123
124
125
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 123

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 97

def self.attribute_map
  {
    :'form' => :'form',
    :'account_id' => :'account_id',
    :'card_product_id' => :'card_product_id',
    :'creation_time' => :'creation_time',
    :'customer_id' => :'customer_id',
    :'emboss_name' => :'emboss_name',
    :'expiration_month' => :'expiration_month',
    :'expiration_time' => :'expiration_time',
    :'expiration_year' => :'expiration_year',
    :'id' => :'id',
    :'is_pin_set' => :'is_pin_set',
    :'last_four' => :'last_four',
    :'last_modified_time' => :'last_modified_time',
    :'metadata' => :'metadata',
    :'reissue_reason' => :'reissue_reason',
    :'reissued_from_id' => :'reissued_from_id',
    :'reissued_to_id' => :'reissued_to_id',
    :'type' => :'type',
    :'card_image_id' => :'card_image_id',
    :'shipping' => :'shipping'
  }
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



351
352
353
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 351

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



160
161
162
163
164
165
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 160

def self.openapi_all_of
  [
  :'BaseCard',
  :'PhysicalCardAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



154
155
156
157
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 154

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

.openapi_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 128

def self.openapi_types
  {
    :'form' => :'String',
    :'account_id' => :'String',
    :'card_product_id' => :'String',
    :'creation_time' => :'Time',
    :'customer_id' => :'String',
    :'emboss_name' => :'EmbossName',
    :'expiration_month' => :'String',
    :'expiration_time' => :'Time',
    :'expiration_year' => :'String',
    :'id' => :'String',
    :'is_pin_set' => :'Boolean',
    :'last_four' => :'String',
    :'last_modified_time' => :'Time',
    :'metadata' => :'Hash<String, String>',
    :'reissue_reason' => :'String',
    :'reissued_from_id' => :'String',
    :'reissued_to_id' => :'String',
    :'type' => :'CardType',
    :'card_image_id' => :'String',
    :'shipping' => :'Shipping'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 311

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      form == o.form &&
       == o. &&
      card_product_id == o.card_product_id &&
      creation_time == o.creation_time &&
      customer_id == o.customer_id &&
      emboss_name == o.emboss_name &&
      expiration_month == o.expiration_month &&
      expiration_time == o.expiration_time &&
      expiration_year == o.expiration_year &&
      id == o.id &&
      is_pin_set == o.is_pin_set &&
      last_four == o.last_four &&
      last_modified_time == o.last_modified_time &&
      metadata == o.metadata &&
      reissue_reason == o.reissue_reason &&
      reissued_from_id == o.reissued_from_id &&
      reissued_to_id == o.reissued_to_id &&
      type == o.type &&
      card_image_id == o.card_image_id &&
      shipping == o.shipping
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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 382

def _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 = SyncteraRubySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : 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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 453

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 358

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


338
339
340
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 338

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



344
345
346
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 344

def hash
  [form, , card_product_id, creation_time, customer_id, emboss_name, expiration_month, expiration_time, expiration_year, id, is_pin_set, last_four, last_modified_time, metadata, reissue_reason, reissued_from_id, reissued_to_id, type, card_image_id, shipping].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



269
270
271
272
273
274
275
276
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 269

def list_invalid_properties
  invalid_properties = Array.new
  if @form.nil?
    invalid_properties.push('invalid value for "form", form 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



429
430
431
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 429

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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 435

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



423
424
425
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 423

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



280
281
282
283
284
285
286
287
 
# File 'lib/synctera_ruby_sdk/models/physical_card.rb', line 280

def valid?
  return false if @form.nil?
  form_validator = EnumAttributeValidator.new('String', ["PHYSICAL", "VIRTUAL"])
  return false unless form_validator.valid?(@form)
  reissue_reason_validator = EnumAttributeValidator.new('String', ["EXPIRATION", "LOST", "STOLEN", "DAMAGED", "NAME_CHANGE", "VIRTUAL_TO_PHYSICAL", "PRODUCT_CHANGE", "APPEARANCE"])
  return false unless reissue_reason_validator.valid?(@reissue_reason)
  true
end