Class: SyncteraRubySdk::CardProduct

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

Overview

Card Product

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CardProduct

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 168

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'txn_enhancer')
    self.txn_enhancer = attributes[:'txn_enhancer']
  else
    self.txn_enhancer = 'NONE'
  end
end

Instance Attribute Details

#active ⇒ Object

Indicates whether the Card Product is active



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

def active
  @active
end

#card_program_id ⇒ Object

Card Program ID



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

def card_program_id
  @card_program_id
end

#color ⇒ Object

Color code for dynamic card elements such as PAN and card holder name



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

def color
  @color
end

#creation_time ⇒ Object

The timestamp representing when the Card Product was created



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

def creation_time
  @creation_time
end

#digital_wallet_tokenization ⇒ Object

Returns the value of attribute digital_wallet_tokenization.



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

def digital_wallet_tokenization
  @digital_wallet_tokenization
end

#end_date ⇒ Object

The time when the Card Product is decommissioned



37
38
39
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 37

def end_date
  @end_date
end

#form ⇒ Object

PHYSICAL or VIRTUAL.



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

def form
  @form
end

#id ⇒ Object

Card Product ID



40
41
42
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 40

def id
  @id
end

#image ⇒ Object

Indicates whether or not there is an overlay image of the card product available



43
44
45
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 43

def image
  @image
end

#image_mode ⇒ Object

Returns the value of attribute image_mode.



45
46
47
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 45

def image_mode
  @image_mode
end

#issue_without_kyc ⇒ Object

Allow issuing cards on this product without requiring KYC



48
49
50
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 48

def issue_without_kyc
  @issue_without_kyc
end

#last_modified_time ⇒ Object

The timestamp representing when the Card Product was last modified



51
52
53
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 51

def last_modified_time
  @last_modified_time
end

#name ⇒ Object

The name of the Card Product



54
55
56
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 54

def name
  @name
end

#orientation ⇒ Object

Card orientation



57
58
59
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 57

def orientation
  @orientation
end

#package_id ⇒ Object

Card fulfillment provider’s package ID



60
61
62
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 60

def package_id
  @package_id
end

#physical_card_format ⇒ Object

Returns the value of attribute physical_card_format.



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

def physical_card_format
  @physical_card_format
end

#return_address ⇒ Object

Returns the value of attribute return_address.



64
65
66
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 64

def return_address
  @return_address
end

#start_date ⇒ Object

The time when the Card Product goes live



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

def start_date
  @start_date
end

#three_ds_policy ⇒ Object

Returns the value of attribute three_ds_policy.



69
70
71
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 69

def three_ds_policy
  @three_ds_policy
end

#txn_enhancer ⇒ Object

Returns the value of attribute txn_enhancer.



71
72
73
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 71

def txn_enhancer
  @txn_enhancer
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



122
123
124
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 122

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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/synctera_ruby_sdk/models/card_product.rb', line 96

def self.attribute_map
  {
    :'form' => :'form',
    :'active' => :'active',
    :'card_program_id' => :'card_program_id',
    :'color' => :'color',
    :'creation_time' => :'creation_time',
    :'digital_wallet_tokenization' => :'digital_wallet_tokenization',
    :'end_date' => :'end_date',
    :'id' => :'id',
    :'image' => :'image',
    :'image_mode' => :'image_mode',
    :'issue_without_kyc' => :'issue_without_kyc',
    :'last_modified_time' => :'last_modified_time',
    :'name' => :'name',
    :'orientation' => :'orientation',
    :'package_id' => :'package_id',
    :'physical_card_format' => :'physical_card_format',
    :'return_address' => :'return_address',
    :'start_date' => :'start_date',
    :'three_ds_policy' => :'three_ds_policy',
    :'txn_enhancer' => :'txn_enhancer'
  }
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



437
438
439
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 437

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

def self.openapi_all_of
  [
  :'CardFormat',
  :'CardProductAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



153
154
155
156
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 153

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'form' => :'String',
    :'active' => :'Boolean',
    :'card_program_id' => :'String',
    :'color' => :'String',
    :'creation_time' => :'Time',
    :'digital_wallet_tokenization' => :'DigitalWalletTokenization',
    :'end_date' => :'Time',
    :'id' => :'String',
    :'image' => :'Boolean',
    :'image_mode' => :'CardImageMode',
    :'issue_without_kyc' => :'Boolean',
    :'last_modified_time' => :'Time',
    :'name' => :'String',
    :'orientation' => :'String',
    :'package_id' => :'String',
    :'physical_card_format' => :'PhysicalCardFormat',
    :'return_address' => :'Shipping',
    :'start_date' => :'Time',
    :'three_ds_policy' => :'ThreeDsPolicy',
    :'txn_enhancer' => :'TxnEnhancer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 397

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      form == o.form &&
      active == o.active &&
      card_program_id == o.card_program_id &&
      color == o.color &&
      creation_time == o.creation_time &&
      digital_wallet_tokenization == o.digital_wallet_tokenization &&
      end_date == o.end_date &&
      id == o.id &&
      image == o.image &&
      image_mode == o.image_mode &&
      issue_without_kyc == o.issue_without_kyc &&
      last_modified_time == o.last_modified_time &&
      name == o.name &&
      orientation == o.orientation &&
      package_id == o.package_id &&
      physical_card_format == o.physical_card_format &&
      return_address == o.return_address &&
      start_date == o.start_date &&
      three_ds_policy == o.three_ds_policy &&
      txn_enhancer == o.txn_enhancer
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



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 468

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



539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 539

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



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 444

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


424
425
426
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 424

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



430
431
432
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 430

def hash
  [form, active, card_program_id, color, creation_time, digital_wallet_tokenization, end_date, id, image, image_mode, issue_without_kyc, last_modified_time, name, orientation, package_id, physical_card_format, return_address, start_date, three_ds_policy, txn_enhancer].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



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
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 266

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

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

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

  pattern = Regexp.new(/^[0-9A-F]{6}$/)
  if !@color.nil? && @color !~ pattern
    invalid_properties.push("invalid value for \"color\", must conform to the pattern #{pattern}.")
  end

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

  if @name.to_s.length > 40
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 40.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

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

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

  if @start_date.nil?
    invalid_properties.push('invalid value for "start_date", start_date 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



515
516
517
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 515

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



521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 521

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



509
510
511
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 509

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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/synctera_ruby_sdk/models/card_product.rb', line 314

def valid?
  return false if @form.nil?
  form_validator = EnumAttributeValidator.new('String', ["PHYSICAL", "VIRTUAL"])
  return false unless form_validator.valid?(@form)
  return false if @active.nil?
  return false if @card_program_id.nil?
  return false if !@color.nil? && @color !~ Regexp.new(/^[0-9A-F]{6}$/)
  return false if @name.nil?
  return false if @name.to_s.length > 40
  return false if @name.to_s.length < 1
  orientation_validator = EnumAttributeValidator.new('String', ["HORIZONTAL", "VERTICAL"])
  return false unless orientation_validator.valid?(@orientation)
  return false if !@package_id.nil? && @package_id.to_s.length > 50
  return false if !@package_id.nil? && @package_id.to_s.length < 1
  return false if @start_date.nil?
  true
end