Class: ShellCardManagementApIs::SearchRequest

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

Overview

Encapsulate the Search details request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(card_status = nil, account_id = SKIP, account_number = SKIP, card_group_id = SKIP, card_group_name = SKIP, card_segment = SKIP, card_type_code = SKIP, col_co_code = SKIP, col_co_country_code = SKIP, col_co_id = SKIP, coverage = SKIP, creation_date = SKIP, driver_name = SKIP, effective_date = SKIP, exclude_bundle_id = SKIP, exclude_cancelled_cards = SKIP, exclude_card_group_id = SKIP, exclude_card_group_name = SKIP, exclude_cards = SKIP, exclude_fraud_cards = SKIP, exclude_pending_renewal_cards = SKIP, exclude_replaced_cards = SKIP, expiring_in_days = SKIP, expiry_month = SKIP, include_bundle_details = SKIP, include_cards = SKIP, include_intermediate_status = SKIP, issued_after = SKIP, network = SKIP, pan_ends_with = SKIP, payer_id = SKIP, payer_number = SKIP, purchase_category_code = SKIP, sort_order = SKIP, include_scheduled_card_blocks = SKIP, token_type_id = SKIP, token_type_name = SKIP, vehicle_registration_number = SKIP, exclude_old_cards = SKIP, exclude_expiring_cards = SKIP, client_reference_id = SKIP, reissue_setting = SKIP, request_id = SKIP) ⇒ SearchRequest

Returns a new instance of SearchRequest.



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
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 491

def initialize(card_status = nil,  = SKIP,  = SKIP,
               card_group_id = SKIP, card_group_name = SKIP,
               card_segment = SKIP, card_type_code = SKIP,
               col_co_code = SKIP, col_co_country_code = SKIP,
               col_co_id = SKIP, coverage = SKIP, creation_date = SKIP,
               driver_name = SKIP, effective_date = SKIP,
               exclude_bundle_id = SKIP, exclude_cancelled_cards = SKIP,
               exclude_card_group_id = SKIP, exclude_card_group_name = SKIP,
               exclude_cards = SKIP, exclude_fraud_cards = SKIP,
               exclude_pending_renewal_cards = SKIP,
               exclude_replaced_cards = SKIP, expiring_in_days = SKIP,
               expiry_month = SKIP, include_bundle_details = SKIP,
               include_cards = SKIP, include_intermediate_status = SKIP,
               issued_after = SKIP, network = SKIP, pan_ends_with = SKIP,
               payer_id = SKIP, payer_number = SKIP,
               purchase_category_code = SKIP, sort_order = SKIP,
               include_scheduled_card_blocks = SKIP, token_type_id = SKIP,
               token_type_name = SKIP, vehicle_registration_number = SKIP,
               exclude_old_cards = SKIP, exclude_expiring_cards = SKIP,
               client_reference_id = SKIP, reissue_setting = SKIP,
               request_id = SKIP)
  @account_id =  unless  == SKIP
  @account_number =  unless  == SKIP
  @card_group_id = card_group_id unless card_group_id == SKIP
  @card_group_name = card_group_name unless card_group_name == SKIP
  @card_segment = card_segment unless card_segment == SKIP
  @card_status = card_status
  @card_type_code = card_type_code unless card_type_code == SKIP
  @col_co_code = col_co_code unless col_co_code == SKIP
  @col_co_country_code = col_co_country_code unless col_co_country_code == SKIP
  @col_co_id = col_co_id unless col_co_id == SKIP
  @coverage = coverage unless coverage == SKIP
  @creation_date = creation_date unless creation_date == SKIP
  @driver_name = driver_name unless driver_name == SKIP
  @effective_date = effective_date unless effective_date == SKIP
  @exclude_bundle_id = exclude_bundle_id unless exclude_bundle_id == SKIP
  @exclude_cancelled_cards = exclude_cancelled_cards unless exclude_cancelled_cards == SKIP
  @exclude_card_group_id = exclude_card_group_id unless exclude_card_group_id == SKIP
  @exclude_card_group_name = exclude_card_group_name unless exclude_card_group_name == SKIP
  @exclude_cards = exclude_cards unless exclude_cards == SKIP
  @exclude_fraud_cards = exclude_fraud_cards unless exclude_fraud_cards == SKIP
  unless exclude_pending_renewal_cards == SKIP
    @exclude_pending_renewal_cards =
      exclude_pending_renewal_cards
  end
  @exclude_replaced_cards = exclude_replaced_cards unless exclude_replaced_cards == SKIP
  @expiring_in_days = expiring_in_days unless expiring_in_days == SKIP
  @expiry_month = expiry_month unless expiry_month == SKIP
  @include_bundle_details = include_bundle_details unless include_bundle_details == SKIP
  @include_cards = include_cards unless include_cards == SKIP
  unless include_intermediate_status == SKIP
    @include_intermediate_status =
      include_intermediate_status
  end
  @issued_after = issued_after unless issued_after == SKIP
  @network = network unless network == SKIP
  @pan_ends_with = pan_ends_with unless pan_ends_with == SKIP
  @payer_id = payer_id unless payer_id == SKIP
  @payer_number = payer_number unless payer_number == SKIP
  @purchase_category_code = purchase_category_code unless purchase_category_code == SKIP
  @sort_order = sort_order unless sort_order == SKIP
  unless include_scheduled_card_blocks == SKIP
    @include_scheduled_card_blocks =
      include_scheduled_card_blocks
  end
  @token_type_id = token_type_id unless token_type_id == SKIP
  @token_type_name = token_type_name unless token_type_name == SKIP
  unless vehicle_registration_number == SKIP
    @vehicle_registration_number =
      vehicle_registration_number
  end
  @exclude_old_cards = exclude_old_cards unless exclude_old_cards == SKIP
  @exclude_expiring_cards = exclude_expiring_cards unless exclude_expiring_cards == SKIP
  @client_reference_id = client_reference_id unless client_reference_id == SKIP
  @reissue_setting = reissue_setting unless reissue_setting == SKIP
  @request_id = request_id unless request_id == SKIP
end

Instance Attribute Details

#account_id ⇒ Integer

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

Returns:

  • (Integer) 


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

def 
  @account_id
end

#account_number ⇒ String

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

Returns:

  • (String) 


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

def 
  @account_number
end

#card_group_id ⇒ Integer

Card group id. <br /> Optional.<br /> This input is a search criterion, if given.<br /> When -1 is passed, those cards that does not belong to any card group will be returned.

Returns:

  • (Integer) 


28
29
30
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 28

def card_group_id
  @card_group_id
end

#card_group_name ⇒ String

Card group name.<br /> Optional.<br /> This input is a search criterion, if given.<br /> If CardGroupId is provided then this search criterion will be ignored, else, those cards that have the card group name completely matching with the entered value will be returned.

Returns:

  • (String) 


37
38
39
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 37

def card_group_name
  @card_group_name
end

#card_segment ⇒ String

Market segment to which card belongs to.<br /> Optional.<br /> Allowed values<br /> • CRT<br /> • Fleet

Returns:

  • (String) 


45
46
47
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 45

def card_segment
  @card_segment
end

#card_status ⇒ Array[String]

Status of the card.<br /> Mandatory.<br /> Multiple statuses are allowed to be included in the search criteria.<br /> CardStatus filter accepts either of the two values for each status as described below. However, the output field “StatusDescription” is aligned with second value highlighted in italics.<br /> Below are the possible allowed statuses: <br /> • ACTIVE or Active – Cards at status Active if the IncludeIntermediateStatus flag is true: Active (Block in progress), Active (Cancel in progress), Active (Marked as damaged)), New (Cancel in progress).<br /> • ON_ORDER or New – Cards at status New<br /> • EXPIRED or Expired – Cards at status Expired<br /> • BLOCKED or Blocked Card – Cards at status Block (The result will include all cards having the following intermediate status, if the IncludeIntermediateStatus flag is true: Blocked card (Unblock in progress))<br /> • TEMP_BLOCKED_CUSTOMER or Temporary Block(Customer) – Cards at status Temporary Blocked By Customer<br /> • TEMP_BLOCKED_SHELL or Temporary Block (Shell) – Cards at Status Temporary Blocked by Shell<br /> • CANCELLED or Cancelled – Cards at status Cancelled<br /> • PENDING_RENEWAL or Pending Renewal - Cards that are in renewal process<br /> • REPLACED or Replaced – Cards at Status Replaced<br /> • FRAUD or Fraud – Cards at Status FRAUD<br /> • ALL

Returns:

  • (Array[String]) 


75
76
77
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 75

def card_status
  @card_status
end

#card_type_code ⇒ String

ISO code of the card i.e. first 7 digits of the PAN<br /> Optional.

Returns:

  • (String) 


80
81
82
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 80

def card_type_code
  @card_type_code
end

#client_reference_id ⇒ String

Customer reference number of the card.

Returns:

  • (String) 


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

def client_reference_id
  @client_reference_id
end

#col_co_code ⇒ Integer

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

Returns:

  • (Integer) 


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

def col_co_code
  @col_co_code
end

#col_co_country_code ⇒ String

The 2 character ISO Code for the customer and card owning country.<br /> Optional If ColCoId or ColCoCode is passed else Mandatory.<br />

Returns:

  • (String) 


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

def col_co_country_code
  @col_co_country_code
end

#col_co_id ⇒ Integer

Collecting Company Id of the selected payer. <br /> Optional If ColCoCode or ColCoCountryCode is passed else Mandatory <br />

Returns:

  • (Integer) 


95
96
97
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 95

def col_co_id
  @col_co_id
end

#coverage ⇒ String

Cards allowed to used nationally/internationally.<br /> Optional.<br /> Allowed values<br /> -National<br /> -International

Returns:

  • (String) 


103
104
105
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 103

def coverage
  @coverage
end

#creation_date ⇒ String

Card Creation Date<br /> Optional<br /> Format: yyyyMMdd

Returns:

  • (String) 


109
110
111
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 109

def creation_date
  @creation_date
end

#driver_name ⇒ Array[String]

Driver Name embossed on the card<br /> Optional<br /> Up to 10 driver names could be passed in the parameter.<br /> Minimum of 4 characters should be provided for each driver name else not considered.<br /> Those cards will be returned when part of the driver name matches with any of the string passed in the list.<br /> Max Length for each Driver name: 50

Returns:

  • (Array[String]) 


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

def driver_name
  @driver_name
end

#effective_date ⇒ String

Effective date for the Card<br /> Optional<br /> Format: yyyyMMdd<br />

Returns:

  • (String) 


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

def effective_date
  @effective_date
end

#exclude_bundle_id ⇒ String

Bundle Id for the Card, which needs to be excluded in the response.<br /> Optional

Returns:

  • (String) 


131
132
133
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 131

def exclude_bundle_id
  @exclude_bundle_id
end

#exclude_cancelled_cards ⇒ TrueClass | FalseClass

Default value is True.<br /> When true, the API will not return cards that are at Cancelled Status in Cards Platform<br />

Returns:

  • (TrueClass | FalseClass) 


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

def exclude_cancelled_cards
  @exclude_cancelled_cards
end

#exclude_card_group_id ⇒ Integer

Optional<br /> When passed, the API will not return cards that are currently in the Card Group specified<br />

Returns:

  • (Integer) 


143
144
145
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 143

def exclude_card_group_id
  @exclude_card_group_id
end

#exclude_card_group_name ⇒ String

Optional<br /> When passed, the API will not return cards that are currently in the Card Group specified<br />

Returns:

  • (String) 


149
150
151
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 149

def exclude_card_group_name
  @exclude_card_group_name
end

#exclude_cards ⇒ Array[SearchCard]

List of SearchCard entity i.e., Card Id or PAN, which needs to be excluded in the response. <br /> Details of the SerachCard entity are given below.<br />

Returns:



155
156
157
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 155

def exclude_cards
  @exclude_cards
end

#exclude_expiring_cards ⇒ TrueClass | FalseClass

Default value is False.<br /> When true, the API will not return cards that are expiring <br /> within 120 (i.e. Configured) days, if the status of the card is 1 or 41 or 42 in Cards platform.

Returns:

  • (TrueClass | FalseClass) 


320
321
322
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 320

def exclude_expiring_cards
  @exclude_expiring_cards
end

#exclude_fraud_cards ⇒ TrueClass | FalseClass

Default value is False.<br /> When true, the API will not return cards that are at Fraud Status in Cards Platform<br />

Returns:

  • (TrueClass | FalseClass) 


161
162
163
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 161

def exclude_fraud_cards
  @exclude_fraud_cards
end

#exclude_old_cards ⇒ TrueClass | FalseClass

Default Value: False<br /> When this field is set to True, cards with below status 2 years (configurable) ago and earlier are excluded from the result<br /> -Blocked Card<br /> -Expired<br /> -Cancelled<br /> -Suspended<br /> -Blocked<br /> -Expired and Cancelled<br /> -Replaced<br /> -Replaced By<br /> -Closed<br /> -Fraud<br />

Returns:

  • (TrueClass | FalseClass) 


313
314
315
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 313

def exclude_old_cards
  @exclude_old_cards
end

#exclude_pending_renewal_cards ⇒ TrueClass | FalseClass

Default value is True.<br /> When true, the API will not return cards that are at Pending Renewal Status in Cards Platform

Returns:

  • (TrueClass | FalseClass) 


167
168
169
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 167

def exclude_pending_renewal_cards
  @exclude_pending_renewal_cards
end

#exclude_replaced_cards ⇒ TrueClass | FalseClass

Default value is False.<br /> When true, the API will not return cards that are at Replaced Status in Cards Platform<br />

Returns:

  • (TrueClass | FalseClass) 


173
174
175
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 173

def exclude_replaced_cards
  @exclude_replaced_cards
end

#expiring_in_days ⇒ Integer

Cards active and expiring in given number of days.<br /> Optional<br /> Note: When a value is passed in this parameter, only active cards will be considered while searching.<br />

Returns:

  • (Integer) 


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

def expiring_in_days
  @expiring_in_days
end

#expiry_month ⇒ String

Month in which the card is expiring.<br /> Optional.<br /> Format: MMYYYY<br />

Returns:

  • (String) 


186
187
188
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 186

def expiry_month
  @expiry_month
end

#include_bundle_details ⇒ TrueClass | FalseClass

Default value is False,<br /> When the value is True, API will return bundle Id associated with card in response.<br />

Returns:

  • (TrueClass | FalseClass) 


192
193
194
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 192

def include_bundle_details
  @include_bundle_details
end

#include_cards ⇒ Array[SearchCard]

List of SearchCard entity i.e., Card Id or PAN, which needs to be included in the response.<br /> Details of the SerachCard entity are given below.<br />

Returns:



198
199
200
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 198

def include_cards
  @include_cards
end

#include_intermediate_status ⇒ TrueClass | FalseClass

A flag which indicates if the response can contain intermediate statuses.<br /> Optional<br /> Default: false

Returns:

  • (TrueClass | FalseClass) 


205
206
207
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 205

def include_intermediate_status
  @include_intermediate_status
end

#include_scheduled_card_blocks ⇒ TrueClass | FalseClass

A flag which indicates if the response can contain scheduled card blocks details<br /> Optional<br /> Default: false

Returns:

  • (TrueClass | FalseClass) 


275
276
277
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 275

def include_scheduled_card_blocks
  @include_scheduled_card_blocks
end

#issued_after ⇒ String

If provided, only list cards issued after the given date<br /> Optional<br /> Format: yyyyMMdd<br /> Note: Clients to convert this to appropriate DateTime type.

Returns:

  • (String) 


212
213
214
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 212

def issued_after
  @issued_after
end

#network ⇒ String

Cards allowed to be used in site.<br /> Optional.<br /> Allowed values<br /> -ShellSitesOnly<br /> -PartnersSitesIncluded

Returns:

  • (String) 


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

def network
  @network
end

#pan_ends_with ⇒ String

Last digits of the PAN number<br /> Minimum 4 last digits of the card should be sent for this field to be considered as part of the search criteria.<br /> Optional<br /> Max Length: 50

Returns:

  • (String) 


228
229
230
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 228

def pan_ends_with
  @pan_ends_with
end

#payer_id ⇒ Integer

Payer Id (i.e. Customer Id of the Payment Customer) of the selected payer.<br /> Optional if PayerNumber is passed else Mandatory<br /> Example: 123456

Returns:

  • (Integer) 


235
236
237
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 235

def payer_id
  @payer_id
end

#payer_number ⇒ String

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

Returns:

  • (String) 


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

def payer_number
  @payer_number
end

#purchase_category_code ⇒ String

Purchase category code of the card.<br /> Optional.

Returns:

  • (String) 


245
246
247
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 245

def purchase_category_code
  @purchase_category_code
end

#reissue_setting ⇒ String

Default Value: All<br /> Optional<br /> This option is used to filter the list of cards with ‘ReissueSetting’.<br /> If ‘True’, the API will return cards with ReIssueSetting value is true.<br /> If ‘False’, the API will return cards with ReIsssueSetting value is false.<br /> If ‘ALL’, API will return cards with ReIssueSetting value True &amp; False both.<br /> Allowed Values:<br />

  1. All<br />

  2. True<br />

  3. False

Returns:

  • (String) 


341
342
343
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 341

def reissue_setting
  @reissue_setting
end

#request_id ⇒ String

Default Value: All<br /> Optional<br /> This option is used to filter the list of cards with ‘ReissueSetting’.<br /> If ‘True’, the API will return cards with ReIssueSetting value is true.<br /> If ‘False’, the API will return cards with ReIsssueSetting value is false.<br /> If ‘ALL’, API will return cards with ReIssueSetting value True &amp; False both.<br /> Allowed Values:<br />

  1. All<br />

  2. True<br />

  3. False

Returns:

  • (String) 


358
359
360
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 358

def request_id
  @request_id
end

#sort_order ⇒ String

Possible options are:<br /> 1.ExpiringDateAscending<br /> 2.ExpiringDateDescending<br /> 3.DriverNameAscending(If Driver Name is null then VRN value will be considered)<br /> 4.DriverNameDescending(If Driver Name is null then VRN value will be considered)<br /> 5.VRNAscending(If VRN is null then Driver Name value will be considered)<br /> 6.VRNDescending(If VRN is null then Driver Name value will be considered)<br /> 7.LastUsedDateAscending<br /> 8.LastUsedDateDescending<br /> 9.IssueDateAscending<br /> 10.IssueDateDescending<br /> 11.PurchaseCategoryCodeAscending<br /> 12.PurchaseCategoryCodeDescending<br /> 13.CardSegmentAscending (CRT will appear first)<br /> 14.CardSegmentDescending (Fleet will appear first)<br /> Optional

Returns:

  • (String) 


268
269
270
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 268

def sort_order
  @sort_order
end

#token_type_id ⇒ Integer

Token Type ID for the Card<br /> Optional

Returns:

  • (Integer) 


280
281
282
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 280

def token_type_id
  @token_type_id
end

#token_type_name ⇒ String

Token Type name for the Card<br /> Optional

Returns:

  • (String) 


285
286
287
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 285

def token_type_name
  @token_type_name
end

#vehicle_registration_number ⇒ Array[String]

Vehicle Registration embossed on the card<br /> Optional<br /> Up to 10 vehicle registration numbers could be passed in the parameter.<br /> Minimum of 4 characters should be provided for each VRN else not considered<br /> Those cards will be returned when part of the VRN matches with any of the string passed in the list.<br /> Max Length for each VRN: 50

Returns:

  • (Array[String]) 


297
298
299
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 297

def vehicle_registration_number
  @vehicle_registration_number
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
649
650
651
652
653
654
655
656
657
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
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 570

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  card_status = hash.key?('CardStatus') ? hash['CardStatus'] : nil
   = hash.key?('AccountId') ? hash['AccountId'] : SKIP
   = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
  card_group_id = hash.key?('CardGroupId') ? hash['CardGroupId'] : SKIP
  card_group_name =
    hash.key?('CardGroupName') ? hash['CardGroupName'] : SKIP
  card_segment = hash.key?('CardSegment') ? hash['CardSegment'] : SKIP
  card_type_code = hash.key?('CardTypeCode') ? hash['CardTypeCode'] : SKIP
  col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
  col_co_country_code =
    hash.key?('ColCoCountryCode') ? hash['ColCoCountryCode'] : SKIP
  col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
  coverage = hash.key?('Coverage') ? hash['Coverage'] : SKIP
  creation_date = hash.key?('CreationDate') ? hash['CreationDate'] : SKIP
  driver_name = hash.key?('DriverName') ? hash['DriverName'] : SKIP
  effective_date = hash.key?('EffectiveDate') ? hash['EffectiveDate'] : SKIP
  exclude_bundle_id =
    hash.key?('ExcludeBundleId') ? hash['ExcludeBundleId'] : SKIP
  exclude_cancelled_cards =
    hash.key?('ExcludeCancelledCards') ? hash['ExcludeCancelledCards'] : SKIP
  exclude_card_group_id =
    hash.key?('ExcludeCardGroupId') ? hash['ExcludeCardGroupId'] : SKIP
  exclude_card_group_name =
    hash.key?('ExcludeCardGroupName') ? hash['ExcludeCardGroupName'] : SKIP
  # Parameter is an array, so we need to iterate through it
  exclude_cards = nil
  unless hash['ExcludeCards'].nil?
    exclude_cards = []
    hash['ExcludeCards'].each do |structure|
      exclude_cards << (SearchCard.from_hash(structure) if structure)
    end
  end

  exclude_cards = SKIP unless hash.key?('ExcludeCards')
  exclude_fraud_cards =
    hash.key?('ExcludeFraudCards') ? hash['ExcludeFraudCards'] : SKIP
  exclude_pending_renewal_cards =
    hash.key?('ExcludePendingRenewalCards') ? hash['ExcludePendingRenewalCards'] : SKIP
  exclude_replaced_cards =
    hash.key?('ExcludeReplacedCards') ? hash['ExcludeReplacedCards'] : SKIP
  expiring_in_days =
    hash.key?('ExpiringInDays') ? hash['ExpiringInDays'] : SKIP
  expiry_month = hash.key?('ExpiryMonth') ? hash['ExpiryMonth'] : SKIP
  include_bundle_details =
    hash.key?('IncludeBundleDetails') ? hash['IncludeBundleDetails'] : SKIP
  # Parameter is an array, so we need to iterate through it
  include_cards = nil
  unless hash['IncludeCards'].nil?
    include_cards = []
    hash['IncludeCards'].each do |structure|
      include_cards << (SearchCard.from_hash(structure) if structure)
    end
  end

  include_cards = SKIP unless hash.key?('IncludeCards')
  include_intermediate_status =
    hash.key?('IncludeIntermediateStatus') ? hash['IncludeIntermediateStatus'] : SKIP
  issued_after = hash.key?('IssuedAfter') ? hash['IssuedAfter'] : SKIP
  network = hash.key?('Network') ? hash['Network'] : SKIP
  pan_ends_with = hash.key?('PANEndsWith') ? hash['PANEndsWith'] : SKIP
  payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
  payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
  purchase_category_code =
    hash.key?('PurchaseCategoryCode') ? hash['PurchaseCategoryCode'] : SKIP
  sort_order = hash.key?('SortOrder') ? hash['SortOrder'] : SKIP
  include_scheduled_card_blocks =
    hash.key?('IncludeScheduledCardBlocks') ? hash['IncludeScheduledCardBlocks'] : SKIP
  token_type_id = hash.key?('TokenTypeID') ? hash['TokenTypeID'] : SKIP
  token_type_name =
    hash.key?('TokenTypeName') ? hash['TokenTypeName'] : SKIP
  vehicle_registration_number =
    hash.key?('VehicleRegistrationNumber') ? hash['VehicleRegistrationNumber'] : SKIP
  exclude_old_cards =
    hash.key?('ExcludeOldCards') ? hash['ExcludeOldCards'] : SKIP
  exclude_expiring_cards =
    hash.key?('ExcludeExpiringCards') ? hash['ExcludeExpiringCards'] : SKIP
  client_reference_id =
    hash.key?('ClientReferenceId') ? hash['ClientReferenceId'] : SKIP
  reissue_setting =
    hash.key?('ReissueSetting') ? hash['ReissueSetting'] : SKIP
  request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP

  # Create object from extracted values.
  SearchRequest.new(card_status,
                    ,
                    ,
                    card_group_id,
                    card_group_name,
                    card_segment,
                    card_type_code,
                    col_co_code,
                    col_co_country_code,
                    col_co_id,
                    coverage,
                    creation_date,
                    driver_name,
                    effective_date,
                    exclude_bundle_id,
                    exclude_cancelled_cards,
                    exclude_card_group_id,
                    exclude_card_group_name,
                    exclude_cards,
                    exclude_fraud_cards,
                    exclude_pending_renewal_cards,
                    exclude_replaced_cards,
                    expiring_in_days,
                    expiry_month,
                    include_bundle_details,
                    include_cards,
                    include_intermediate_status,
                    issued_after,
                    network,
                    pan_ends_with,
                    payer_id,
                    payer_number,
                    purchase_category_code,
                    sort_order,
                    include_scheduled_card_blocks,
                    token_type_id,
                    token_type_name,
                    vehicle_registration_number,
                    exclude_old_cards,
                    exclude_expiring_cards,
                    client_reference_id,
                    reissue_setting,
                    request_id)
end

.names ⇒ Object

A mapping from model property names to API property names.



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
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 361

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['account_id'] = 'AccountId'
  @_hash['account_number'] = 'AccountNumber'
  @_hash['card_group_id'] = 'CardGroupId'
  @_hash['card_group_name'] = 'CardGroupName'
  @_hash['card_segment'] = 'CardSegment'
  @_hash['card_status'] = 'CardStatus'
  @_hash['card_type_code'] = 'CardTypeCode'
  @_hash['col_co_code'] = 'ColCoCode'
  @_hash['col_co_country_code'] = 'ColCoCountryCode'
  @_hash['col_co_id'] = 'ColCoId'
  @_hash['coverage'] = 'Coverage'
  @_hash['creation_date'] = 'CreationDate'
  @_hash['driver_name'] = 'DriverName'
  @_hash['effective_date'] = 'EffectiveDate'
  @_hash['exclude_bundle_id'] = 'ExcludeBundleId'
  @_hash['exclude_cancelled_cards'] = 'ExcludeCancelledCards'
  @_hash['exclude_card_group_id'] = 'ExcludeCardGroupId'
  @_hash['exclude_card_group_name'] = 'ExcludeCardGroupName'
  @_hash['exclude_cards'] = 'ExcludeCards'
  @_hash['exclude_fraud_cards'] = 'ExcludeFraudCards'
  @_hash['exclude_pending_renewal_cards'] = 'ExcludePendingRenewalCards'
  @_hash['exclude_replaced_cards'] = 'ExcludeReplacedCards'
  @_hash['expiring_in_days'] = 'ExpiringInDays'
  @_hash['expiry_month'] = 'ExpiryMonth'
  @_hash['include_bundle_details'] = 'IncludeBundleDetails'
  @_hash['include_cards'] = 'IncludeCards'
  @_hash['include_intermediate_status'] = 'IncludeIntermediateStatus'
  @_hash['issued_after'] = 'IssuedAfter'
  @_hash['network'] = 'Network'
  @_hash['pan_ends_with'] = 'PANEndsWith'
  @_hash['payer_id'] = 'PayerId'
  @_hash['payer_number'] = 'PayerNumber'
  @_hash['purchase_category_code'] = 'PurchaseCategoryCode'
  @_hash['sort_order'] = 'SortOrder'
  @_hash['include_scheduled_card_blocks'] = 'IncludeScheduledCardBlocks'
  @_hash['token_type_id'] = 'TokenTypeID'
  @_hash['token_type_name'] = 'TokenTypeName'
  @_hash['vehicle_registration_number'] = 'VehicleRegistrationNumber'
  @_hash['exclude_old_cards'] = 'ExcludeOldCards'
  @_hash['exclude_expiring_cards'] = 'ExcludeExpiringCards'
  @_hash['client_reference_id'] = 'ClientReferenceId'
  @_hash['reissue_setting'] = 'ReissueSetting'
  @_hash['request_id'] = 'RequestId'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  %w[
    account_id
    account_number
    card_group_id
    card_group_name
    card_segment
    card_type_code
    col_co_code
    col_co_country_code
    col_co_id
    coverage
    creation_date
    effective_date
    exclude_bundle_id
    exclude_card_group_id
    exclude_card_group_name
    expiring_in_days
    expiry_month
    issued_after
    network
    pan_ends_with
    payer_id
    payer_number
    purchase_category_code
    sort_order
    token_type_id
    token_type_name
    client_reference_id
    reissue_setting
  ]
end

.optionals ⇒ Object

An array for optional fields



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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/shell_card_management_ap_is/models/search_request.rb', line 410

def self.optionals
  %w[
    account_id
    account_number
    card_group_id
    card_group_name
    card_segment
    card_type_code
    col_co_code
    col_co_country_code
    col_co_id
    coverage
    creation_date
    driver_name
    effective_date
    exclude_bundle_id
    exclude_cancelled_cards
    exclude_card_group_id
    exclude_card_group_name
    exclude_cards
    exclude_fraud_cards
    exclude_pending_renewal_cards
    exclude_replaced_cards
    expiring_in_days
    expiry_month
    include_bundle_details
    include_cards
    include_intermediate_status
    issued_after
    network
    pan_ends_with
    payer_id
    payer_number
    purchase_category_code
    sort_order
    include_scheduled_card_blocks
    token_type_id
    token_type_name
    vehicle_registration_number
    exclude_old_cards
    exclude_expiring_cards
    client_reference_id
    reissue_setting
    request_id
  ]
end