Class: ShellCardManagementApIs::CardDetail

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

Overview

Request entity object for CardDetail

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(card_delivery_type = nil, pin_advice_type = nil, payer_id = SKIP, payer_number = SKIP, account_id = SKIP, account_number = SKIP, col_co_code = SKIP, col_co_id = SKIP, card_type_id = SKIP, token_type_id = SKIP, emboss_text = SKIP, vrn = SKIP, driver_name = SKIP, odometer_input_required = SKIP, fleet_id_input_required = SKIP, purchase_category_id = SKIP, self_selected_encrypted_pin = SKIP, self_selected_pin_key_id = SKIP, self_selected_pin_session_key = SKIP, card_group_id = SKIP, card_group_name = SKIP, is_new_card_group = SKIP, emboss_card_group = SKIP, card_contact = SKIP, pin_delivery_address_type = SKIP, pin_contact = SKIP, notify_caller = SKIP, caller = SKIP, notify_caller_on_sync = SKIP, validate_fleet_id = SKIP, fleet_option = SKIP, bundle_id = SKIP, usage_restriction_action = SKIP, product_restriction_action = SKIP, products = SKIP, product_groups = SKIP, expiry_date = SKIP, client_reference_id = SKIP, auto_renew = SKIP) ⇒ CardDetail

Returns a new instance of CardDetail.



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
506
507
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
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 474

def initialize(card_delivery_type = nil, pin_advice_type = nil,
               payer_id = SKIP, payer_number = SKIP,  = SKIP,
                = SKIP, col_co_code = SKIP, col_co_id = SKIP,
               card_type_id = SKIP, token_type_id = SKIP,
               emboss_text = SKIP, vrn = SKIP, driver_name = SKIP,
               odometer_input_required = SKIP,
               fleet_id_input_required = SKIP, purchase_category_id = SKIP,
               self_selected_encrypted_pin = SKIP,
               self_selected_pin_key_id = SKIP,
               self_selected_pin_session_key = SKIP, card_group_id = SKIP,
               card_group_name = SKIP, is_new_card_group = SKIP,
               emboss_card_group = SKIP, card_contact = SKIP,
               pin_delivery_address_type = SKIP, pin_contact = SKIP,
               notify_caller = SKIP, caller = SKIP,
               notify_caller_on_sync = SKIP, validate_fleet_id = SKIP,
               fleet_option = SKIP, bundle_id = SKIP,
               usage_restriction_action = SKIP,
               product_restriction_action = SKIP, products = SKIP,
               product_groups = SKIP, expiry_date = SKIP,
               client_reference_id = SKIP, auto_renew = SKIP)
  @payer_id = payer_id unless payer_id == SKIP
  @payer_number = payer_number unless payer_number == SKIP
  @account_id =  unless  == SKIP
  @account_number =  unless  == SKIP
  @col_co_code = col_co_code unless col_co_code == SKIP
  @col_co_id = col_co_id unless col_co_id == SKIP
  @card_type_id = card_type_id unless card_type_id == SKIP
  @token_type_id = token_type_id unless token_type_id == SKIP
  @emboss_text = emboss_text unless emboss_text == SKIP
  @vrn = vrn unless vrn == SKIP
  @driver_name = driver_name unless driver_name == SKIP
  @odometer_input_required = odometer_input_required unless odometer_input_required == SKIP
  @fleet_id_input_required = fleet_id_input_required unless fleet_id_input_required == SKIP
  @purchase_category_id = purchase_category_id unless purchase_category_id == 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
  @card_group_id = card_group_id unless card_group_id == SKIP
  @card_group_name = card_group_name unless card_group_name == SKIP
  @is_new_card_group = is_new_card_group unless is_new_card_group == SKIP
  @emboss_card_group = emboss_card_group unless emboss_card_group == SKIP
  @card_delivery_type = card_delivery_type
  @card_contact = card_contact unless card_contact == SKIP
  unless pin_delivery_address_type == SKIP
    @pin_delivery_address_type =
      pin_delivery_address_type
  end
  @pin_advice_type = pin_advice_type
  @pin_contact = pin_contact unless pin_contact == SKIP
  @notify_caller = notify_caller unless notify_caller == SKIP
  @caller = caller unless caller == SKIP
  @notify_caller_on_sync = notify_caller_on_sync unless notify_caller_on_sync == SKIP
  @validate_fleet_id = validate_fleet_id unless validate_fleet_id == SKIP
  @fleet_option = fleet_option unless fleet_option == SKIP
  @bundle_id = bundle_id unless bundle_id == SKIP
  @usage_restriction_action = usage_restriction_action unless usage_restriction_action == SKIP
  unless product_restriction_action == SKIP
    @product_restriction_action =
      product_restriction_action
  end
  @products = products unless products == SKIP
  @product_groups = product_groups unless product_groups == SKIP
  @expiry_date = expiry_date unless expiry_date == SKIP
  @client_reference_id = client_reference_id unless client_reference_id == SKIP
  @auto_renew = auto_renew unless auto_renew == SKIP
end

Instance Attribute Details

#account_idInteger

Account ID of the customer.<br /> Optional if AccountNumber is passed, else mandatory.<br /> This input is a search criterion, if given.

Returns:

  • (Integer)


26
27
28
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 26

def 
  @account_id
end

#account_numberString

Account Number of the customer.<br /> Optional if AccountId is passed, else mandatory.<br /> This input is a search criterion, if given.

Returns:

  • (String)


32
33
34
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 32

def 
  @account_number
end

#auto_renewCardDetailAutoRenewEnum

Whether to reissue card automatically when nearing the expiry. Allowed values: -

  1. As per card type setting (Default).

  2. Card will be Reissued when nearing its expiry date.

  3. Card will not be Reissued.



352
353
354
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 352

def auto_renew
  @auto_renew
end

#bundle_idString

Gateway Bundle Id to which the ordered card will be added.<br /> Optional.<br /> When a valid bundle Id is passed, upon successful processing of Card Order, the card will be added to the provided bundle in Gateway. If card bundle has crossed the limit of 500 cards or if the card bundle is not available in the gateway then the background services will fail to added the card to the bundle.

Returns:

  • (String)


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

def bundle_id
  @bundle_id
end

#callerString

The caller to be notified with the status of the card order.<br /> Mandatory, if NotifyCaller is true.<br /> Maximum field length: 20<br /> Allowed values:<br /> • “NextGenUI”: This value to be used by next gen UI application.<br /> • “FleetHubUILifeTime”: This value to be used by Fleet Hub UI application for life time restriction cards.<br /> Note: The values passed in this field are case insensitive

Returns:

  • (String)


240
241
242
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 240

def caller
  @caller
end

#card_contactCardContact

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

  1. Customer Address(Default) <br />

  2. New Delivery Address

Returns:



188
189
190
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 188

def card_contact
  @card_contact
end

#card_delivery_typeInteger

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

  1. Customer Address(Default) <br />

  2. New Delivery Address

Returns:

  • (Integer)


180
181
182
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 180

def card_delivery_type
  @card_delivery_type
end

#card_group_idInteger

Card group ID<br /> Optional

Returns:

  • (Integer)


142
143
144
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 142

def card_group_id
  @card_group_id
end

#card_group_nameString

Card group name<br /> This field is mandatory when IsNewCardGroup parameter is set to true.<br /> Maximum field length: 40<br /> The value will be validated against a configured list of allowed characters.<br /> Default value for the configuration is: [0-9A-Z.]

Returns:

  • (String)


152
153
154
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 152

def card_group_name
  @card_group_name
end

#card_type_idInteger

Card Type ID<br /> Mandatory

Returns:

  • (Integer)


48
49
50
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 48

def card_type_id
  @card_type_id
end

#client_reference_idString

This is the Client Reference Id of card in the order which needs to be passed by the client.This will be playback in the ordercard enquiry<br /> Optional

Returns:

  • (String)


344
345
346
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 344

def client_reference_id
  @client_reference_id
end

#col_co_codeInteger

Collecting Company Code (Shell Code) of the selected payer.<br /> Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.

Returns:

  • (Integer)


38
39
40
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 38

def col_co_code
  @col_co_code
end

#col_co_idInteger

Collecting Company Id of the selected payer.<br /> Optional If ColCo Code is passed else Mandatory

Returns:

  • (Integer)


43
44
45
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 43

def col_co_id
  @col_co_id
end

#driver_nameString

Driver Name.<br /> Optional when VRN is passed else mandatory.<br /> Max length: 27<br /> The value will be validated against a configured list of allowed characters.<br /> Default value for the configuration is: [-0-9A-Z,/”.&amp; ÄÖÜÅÆÉØ]<br />

Returns:

  • (String)


90
91
92
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 90

def driver_name
  @driver_name
end

#emboss_card_groupTrueClass | FalseClass

This should be set to true if the card group name needs to be printed on the newly created card under a new card group.<br /> Optional<br /> Default – False<br /> Note: This value will be considered only if a new CardGroup is created for the Card.(i.e.when IsNewCardGroup is true)

If the Card is added to an existing CardGroup, 
the property ‘PrintOnCard’ set for the CardGroup will determine

whether the CardGroupName should be embossed on the Card.

Returns:

  • (TrueClass | FalseClass)


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

def emboss_card_group
  @emboss_card_group
end

#emboss_textString

Text to be printed on the card as Account Name.<br /> Optional – When not provided default emboss text associated with the card type will be embossed.<br /> Max length: 27<br /> The value should be validated against a configured list of allowed characters.<br />

-0-9A-Z,/”.&amp; ÄÖÜÅÆÉØ

Returns:

  • (String)


68
69
70
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 68

def emboss_text
  @emboss_text
end

#expiry_dateString

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

The expiry date which can be set for a card depends on the Card Type

and the associated business rules for the OU.

If the user chooses a later ExpiryDate than the allowed value for

the CardType for the OU,

Default Assigned Expiry Date will be applied on the card.

Returns:

  • (String)


338
339
340
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 338

def expiry_date
  @expiry_date
end

#fleet_id_input_requiredTrueClass | FalseClass

FleetId Input to be enabled on the card<br /> Optional.<br /> Default is False<br /> Note: If AllowFleetIdInput settings of the account is disabled and this flag is marked

true in the request, then request will be processed with VRN input

required

enabled instead of Fleet Id input required

Returns:

  • (TrueClass | FalseClass)


107
108
109
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 107

def fleet_id_input_required
  @fleet_id_input_required
end

#fleet_optionString

Type of action will be performed for the card when the fleet Id is validated.<br /> Optional.<br /> Default: NO_VALIDATION<br /> Allowed values:<br /> • ALERT<br /> • DECLINE<br /> • DECLINE_ALERT<br /> • NO_VALIDATION<br /> Note: When FleetIdOption is not provided and validatefleetid is true then by default allowed value is NO_VALIDATION.

Returns:

  • (String)


273
274
275
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 273

def fleet_option
  @fleet_option
end

#is_new_card_groupTrueClass | FalseClass

This need to be set to true if the card group needs to be created prior to processing the card order and the card needs to be assigned to the newly created card group.<br /> Optional<br /> Default - False

Returns:

  • (TrueClass | FalseClass)


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

def is_new_card_group
  @is_new_card_group
end

#notify_callerTrueClass | FalseClass

True/False.<br /> Optional.<br /> Default: False<br /> If true, the caller would be notified back with the status as success or failure after the card order is processed. This webhook feature has to be subscribed by the customer prior to use , please refer the API documentation for the more details.

Returns:

  • (TrueClass | FalseClass)


229
230
231
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 229

def notify_caller
  @notify_caller
end

#notify_caller_on_syncTrueClass | FalseClass

True/False.<br /> Optional.<br /> Default: False<br /> If true, the caller would be notified back with the status as success or failed after the processed card is synced with Gateway.

Returns:

  • (TrueClass | FalseClass)


248
249
250
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 248

def notify_caller_on_sync
  @notify_caller_on_sync
end

#odometer_input_requiredTrueClass | FalseClass

Odometer Input to be enabled on the card<br /> Optional.<br /> Default is False

Returns:

  • (TrueClass | FalseClass)


96
97
98
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 96

def odometer_input_required
  @odometer_input_required
end

#payer_idInteger

Payer Id of the selected payer.<br /> Optional if PayerNumber is passed else Mandatory

Returns:

  • (Integer)


15
16
17
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 15

def payer_id
  @payer_id
end

#payer_numberString

Payer Number of the selected payer.<br /> Optional if PayerId is passed else Mandatory

Returns:

  • (String)


20
21
22
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 20

def payer_number
  @payer_number
end

#pin_advice_typeInteger

PIN delivery method.<br /> Mandatory<br /> Allowed Values:<br />

  1. Paper<br />

  2. Email<br />

  3. SMS<br />

  4. None <br /> Note: Paper delivery not applicable for

selfselctedPIN type

Returns:

  • (Integer)


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

def pin_advice_type
  @pin_advice_type
end

#pin_contactPINContact

PIN delivery method.<br /> Mandatory<br /> Allowed Values:<br />

  1. Paper<br />

  2. Email<br />

  3. SMS<br />

  4. None <br /> Note: Paper delivery not applicable for

selfselctedPIN type

Returns:



219
220
221
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 219

def pin_contact
  @pin_contact
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)


197
198
199
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 197

def pin_delivery_address_type
  @pin_delivery_address_type
end

#product_groupsArray[String]

An array of product group ids.<br /> Optional.<br /> Default restrictions will be applied both products and product groups are null or empty.<br /> Note: This field is applicable when product restrictions are migrated to CFGW else, it will be ignored

Returns:

  • (Array[String])


324
325
326
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 324

def product_groups
  @product_groups
end

#product_restriction_actionString

The value indicates what actions is to be performed with respect to product restrictions on the card being ordered.<br /> ProductRestrictionAction is mandatory when bundle Id is passed. Else ignored.<br /> Allowed values: -<br /> • Update<br /> • Default<br /> • None<br /> Note: This field is applicable when product restrictions

Returns:

  • (String)


306
307
308
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 306

def product_restriction_action
  @product_restriction_action
end

#productsArray[String]

An array of 3-digit global product codes.<br /> Optional.<br /> Default restrictions will be applied both products and product groups are null or empty.<br /> Note: This field is applicable when product restrictions are migrated to CFGW else, it will be ignored.

Returns:

  • (Array[String])


315
316
317
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 315

def products
  @products
end

#purchase_category_idInteger

Purchase category Id<br /> Mandatory

Returns:

  • (Integer)


112
113
114
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 112

def purchase_category_id
  @purchase_category_id
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)


120
121
122
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 120

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)


126
127
128
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 126

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)


137
138
139
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 137

def self_selected_pin_session_key
  @self_selected_pin_session_key
end

#token_type_idInteger

Token Type Id – Linked to the selected card type<br /> Optional<br /> Default – Assign the default token type associated with the card type of the card being created.<br /> The default value will be set by the background process and an error (code 12009) will be thrown by the background process when default value is not identified or invalid token type id is passed in the request.

Returns:

  • (Integer)


58
59
60
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 58

def token_type_id
  @token_type_id
end

#usage_restriction_actionString

The value indicates what actions is to be performed with respect to usage restrictions on the card being ordered.<br /> UsageRestrictionAction is mandatory when bundle Id is passed. Else ignored.<br /> Allowed values: –<br /> • Update<br /> • Default<br /> • None

Returns:

  • (String)


294
295
296
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 294

def usage_restriction_action
  @usage_restriction_action
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)


259
260
261
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 259

def validate_fleet_id
  @validate_fleet_id
end

#vrnString

Vehicle registration number.<br/> Optional when DriverName is passed else mandatory.<br/> Mandatory when ColCo setting is marked as ‘VRN mandatory’.<br /> Max length: 24<br /> The value will be validated against a configured list of allowed characters.<br /> Default value for the configuration is: [-0-9A-Z,/”.&amp; ÄÖÜÅÆÉØ] . </br>Note: If Driver Name is null or empty, max allowed characters for VRN is 16. When Driver Name is provided, max allowed characters for VRN is 24.

Returns:

  • (String)


81
82
83
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 81

def vrn
  @vrn
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 548

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  card_delivery_type =
    hash.key?('CardDeliveryType') ? hash['CardDeliveryType'] : nil
  pin_advice_type = hash.key?('PINAdviceType') ? hash['PINAdviceType'] : nil
  payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
  payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
   = hash.key?('AccountId') ? hash['AccountId'] : SKIP
   = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
  col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
  col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
  card_type_id = hash.key?('CardTypeId') ? hash['CardTypeId'] : SKIP
  token_type_id = hash.key?('TokenTypeId') ? hash['TokenTypeId'] : SKIP
  emboss_text = hash.key?('EmbossText') ? hash['EmbossText'] : SKIP
  vrn = hash.key?('VRN') ? hash['VRN'] : SKIP
  driver_name = hash.key?('DriverName') ? hash['DriverName'] : SKIP
  odometer_input_required =
    hash.key?('OdometerInputRequired') ? hash['OdometerInputRequired'] : SKIP
  fleet_id_input_required =
    hash.key?('FleetIdInputRequired') ? hash['FleetIdInputRequired'] : SKIP
  purchase_category_id =
    hash.key?('PurchaseCategoryId') ? hash['PurchaseCategoryId'] : SKIP
  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
  card_group_id = hash.key?('CardGroupId') ? hash['CardGroupId'] : SKIP
  card_group_name =
    hash.key?('CardGroupName') ? hash['CardGroupName'] : SKIP
  is_new_card_group =
    hash.key?('IsNewCardGroup') ? hash['IsNewCardGroup'] : SKIP
  emboss_card_group =
    hash.key?('EmbossCardGroup') ? hash['EmbossCardGroup'] : SKIP
  card_contact = CardContact.from_hash(hash['CardContact']) if hash['CardContact']
  pin_delivery_address_type =
    hash.key?('PINDeliveryAddressType') ? hash['PINDeliveryAddressType'] : SKIP
  pin_contact = PINContact.from_hash(hash['PINContact']) if hash['PINContact']
  notify_caller = hash.key?('NotifyCaller') ? hash['NotifyCaller'] : SKIP
  caller = hash.key?('Caller') ? hash['Caller'] : SKIP
  notify_caller_on_sync =
    hash.key?('NotifyCallerOnSync') ? hash['NotifyCallerOnSync'] : SKIP
  validate_fleet_id =
    hash.key?('ValidateFleetId') ? hash['ValidateFleetId'] : SKIP
  fleet_option = hash.key?('FleetOption') ? hash['FleetOption'] : SKIP
  bundle_id = hash.key?('BundleId') ? hash['BundleId'] : SKIP
  usage_restriction_action =
    hash.key?('UsageRestrictionAction') ? hash['UsageRestrictionAction'] : SKIP
  product_restriction_action =
    hash.key?('ProductRestrictionAction') ? hash['ProductRestrictionAction'] : SKIP
  products = hash.key?('Products') ? hash['Products'] : SKIP
  product_groups = hash.key?('ProductGroups') ? hash['ProductGroups'] : SKIP
  expiry_date = hash.key?('ExpiryDate') ? hash['ExpiryDate'] : SKIP
  client_reference_id =
    hash.key?('ClientReferenceId') ? hash['ClientReferenceId'] : SKIP
  auto_renew = hash.key?('AutoRenew') ? hash['AutoRenew'] : SKIP

  # Create object from extracted values.
  CardDetail.new(card_delivery_type,
                 pin_advice_type,
                 payer_id,
                 payer_number,
                 ,
                 ,
                 col_co_code,
                 col_co_id,
                 card_type_id,
                 token_type_id,
                 emboss_text,
                 vrn,
                 driver_name,
                 odometer_input_required,
                 fleet_id_input_required,
                 purchase_category_id,
                 self_selected_encrypted_pin,
                 self_selected_pin_key_id,
                 self_selected_pin_session_key,
                 card_group_id,
                 card_group_name,
                 is_new_card_group,
                 emboss_card_group,
                 card_contact,
                 pin_delivery_address_type,
                 pin_contact,
                 notify_caller,
                 caller,
                 notify_caller_on_sync,
                 validate_fleet_id,
                 fleet_option,
                 bundle_id,
                 usage_restriction_action,
                 product_restriction_action,
                 products,
                 product_groups,
                 expiry_date,
                 client_reference_id,
                 auto_renew)
end

.namesObject

A mapping from model property names to API property names.



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 355

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['payer_id'] = 'PayerId'
  @_hash['payer_number'] = 'PayerNumber'
  @_hash['account_id'] = 'AccountId'
  @_hash['account_number'] = 'AccountNumber'
  @_hash['col_co_code'] = 'ColCoCode'
  @_hash['col_co_id'] = 'ColCoId'
  @_hash['card_type_id'] = 'CardTypeId'
  @_hash['token_type_id'] = 'TokenTypeId'
  @_hash['emboss_text'] = 'EmbossText'
  @_hash['vrn'] = 'VRN'
  @_hash['driver_name'] = 'DriverName'
  @_hash['odometer_input_required'] = 'OdometerInputRequired'
  @_hash['fleet_id_input_required'] = 'FleetIdInputRequired'
  @_hash['purchase_category_id'] = 'PurchaseCategoryId'
  @_hash['self_selected_encrypted_pin'] = 'SelfSelectedEncryptedPIN'
  @_hash['self_selected_pin_key_id'] = 'SelfSelectedPINKeyID'
  @_hash['self_selected_pin_session_key'] = 'SelfSelectedPINSessionKey'
  @_hash['card_group_id'] = 'CardGroupId'
  @_hash['card_group_name'] = 'CardGroupName'
  @_hash['is_new_card_group'] = 'IsNewCardGroup'
  @_hash['emboss_card_group'] = 'EmbossCardGroup'
  @_hash['card_delivery_type'] = 'CardDeliveryType'
  @_hash['card_contact'] = 'CardContact'
  @_hash['pin_delivery_address_type'] = 'PINDeliveryAddressType'
  @_hash['pin_advice_type'] = 'PINAdviceType'
  @_hash['pin_contact'] = 'PINContact'
  @_hash['notify_caller'] = 'NotifyCaller'
  @_hash['caller'] = 'Caller'
  @_hash['notify_caller_on_sync'] = 'NotifyCallerOnSync'
  @_hash['validate_fleet_id'] = 'ValidateFleetId'
  @_hash['fleet_option'] = 'FleetOption'
  @_hash['bundle_id'] = 'BundleId'
  @_hash['usage_restriction_action'] = 'UsageRestrictionAction'
  @_hash['product_restriction_action'] = 'ProductRestrictionAction'
  @_hash['products'] = 'Products'
  @_hash['product_groups'] = 'ProductGroups'
  @_hash['expiry_date'] = 'ExpiryDate'
  @_hash['client_reference_id'] = 'ClientReferenceId'
  @_hash['auto_renew'] = 'AutoRenew'
  @_hash
end

.nullablesObject

An array for nullable fields



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
# File 'lib/shell_card_management_ap_is/models/card_detail.rb', line 443

def self.nullables
  %w[
    payer_id
    payer_number
    account_id
    account_number
    col_co_code
    col_co_id
    card_type_id
    token_type_id
    emboss_text
    vrn
    driver_name
    purchase_category_id
    self_selected_pin_key_id
    self_selected_pin_session_key
    card_group_id
    card_group_name
    card_delivery_type
    pin_delivery_address_type
    pin_advice_type
    caller
    fleet_option
    bundle_id
    usage_restriction_action
    product_restriction_action
    expiry_date
    client_reference_id
  ]
end

.optionalsObject

An array for optional fields



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

def self.optionals
  %w[
    payer_id
    payer_number
    account_id
    account_number
    col_co_code
    col_co_id
    card_type_id
    token_type_id
    emboss_text
    vrn
    driver_name
    odometer_input_required
    fleet_id_input_required
    purchase_category_id
    self_selected_encrypted_pin
    self_selected_pin_key_id
    self_selected_pin_session_key
    card_group_id
    card_group_name
    is_new_card_group
    emboss_card_group
    card_contact
    pin_delivery_address_type
    pin_contact
    notify_caller
    caller
    notify_caller_on_sync
    validate_fleet_id
    fleet_option
    bundle_id
    usage_restriction_action
    product_restriction_action
    products
    product_groups
    expiry_date
    client_reference_id
    auto_renew
  ]
end