Class: SyncteraRubySdk::CardProductAllOf

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CardProductAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
235
236
237
238
239
240
241
242
243
244
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 154

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

#activeObject

Indicates whether the Card Product is active



19
20
21
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 19

def active
  @active
end

#card_program_idObject

Card Program ID



22
23
24
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 22

def card_program_id
  @card_program_id
end

#colorObject

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



25
26
27
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 25

def color
  @color
end

#creation_timeObject

The timestamp representing when the Card Product was created



28
29
30
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 28

def creation_time
  @creation_time
end

#digital_wallet_tokenizationObject

Returns the value of attribute digital_wallet_tokenization.



30
31
32
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 30

def digital_wallet_tokenization
  @digital_wallet_tokenization
end

#end_dateObject

The time when the Card Product is decommissioned



33
34
35
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 33

def end_date
  @end_date
end

#idObject

Card Product ID



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

def id
  @id
end

#imageObject

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



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

def image
  @image
end

#image_modeObject

Returns the value of attribute image_mode.



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

def image_mode
  @image_mode
end

#issue_without_kycObject

Allow issuing cards on this product without requiring KYC



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

def issue_without_kyc
  @issue_without_kyc
end

#last_modified_timeObject

The timestamp representing when the Card Product was last modified



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

def last_modified_time
  @last_modified_time
end

#nameObject

The name of the Card Product



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

def name
  @name
end

#orientationObject

Card orientation



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

def orientation
  @orientation
end

#package_idObject

Card fulfillment provider’s package ID



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

def package_id
  @package_id
end

#physical_card_formatObject

Returns the value of attribute physical_card_format.



58
59
60
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 58

def physical_card_format
  @physical_card_format
end

#return_addressObject

Returns the value of attribute return_address.



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

def return_address
  @return_address
end

#start_dateObject

The time when the Card Product goes live



63
64
65
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 63

def start_date
  @start_date
end

#three_ds_policyObject

Returns the value of attribute three_ds_policy.



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

def three_ds_policy
  @three_ds_policy
end

#txn_enhancerObject

Returns the value of attribute txn_enhancer.



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

def txn_enhancer
  @txn_enhancer
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



117
118
119
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 117

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 92

def self.attribute_map
  {
    :'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



401
402
403
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 401

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

.openapi_nullableObject

List of attributes with nullable: true



147
148
149
150
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 147

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

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 362

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 432

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



503
504
505
506
507
508
509
510
511
512
513
514
515
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 503

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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 408

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


388
389
390
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 388

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



394
395
396
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 394

def hash
  [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_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
283
284
285
286
287
288
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 248

def list_invalid_properties
  invalid_properties = Array.new
  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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



479
480
481
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 479

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



485
486
487
488
489
490
491
492
493
494
495
496
497
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 485

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



473
474
475
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 473

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/synctera_ruby_sdk/models/card_product_all_of.rb', line 292

def valid?
  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