Class: ShellCardManagementApIs::CardSettings

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_card_management_ap_is/models/card_settings.rb

Overview

CardSettings Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(card_delivery_type = nil, self_selected_encrypted_pin = SKIP, self_selected_pin_key_id = SKIP, self_selected_pin_session_key = SKIP, validate_fleet_id = SKIP, card_group_id = SKIP, delivery_contact_title = SKIP, delivery_contact_name = SKIP, delivery_company_name = SKIP, delivery_address_line1 = SKIP, delivery_address_line2 = SKIP, delivery_address_line3 = SKIP, delivery_zip_code = SKIP, delivery_city = SKIP, delivery_region_id = SKIP, delivery_region = SKIP, delivery_country = SKIP, delivery_country_id = SKIP, phone_number = SKIP, email_address = SKIP, pin_delivery_address_type = SKIP, pin_advice_type = SKIP, pin_delivery_contact_title = SKIP, pin_delivery_contact_name = SKIP, pin_delivery_company_name = SKIP, pin_delivery_address_line1 = SKIP, pin_delivery_address_line2 = SKIP, pin_delivery_address_line3 = SKIP, pin_delivery_zip_code = SKIP, pin_delivery_city = SKIP, pin_delivery_region_id = SKIP, pin_delivery_region = SKIP, pin_delivery_country = SKIP, pin_delivery_country_id = SKIP, pin_phone_number = SKIP, pin_email_address = SKIP, save_for_pin_reminder = SKIP, save_for_card_reissue = SKIP, expiry_date = SKIP) ⇒ CardSettings

Returns a new instance of CardSettings.



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
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
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/shell_card_management_ap_is/models/card_settings.rb', line 415

def initialize(card_delivery_type = nil, self_selected_encrypted_pin = SKIP,
               self_selected_pin_key_id = SKIP,
               self_selected_pin_session_key = SKIP,
               validate_fleet_id = SKIP, card_group_id = SKIP,
               delivery_contact_title = SKIP, delivery_contact_name = SKIP,
               delivery_company_name = SKIP, delivery_address_line1 = SKIP,
               delivery_address_line2 = SKIP, delivery_address_line3 = SKIP,
               delivery_zip_code = SKIP, delivery_city = SKIP,
               delivery_region_id = SKIP, delivery_region = SKIP,
               delivery_country = SKIP, delivery_country_id = SKIP,
               phone_number = SKIP, email_address = SKIP,
               pin_delivery_address_type = SKIP, pin_advice_type = SKIP,
               pin_delivery_contact_title = SKIP,
               pin_delivery_contact_name = SKIP,
               pin_delivery_company_name = SKIP,
               pin_delivery_address_line1 = SKIP,
               pin_delivery_address_line2 = SKIP,
               pin_delivery_address_line3 = SKIP,
               pin_delivery_zip_code = SKIP, pin_delivery_city = SKIP,
               pin_delivery_region_id = SKIP, pin_delivery_region = SKIP,
               pin_delivery_country = SKIP, pin_delivery_country_id = SKIP,
               pin_phone_number = SKIP, pin_email_address = SKIP,
               save_for_pin_reminder = SKIP, save_for_card_reissue = SKIP,
               expiry_date = SKIP)
  unless self_selected_encrypted_pin == SKIP
    @self_selected_encrypted_pin =
      self_selected_encrypted_pin
  end
  @self_selected_pin_key_id = self_selected_pin_key_id unless self_selected_pin_key_id == SKIP
  unless self_selected_pin_session_key == SKIP
    @self_selected_pin_session_key =
      self_selected_pin_session_key
  end
  @validate_fleet_id = validate_fleet_id unless validate_fleet_id == SKIP
  @card_group_id = card_group_id unless card_group_id == SKIP
  @card_delivery_type = card_delivery_type
  @delivery_contact_title = delivery_contact_title unless delivery_contact_title == SKIP
  @delivery_contact_name = delivery_contact_name unless delivery_contact_name == SKIP
  @delivery_company_name = delivery_company_name unless delivery_company_name == SKIP
  @delivery_address_line1 = delivery_address_line1 unless delivery_address_line1 == SKIP
  @delivery_address_line2 = delivery_address_line2 unless delivery_address_line2 == SKIP
  @delivery_address_line3 = delivery_address_line3 unless delivery_address_line3 == SKIP
  @delivery_zip_code = delivery_zip_code unless delivery_zip_code == SKIP
  @delivery_city = delivery_city unless delivery_city == SKIP
  @delivery_region_id = delivery_region_id unless delivery_region_id == SKIP
  @delivery_region = delivery_region unless delivery_region == SKIP
  @delivery_country = delivery_country unless delivery_country == SKIP
  @delivery_country_id = delivery_country_id unless delivery_country_id == SKIP
  @phone_number = phone_number unless phone_number == SKIP
  @email_address = email_address unless email_address == SKIP
  unless pin_delivery_address_type == SKIP
    @pin_delivery_address_type =
      pin_delivery_address_type
  end
  @pin_advice_type = pin_advice_type unless pin_advice_type == SKIP
  unless pin_delivery_contact_title == SKIP
    @pin_delivery_contact_title =
      pin_delivery_contact_title
  end
  unless pin_delivery_contact_name == SKIP
    @pin_delivery_contact_name =
      pin_delivery_contact_name
  end
  unless pin_delivery_company_name == SKIP
    @pin_delivery_company_name =
      pin_delivery_company_name
  end
  unless pin_delivery_address_line1 == SKIP
    @pin_delivery_address_line1 =
      pin_delivery_address_line1
  end
  unless pin_delivery_address_line2 == SKIP
    @pin_delivery_address_line2 =
      pin_delivery_address_line2
  end
  unless pin_delivery_address_line3 == SKIP
    @pin_delivery_address_line3 =
      pin_delivery_address_line3
  end
  @pin_delivery_zip_code = pin_delivery_zip_code unless pin_delivery_zip_code == SKIP
  @pin_delivery_city = pin_delivery_city unless pin_delivery_city == SKIP
  @pin_delivery_region_id = pin_delivery_region_id unless pin_delivery_region_id == SKIP
  @pin_delivery_region = pin_delivery_region unless pin_delivery_region == SKIP
  @pin_delivery_country = pin_delivery_country unless pin_delivery_country == SKIP
  @pin_delivery_country_id = pin_delivery_country_id unless pin_delivery_country_id == SKIP
  @pin_phone_number = pin_phone_number unless pin_phone_number == SKIP
  @pin_email_address = pin_email_address unless pin_email_address == SKIP
  @save_for_pin_reminder = save_for_pin_reminder unless save_for_pin_reminder == SKIP
  @save_for_card_reissue = save_for_card_reissue unless save_for_card_reissue == SKIP
  @expiry_date = expiry_date unless expiry_date == SKIP
end

Instance Attribute Details

#card_delivery_typeInteger

Card delivery type.<br /> Mandatory <br /> Allowed Value: <br />

  1. Customer Address(Default) <br />

  2. New Delivery Address <br />

  3. Old Card Address

Returns:

  • (Integer)


65
66
67
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 65

def card_delivery_type
  @card_delivery_type
end

#card_group_idInteger

Existing Card Group ID, under which the replacement card is to be created.<br /> Pass “-1” if the replacement card should not be assigned to any card group.<br /> Optional <br /> If not provided, the replacement card will be created under the same card group as the current card.

Returns:

  • (Integer)


56
57
58
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 56

def card_group_id
  @card_group_id
end

#delivery_address_line1String

Address line 1 <br /> Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed as true.<br /> Max field length: 40

Returns:

  • (String)


92
93
94
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 92

def delivery_address_line1
  @delivery_address_line1
end

#delivery_address_line2String

Address line 2 <br /> Optional <br /> Max field length: 40

Returns:

  • (String)


98
99
100
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 98

def delivery_address_line2
  @delivery_address_line2
end

#delivery_address_line3String

Address line 3 <br /> Optional<br /> Max field length: 40

Returns:

  • (String)


104
105
106
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 104

def delivery_address_line3
  @delivery_address_line3
end

#delivery_cityString

City <br /> Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed as true.<br /> Max field length: 40

Returns:

  • (String)


118
119
120
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 118

def delivery_city
  @delivery_city
end

#delivery_company_nameString

Company name <br /> Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed as true. Max field length: 50

Returns:

  • (String)


85
86
87
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 85

def delivery_company_name
  @delivery_company_name
end

#delivery_contact_nameString

Name of the contact person <br /> Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed as true.<br /> Max field length: 50

Returns:

  • (String)


78
79
80
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 78

def delivery_contact_name
  @delivery_contact_name
end

#delivery_contact_titleString

Title of the contact person. <br /> Optional<br /> Max field length: 10

Returns:

  • (String)


71
72
73
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 71

def delivery_contact_title
  @delivery_contact_title
end

#delivery_countryString

The ISO code of the country.<br /> Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed as true

Returns:

  • (String)


135
136
137
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 135

def delivery_country
  @delivery_country
end

#delivery_country_idInteger

The countryId of gicen country.<br />

Returns:

  • (Integer)


139
140
141
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 139

def delivery_country_id
  @delivery_country_id
end

#delivery_regionString

Region <br /> Optional<br /> When region is passed

Returns:

  • (String)


129
130
131
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 129

def delivery_region
  @delivery_region
end

#delivery_region_idInteger

Region Id <br /> Optional

Returns:

  • (Integer)


123
124
125
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 123

def delivery_region_id
  @delivery_region_id
end

#delivery_zip_codeString

ZIP code <br /> Mandatory - If CardDeliveryType is 2 and OrderCardReplacement is passed as true.<br /> Max field length: 10

Returns:

  • (String)


111
112
113
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 111

def delivery_zip_code
  @delivery_zip_code
end

#email_addressString

Email address for to send email.<br /> Mandatory if PINAdviceType is email else optional.<br /> Max field length: 90

Returns:

  • (String)


151
152
153
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 151

def email_address
  @email_address
end

#expiry_dateString

Expiry Date for newly created card to be update in cards plot form.<br /> Optional <br /> Format: MMyy <br /> Eg:1221 <br /> If not apply the default Expiry Date.<br /> Note:<br /> There is a limit to the ExpiryDate which the user can choose for the Card.

If the user chooses a later ExpiryDate than the allowed value for the CardType of the OU, the background service logs the respective error code and description

Returns:

  • (String)


283
284
285
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 283

def expiry_date
  @expiry_date
end

#phone_numberString

Phone number for to send SMS. <br /> Optional<br /> Max field length: 20

Returns:

  • (String)


145
146
147
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 145

def phone_number
  @phone_number
end

#pin_advice_typeInteger

PIN delivery method.<br /> Mandatory when OrderReplacement Is true.<br /> Allowed Values:<br />

  1. Paper<br />

  2. Email<br />

  3. SMS<br />

  4. None

Note: Paper delivery not applicable for selfselctedPIN type and FleetPIN enabled Accounts

Returns:

  • (Integer)


172
173
174
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 172

def pin_advice_type
  @pin_advice_type
end

#pin_delivery_address_line1String

Address line 1.<br /> Mandatory - If PINAdviceType is paper else optional.<br /> Max field length: 40

Returns:

  • (String)


196
197
198
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 196

def pin_delivery_address_line1
  @pin_delivery_address_line1
end

#pin_delivery_address_line2String

Address line 2.<br /> Optional <br /> Max field length: 40

Returns:

  • (String)


202
203
204
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 202

def pin_delivery_address_line2
  @pin_delivery_address_line2
end

#pin_delivery_address_line3String

Address line 3.<br /> Optional <br /> Max field length: 40

Returns:

  • (String)


208
209
210
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 208

def pin_delivery_address_line3
  @pin_delivery_address_line3
end

#pin_delivery_address_typeInteger

PIN delivery address type selection.<br /> Optional<br /> Allowed Values:<br />

  1. Customer Address(Default)<br />

  2. Card Address<br />

  3. New Delivery Address

Returns:

  • (Integer)


160
161
162
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 160

def pin_delivery_address_type
  @pin_delivery_address_type
end

#pin_delivery_cityString

City.<br /> Mandatory - If PINAdviceType is paper else optional. <br /> Max field length: 40

Returns:

  • (String)


220
221
222
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 220

def pin_delivery_city
  @pin_delivery_city
end

#pin_delivery_company_nameString

Company name.<br /> Mandatory - If PINAdviceType is paper else optional.<br /> Max field length: 50

Returns:

  • (String)


190
191
192
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 190

def pin_delivery_company_name
  @pin_delivery_company_name
end

#pin_delivery_contact_nameString

Name of the contact person.<br /> Mandatory - If PINAdviceType is paper else optional.<br /> Max field length: 50

Returns:

  • (String)


184
185
186
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 184

def pin_delivery_contact_name
  @pin_delivery_contact_name
end

#pin_delivery_contact_titleString

Title of the contact person.<br /> Optional <br /> Max field length: 10

Returns:

  • (String)


178
179
180
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 178

def pin_delivery_contact_title
  @pin_delivery_contact_title
end

#pin_delivery_countryString

The ISO code of the country.<br /> Mappings for ISO code <br /> Mandatory if PINAdviceType is paper else optional.

Returns:

  • (String)


236
237
238
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 236

def pin_delivery_country
  @pin_delivery_country
end

#pin_delivery_country_idInteger

The countryId of the country.<br /> Mappings for ISO code<br /> This is not an input parameter.

Returns:

  • (Integer)


242
243
244
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 242

def pin_delivery_country_id
  @pin_delivery_country_id
end

#pin_delivery_regionString

Region.<br /> When region is passed

Returns:

  • (String)


230
231
232
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 230

def pin_delivery_region
  @pin_delivery_region
end

#pin_delivery_region_idInteger

Region Id.<br /> Optional

Returns:

  • (Integer)


225
226
227
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 225

def pin_delivery_region_id
  @pin_delivery_region_id
end

#pin_delivery_zip_codeString

ZIP code.<br /> Mandatory - if PINAdviceType is paper else optional. <br /> Max field length: 10

Returns:

  • (String)


214
215
216
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 214

def pin_delivery_zip_code
  @pin_delivery_zip_code
end

#pin_email_addressString

Email address for to send email of the PIN in case PINAdviceType is Email.<br /> Mandatory if PINAdviceType is email else optional.<br /> Max field length: 90

Returns:

  • (String)


256
257
258
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 256

def pin_email_address
  @pin_email_address
end

#pin_phone_numberString

Phone number for to send SMS of the PIN in case PINAdviceType is SMS.<br /> Mandatory if PINAdviceType is SMS else optional.<br /> Max field length: 20

Returns:

  • (String)


249
250
251
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 249

def pin_phone_number
  @pin_phone_number
end

#save_for_card_reissueTrueClass | FalseClass

If this is specified, the contact address will be saved in cards platform for card reissue processing.<br /> Optional

Returns:

  • (TrueClass | FalseClass)


269
270
271
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 269

def save_for_card_reissue
  @save_for_card_reissue
end

#save_for_pin_reminderTrueClass | FalseClass

The given address will be used for sending PIN reminders in future when requested.<br /> PIN Advice type should be Paper Optional

Returns:

  • (TrueClass | FalseClass)


263
264
265
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 263

def save_for_pin_reminder
  @save_for_pin_reminder
end

#self_selected_encrypted_pinString

The encrypted value of self-selected PIN.<br /> Optional – When not provided, the PIN will be auto generated(if the card token type supports PIN) and delivered based on the given PIN delivery option.<br /> Max Length: 256

Returns:

  • (String)


18
19
20
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 18

def self_selected_encrypted_pin
  @self_selected_encrypted_pin
end

#self_selected_pin_key_idString

KeyId of the PIN encrypted value.<br /> Mandatory, if opted for self-selected PIN else optional.<br /> Max Length: 30

Returns:

  • (String)


24
25
26
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 24

def self_selected_pin_key_id
  @self_selected_pin_key_id
end

#self_selected_pin_session_keyString

Encoded message of the TCS form which is used for encrypting the PIN of this card.<br /> The encode message forms are provided to clients by another API (“TCS”).<br /> Instructions to encrypt the PIN is covered in the related API specifications document.<br /> Mandatory –If opted for self-selected PIN else optional. Max Length: 1024

Returns:

  • (String)


35
36
37
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 35

def self_selected_pin_session_key
  @self_selected_pin_session_key
end

#validate_fleet_idTrueClass | FalseClass

True/False.<br /> Optional <br /> Default: False<br /> For cards ordered with Validate Fleet Id parameter set to true, CFGW will be notified to enable this validation for the card.<br /> Note: When “FleetIdInputRequired” is not set on the card, validate fleet id will be considered false regardless of the value passed on this parameter.

Returns:

  • (TrueClass | FalseClass)


46
47
48
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 46

def validate_fleet_id
  @validate_fleet_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 508

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  card_delivery_type =
    hash.key?('CardDeliveryType') ? hash['CardDeliveryType'] : nil
  self_selected_encrypted_pin =
    hash.key?('SelfSelectedEncryptedPIN') ? hash['SelfSelectedEncryptedPIN'] : SKIP
  self_selected_pin_key_id =
    hash.key?('SelfSelectedPINKeyID') ? hash['SelfSelectedPINKeyID'] : SKIP
  self_selected_pin_session_key =
    hash.key?('SelfSelectedPINSessionKey') ? hash['SelfSelectedPINSessionKey'] : SKIP
  validate_fleet_id =
    hash.key?('ValidateFleetId') ? hash['ValidateFleetId'] : SKIP
  card_group_id = hash.key?('CardGroupId') ? hash['CardGroupId'] : SKIP
  delivery_contact_title =
    hash.key?('DeliveryContactTitle') ? hash['DeliveryContactTitle'] : SKIP
  delivery_contact_name =
    hash.key?('DeliveryContactName') ? hash['DeliveryContactName'] : SKIP
  delivery_company_name =
    hash.key?('DeliveryCompanyName') ? hash['DeliveryCompanyName'] : SKIP
  delivery_address_line1 =
    hash.key?('DeliveryAddressLine1') ? hash['DeliveryAddressLine1'] : SKIP
  delivery_address_line2 =
    hash.key?('DeliveryAddressLine2') ? hash['DeliveryAddressLine2'] : SKIP
  delivery_address_line3 =
    hash.key?('DeliveryAddressLine3') ? hash['DeliveryAddressLine3'] : SKIP
  delivery_zip_code =
    hash.key?('DeliveryZipCode') ? hash['DeliveryZipCode'] : SKIP
  delivery_city = hash.key?('DeliveryCity') ? hash['DeliveryCity'] : SKIP
  delivery_region_id =
    hash.key?('DeliveryRegionId') ? hash['DeliveryRegionId'] : SKIP
  delivery_region =
    hash.key?('DeliveryRegion') ? hash['DeliveryRegion'] : SKIP
  delivery_country =
    hash.key?('DeliveryCountry') ? hash['DeliveryCountry'] : SKIP
  delivery_country_id =
    hash.key?('DeliveryCountryId') ? hash['DeliveryCountryId'] : SKIP
  phone_number = hash.key?('PhoneNumber') ? hash['PhoneNumber'] : SKIP
  email_address = hash.key?('EmailAddress') ? hash['EmailAddress'] : SKIP
  pin_delivery_address_type =
    hash.key?('PINDeliveryAddressType') ? hash['PINDeliveryAddressType'] : SKIP
  pin_advice_type =
    hash.key?('PINAdviceType') ? hash['PINAdviceType'] : SKIP
  pin_delivery_contact_title =
    hash.key?('PINDeliveryContactTitle') ? hash['PINDeliveryContactTitle'] : SKIP
  pin_delivery_contact_name =
    hash.key?('PINDeliveryContactName') ? hash['PINDeliveryContactName'] : SKIP
  pin_delivery_company_name =
    hash.key?('PINDeliveryCompanyName') ? hash['PINDeliveryCompanyName'] : SKIP
  pin_delivery_address_line1 =
    hash.key?('PINDeliveryAddressLine1') ? hash['PINDeliveryAddressLine1'] : SKIP
  pin_delivery_address_line2 =
    hash.key?('PINDeliveryAddressLine2') ? hash['PINDeliveryAddressLine2'] : SKIP
  pin_delivery_address_line3 =
    hash.key?('PINDeliveryAddressLine3') ? hash['PINDeliveryAddressLine3'] : SKIP
  pin_delivery_zip_code =
    hash.key?('PINDeliveryZipCode') ? hash['PINDeliveryZipCode'] : SKIP
  pin_delivery_city =
    hash.key?('PINDeliveryCity') ? hash['PINDeliveryCity'] : SKIP
  pin_delivery_region_id =
    hash.key?('PINDeliveryRegionId') ? hash['PINDeliveryRegionId'] : SKIP
  pin_delivery_region =
    hash.key?('PINDeliveryRegion') ? hash['PINDeliveryRegion'] : SKIP
  pin_delivery_country =
    hash.key?('PINDeliveryCountry') ? hash['PINDeliveryCountry'] : SKIP
  pin_delivery_country_id =
    hash.key?('PINDeliveryCountryId') ? hash['PINDeliveryCountryId'] : SKIP
  pin_phone_number =
    hash.key?('PINPhoneNumber') ? hash['PINPhoneNumber'] : SKIP
  pin_email_address =
    hash.key?('PINEmailAddress') ? hash['PINEmailAddress'] : SKIP
  save_for_pin_reminder =
    hash.key?('SaveForPINReminder') ? hash['SaveForPINReminder'] : SKIP
  save_for_card_reissue =
    hash.key?('SaveForCardReissue') ? hash['SaveForCardReissue'] : SKIP
  expiry_date = hash.key?('ExpiryDate') ? hash['ExpiryDate'] : SKIP

  # Create object from extracted values.
  CardSettings.new(card_delivery_type,
                   self_selected_encrypted_pin,
                   self_selected_pin_key_id,
                   self_selected_pin_session_key,
                   validate_fleet_id,
                   card_group_id,
                   delivery_contact_title,
                   delivery_contact_name,
                   delivery_company_name,
                   delivery_address_line1,
                   delivery_address_line2,
                   delivery_address_line3,
                   delivery_zip_code,
                   delivery_city,
                   delivery_region_id,
                   delivery_region,
                   delivery_country,
                   delivery_country_id,
                   phone_number,
                   email_address,
                   pin_delivery_address_type,
                   pin_advice_type,
                   pin_delivery_contact_title,
                   pin_delivery_contact_name,
                   pin_delivery_company_name,
                   pin_delivery_address_line1,
                   pin_delivery_address_line2,
                   pin_delivery_address_line3,
                   pin_delivery_zip_code,
                   pin_delivery_city,
                   pin_delivery_region_id,
                   pin_delivery_region,
                   pin_delivery_country,
                   pin_delivery_country_id,
                   pin_phone_number,
                   pin_email_address,
                   save_for_pin_reminder,
                   save_for_card_reissue,
                   expiry_date)
end

.namesObject

A mapping from model property names to API property names.



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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 286

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['self_selected_encrypted_pin'] = 'SelfSelectedEncryptedPIN'
  @_hash['self_selected_pin_key_id'] = 'SelfSelectedPINKeyID'
  @_hash['self_selected_pin_session_key'] = 'SelfSelectedPINSessionKey'
  @_hash['validate_fleet_id'] = 'ValidateFleetId'
  @_hash['card_group_id'] = 'CardGroupId'
  @_hash['card_delivery_type'] = 'CardDeliveryType'
  @_hash['delivery_contact_title'] = 'DeliveryContactTitle'
  @_hash['delivery_contact_name'] = 'DeliveryContactName'
  @_hash['delivery_company_name'] = 'DeliveryCompanyName'
  @_hash['delivery_address_line1'] = 'DeliveryAddressLine1'
  @_hash['delivery_address_line2'] = 'DeliveryAddressLine2'
  @_hash['delivery_address_line3'] = 'DeliveryAddressLine3'
  @_hash['delivery_zip_code'] = 'DeliveryZipCode'
  @_hash['delivery_city'] = 'DeliveryCity'
  @_hash['delivery_region_id'] = 'DeliveryRegionId'
  @_hash['delivery_region'] = 'DeliveryRegion'
  @_hash['delivery_country'] = 'DeliveryCountry'
  @_hash['delivery_country_id'] = 'DeliveryCountryId'
  @_hash['phone_number'] = 'PhoneNumber'
  @_hash['email_address'] = 'EmailAddress'
  @_hash['pin_delivery_address_type'] = 'PINDeliveryAddressType'
  @_hash['pin_advice_type'] = 'PINAdviceType'
  @_hash['pin_delivery_contact_title'] = 'PINDeliveryContactTitle'
  @_hash['pin_delivery_contact_name'] = 'PINDeliveryContactName'
  @_hash['pin_delivery_company_name'] = 'PINDeliveryCompanyName'
  @_hash['pin_delivery_address_line1'] = 'PINDeliveryAddressLine1'
  @_hash['pin_delivery_address_line2'] = 'PINDeliveryAddressLine2'
  @_hash['pin_delivery_address_line3'] = 'PINDeliveryAddressLine3'
  @_hash['pin_delivery_zip_code'] = 'PINDeliveryZipCode'
  @_hash['pin_delivery_city'] = 'PINDeliveryCity'
  @_hash['pin_delivery_region_id'] = 'PINDeliveryRegionId'
  @_hash['pin_delivery_region'] = 'PINDeliveryRegion'
  @_hash['pin_delivery_country'] = 'PINDeliveryCountry'
  @_hash['pin_delivery_country_id'] = 'PINDeliveryCountryId'
  @_hash['pin_phone_number'] = 'PINPhoneNumber'
  @_hash['pin_email_address'] = 'PINEmailAddress'
  @_hash['save_for_pin_reminder'] = 'SaveForPINReminder'
  @_hash['save_for_card_reissue'] = 'SaveForCardReissue'
  @_hash['expiry_date'] = 'ExpiryDate'
  @_hash
end

.nullablesObject

An array for nullable fields



375
376
377
378
379
380
381
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
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 375

def self.nullables
  %w[
    self_selected_encrypted_pin
    self_selected_pin_key_id
    self_selected_pin_session_key
    card_group_id
    card_delivery_type
    delivery_contact_title
    delivery_contact_name
    delivery_company_name
    delivery_address_line1
    delivery_address_line2
    delivery_address_line3
    delivery_zip_code
    delivery_city
    delivery_region_id
    delivery_region
    delivery_country
    delivery_country_id
    email_address
    pin_delivery_address_type
    pin_advice_type
    pin_delivery_contact_title
    pin_delivery_contact_name
    pin_delivery_company_name
    pin_delivery_address_line1
    pin_delivery_address_line2
    pin_delivery_address_line3
    pin_delivery_zip_code
    pin_delivery_city
    pin_delivery_region_id
    pin_delivery_region
    pin_delivery_country
    pin_delivery_country_id
    pin_phone_number
    pin_email_address
    expiry_date
  ]
end

.optionalsObject

An array for optional fields



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 331

def self.optionals
  %w[
    self_selected_encrypted_pin
    self_selected_pin_key_id
    self_selected_pin_session_key
    validate_fleet_id
    card_group_id
    delivery_contact_title
    delivery_contact_name
    delivery_company_name
    delivery_address_line1
    delivery_address_line2
    delivery_address_line3
    delivery_zip_code
    delivery_city
    delivery_region_id
    delivery_region
    delivery_country
    delivery_country_id
    phone_number
    email_address
    pin_delivery_address_type
    pin_advice_type
    pin_delivery_contact_title
    pin_delivery_contact_name
    pin_delivery_company_name
    pin_delivery_address_line1
    pin_delivery_address_line2
    pin_delivery_address_line3
    pin_delivery_zip_code
    pin_delivery_city
    pin_delivery_region_id
    pin_delivery_region
    pin_delivery_country
    pin_delivery_country_id
    pin_phone_number
    pin_email_address
    save_for_pin_reminder
    save_for_card_reissue
    expiry_date
  ]
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 658

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} self_selected_encrypted_pin: #{@self_selected_encrypted_pin.inspect},"\
  " self_selected_pin_key_id: #{@self_selected_pin_key_id.inspect},"\
  " self_selected_pin_session_key: #{@self_selected_pin_session_key.inspect},"\
  " validate_fleet_id: #{@validate_fleet_id.inspect}, card_group_id:"\
  " #{@card_group_id.inspect}, card_delivery_type: #{@card_delivery_type.inspect},"\
  " delivery_contact_title: #{@delivery_contact_title.inspect}, delivery_contact_name:"\
  " #{@delivery_contact_name.inspect}, delivery_company_name:"\
  " #{@delivery_company_name.inspect}, delivery_address_line1:"\
  " #{@delivery_address_line1.inspect}, delivery_address_line2:"\
  " #{@delivery_address_line2.inspect}, delivery_address_line3:"\
  " #{@delivery_address_line3.inspect}, delivery_zip_code: #{@delivery_zip_code.inspect},"\
  " delivery_city: #{@delivery_city.inspect}, delivery_region_id:"\
  " #{@delivery_region_id.inspect}, delivery_region: #{@delivery_region.inspect},"\
  " delivery_country: #{@delivery_country.inspect}, delivery_country_id:"\
  " #{@delivery_country_id.inspect}, phone_number: #{@phone_number.inspect}, email_address:"\
  " #{@email_address.inspect}, pin_delivery_address_type:"\
  " #{@pin_delivery_address_type.inspect}, pin_advice_type: #{@pin_advice_type.inspect},"\
  " pin_delivery_contact_title: #{@pin_delivery_contact_title.inspect},"\
  " pin_delivery_contact_name: #{@pin_delivery_contact_name.inspect},"\
  " pin_delivery_company_name: #{@pin_delivery_company_name.inspect},"\
  " pin_delivery_address_line1: #{@pin_delivery_address_line1.inspect},"\
  " pin_delivery_address_line2: #{@pin_delivery_address_line2.inspect},"\
  " pin_delivery_address_line3: #{@pin_delivery_address_line3.inspect}, pin_delivery_zip_code:"\
  " #{@pin_delivery_zip_code.inspect}, pin_delivery_city: #{@pin_delivery_city.inspect},"\
  " pin_delivery_region_id: #{@pin_delivery_region_id.inspect}, pin_delivery_region:"\
  " #{@pin_delivery_region.inspect}, pin_delivery_country: #{@pin_delivery_country.inspect},"\
  " pin_delivery_country_id: #{@pin_delivery_country_id.inspect}, pin_phone_number:"\
  " #{@pin_phone_number.inspect}, pin_email_address: #{@pin_email_address.inspect},"\
  " save_for_pin_reminder: #{@save_for_pin_reminder.inspect}, save_for_card_reissue:"\
  " #{@save_for_card_reissue.inspect}, expiry_date: #{@expiry_date.inspect}>"
end

#to_sObject

Provides a human-readable string representation of the object.



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
# File 'lib/shell_card_management_ap_is/models/card_settings.rb', line 629

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} self_selected_encrypted_pin: #{@self_selected_encrypted_pin},"\
  " self_selected_pin_key_id: #{@self_selected_pin_key_id}, self_selected_pin_session_key:"\
  " #{@self_selected_pin_session_key}, validate_fleet_id: #{@validate_fleet_id},"\
  " card_group_id: #{@card_group_id}, card_delivery_type: #{@card_delivery_type},"\
  " delivery_contact_title: #{@delivery_contact_title}, delivery_contact_name:"\
  " #{@delivery_contact_name}, delivery_company_name: #{@delivery_company_name},"\
  " delivery_address_line1: #{@delivery_address_line1}, delivery_address_line2:"\
  " #{@delivery_address_line2}, delivery_address_line3: #{@delivery_address_line3},"\
  " delivery_zip_code: #{@delivery_zip_code}, delivery_city: #{@delivery_city},"\
  " delivery_region_id: #{@delivery_region_id}, delivery_region: #{@delivery_region},"\
  " delivery_country: #{@delivery_country}, delivery_country_id: #{@delivery_country_id},"\
  " phone_number: #{@phone_number}, email_address: #{@email_address},"\
  " pin_delivery_address_type: #{@pin_delivery_address_type}, pin_advice_type:"\
  " #{@pin_advice_type}, pin_delivery_contact_title: #{@pin_delivery_contact_title},"\
  " pin_delivery_contact_name: #{@pin_delivery_contact_name}, pin_delivery_company_name:"\
  " #{@pin_delivery_company_name}, pin_delivery_address_line1: #{@pin_delivery_address_line1},"\
  " pin_delivery_address_line2: #{@pin_delivery_address_line2}, pin_delivery_address_line3:"\
  " #{@pin_delivery_address_line3}, pin_delivery_zip_code: #{@pin_delivery_zip_code},"\
  " pin_delivery_city: #{@pin_delivery_city}, pin_delivery_region_id:"\
  " #{@pin_delivery_region_id}, pin_delivery_region: #{@pin_delivery_region},"\
  " pin_delivery_country: #{@pin_delivery_country}, pin_delivery_country_id:"\
  " #{@pin_delivery_country_id}, pin_phone_number: #{@pin_phone_number}, pin_email_address:"\
  " #{@pin_email_address}, save_for_pin_reminder: #{@save_for_pin_reminder},"\
  " save_for_card_reissue: #{@save_for_card_reissue}, expiry_date: #{@expiry_date}>"
end