Class: ShellCardManagementApIs::RestrictionCardList

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

Overview

RestrictionCardList Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(card_id = SKIP, pan = SKIP, expiry_date = SKIP, status_id = SKIP, status_description = SKIP, driver_name = SKIP, vrn = SKIP, issue_date = SKIP, issue_number = SKIP, account_id = SKIP, account_number = SKIP, account_name = SKIP, account_short_name = SKIP, currency_code = SKIP, col_co_currency_code = SKIP, col_co_currency_symbol = SKIP, restriction_currency_code = SKIP, restriction_currency_symbol = SKIP, purchase_category_id = SKIP, purchase_category_code = SKIP, purchase_category_name = SKIP, is_superseded = SKIP, is_virtual_card = SKIP, is_national = SKIP, is_international = SKIP, is_crt = SKIP, is_fleet = SKIP, is_shell_sites_only = SKIP, is_partner_sites_included = SKIP, card_type_id = SKIP, card_type_code = SKIP, card_type_name = SKIP, bundle_id = SKIP, medium_type_id = SKIP, medium_type = SKIP) ⇒ RestrictionCardList

Returns a new instance of RestrictionCardList.



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
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
373
374
375
376
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 315

def initialize(card_id = SKIP, pan = SKIP, expiry_date = SKIP,
               status_id = SKIP, status_description = SKIP,
               driver_name = SKIP, vrn = SKIP, issue_date = SKIP,
               issue_number = SKIP,  = SKIP,
                = SKIP,  = SKIP,
                = SKIP, currency_code = SKIP,
               col_co_currency_code = SKIP, col_co_currency_symbol = SKIP,
               restriction_currency_code = SKIP,
               restriction_currency_symbol = SKIP,
               purchase_category_id = SKIP, purchase_category_code = SKIP,
               purchase_category_name = SKIP, is_superseded = SKIP,
               is_virtual_card = SKIP, is_national = SKIP,
               is_international = SKIP, is_crt = SKIP, is_fleet = SKIP,
               is_shell_sites_only = SKIP, is_partner_sites_included = SKIP,
               card_type_id = SKIP, card_type_code = SKIP,
               card_type_name = SKIP, bundle_id = SKIP,
               medium_type_id = SKIP, medium_type = SKIP)
  @card_id = card_id unless card_id == SKIP
  @pan = pan unless pan == SKIP
  @expiry_date = expiry_date unless expiry_date == SKIP
  @status_id = status_id unless status_id == SKIP
  @status_description = status_description unless status_description == SKIP
  @driver_name = driver_name unless driver_name == SKIP
  @vrn = vrn unless vrn == SKIP
  @issue_date = issue_date unless issue_date == SKIP
  @issue_number = issue_number unless issue_number == SKIP
  @account_id =  unless  == SKIP
  @account_number =  unless  == SKIP
  @account_name =  unless  == SKIP
  @account_short_name =  unless  == SKIP
  @currency_code = currency_code unless currency_code == SKIP
  @col_co_currency_code = col_co_currency_code unless col_co_currency_code == SKIP
  @col_co_currency_symbol = col_co_currency_symbol unless col_co_currency_symbol == SKIP
  unless restriction_currency_code == SKIP
    @restriction_currency_code =
      restriction_currency_code
  end
  unless restriction_currency_symbol == SKIP
    @restriction_currency_symbol =
      restriction_currency_symbol
  end
  @purchase_category_id = purchase_category_id unless purchase_category_id == SKIP
  @purchase_category_code = purchase_category_code unless purchase_category_code == SKIP
  @purchase_category_name = purchase_category_name unless purchase_category_name == SKIP
  @is_superseded = is_superseded unless is_superseded == SKIP
  @is_virtual_card = is_virtual_card unless is_virtual_card == SKIP
  @is_national = is_national unless is_national == SKIP
  @is_international = is_international unless is_international == SKIP
  @is_crt = is_crt unless is_crt == SKIP
  @is_fleet = is_fleet unless is_fleet == SKIP
  @is_shell_sites_only = is_shell_sites_only unless is_shell_sites_only == SKIP
  unless is_partner_sites_included == SKIP
    @is_partner_sites_included =
      is_partner_sites_included
  end
  @card_type_id = card_type_id unless card_type_id == SKIP
  @card_type_code = card_type_code unless card_type_code == SKIP
  @card_type_name = card_type_name unless card_type_name == SKIP
  @bundle_id = bundle_id unless bundle_id == SKIP
  @medium_type_id = medium_type_id unless medium_type_id == SKIP
  @medium_type = medium_type unless medium_type == SKIP
end

Instance Attribute Details

#account_idInteger

Account ID Example: 29484

Returns:

  • (Integer)


57
58
59
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 57

def 
  @account_id
end

#account_nameString

Account Name Example: MATTHEW ALGIE & COMPANY LIMITED

Returns:

  • (String)


67
68
69
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 67

def 
  @account_name
end

#account_numberString

Account Number Example: GB99215176

Returns:

  • (String)


62
63
64
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 62

def 
  @account_number
end

#account_short_nameString

Account Short Name

Returns:

  • (String)


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

def 
  @account_short_name
end

#bundle_idString

Bundle Id associated with card in the Gateway. This field will have a null value if the card is not associated with any bundle of IncludeBundleDetails in request is false. If the search is based on a bundle Id, the same will be returned.

Returns:

  • (String)


200
201
202
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 200

def bundle_id
  @bundle_id
end

#card_idInteger

Unique Card Id

Returns:

  • (Integer)


14
15
16
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 14

def card_id
  @card_id
end

#card_type_codeString

ISO code of the card i.e. first 7 digits of the PAN

Returns:

  • (String)


183
184
185
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 183

def card_type_code
  @card_type_code
end

#card_type_idInteger

Card Type ID Example Id & Description: 1 - Philippines CRT 7077861 2- Philippines Fleet 7002861 5-SHELL FLEET- HONG KONG 7002821 6-SHELL NHF- HONG KONG 7002821 7-SHELL CRT- HONG KONG 7077821

Returns:

  • (Integer)


179
180
181
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 179

def card_type_id
  @card_type_id
end

#card_type_nameString

Card Type Name Example Id & Description: 1 - Philippines CRT 7077861 2- Philippines Fleet 7002861 5-SHELL FLEET- HONG KONG 7002821 6-SHELL NHF- HONG KONG 7002821 7-SHELL CRT- HONG KONG 7077821

Returns:

  • (String)


193
194
195
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 193

def card_type_name
  @card_type_name
end

#col_co_currency_codeString

ISO currency code of the country. Example: GBP

Returns:

  • (String)


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

def col_co_currency_code
  @col_co_currency_code
end

#col_co_currency_symbolString

Currency symbol of the country. Example: £, $

Returns:

  • (String)


86
87
88
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 86

def col_co_currency_symbol
  @col_co_currency_symbol
end

#currency_codeString

ISO currency code of the Customer Currency Example: GBP

Returns:

  • (String)


76
77
78
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 76

def currency_code
  @currency_code
end

#driver_nameString

Driver name Example: ANDREW GILBERRY

Returns:

  • (String)


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

def driver_name
  @driver_name
end

#expiry_dateString

Expiry date of the card Format: yyyyMMdd Note: Clients to convert this to appropriate DateTime type.

Returns:

  • (String)


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

def expiry_date
  @expiry_date
end

#is_crtTrueClass | FalseClass

True/False True if it is a CRT type card, else false

Returns:

  • (TrueClass | FalseClass)


154
155
156
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 154

def is_crt
  @is_crt
end

#is_fleetTrueClass | FalseClass

True/False True if it is a Fleet type card, else false

Returns:

  • (TrueClass | FalseClass)


159
160
161
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 159

def is_fleet
  @is_fleet
end

#is_internationalTrueClass | FalseClass

True/False True if it is an international card, else false

Returns:

  • (TrueClass | FalseClass)


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

def is_international
  @is_international
end

#is_nationalTrueClass | FalseClass

True/False True if it is a national card, else false

Returns:

  • (TrueClass | FalseClass)


144
145
146
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 144

def is_national
  @is_national
end

#is_partner_sites_includedTrueClass | FalseClass

True/False True if it is allowed at all partner sites, else false

Returns:

  • (TrueClass | FalseClass)


169
170
171
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 169

def is_partner_sites_included
  @is_partner_sites_included
end

#is_shell_sites_onlyTrueClass | FalseClass

True/False True if it is only allowed at Shell sites, else false

Returns:

  • (TrueClass | FalseClass)


164
165
166
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 164

def is_shell_sites_only
  @is_shell_sites_only
end

#is_supersededTrueClass | FalseClass

True/False True if a new card is issued with the same PAN, else false

Returns:

  • (TrueClass | FalseClass)


134
135
136
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 134

def is_superseded
  @is_superseded
end

#is_virtual_cardTrueClass | FalseClass

True/False True if it is a virtual card, else false

Returns:

  • (TrueClass | FalseClass)


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

def is_virtual_card
  @is_virtual_card
end

#issue_dateString

Issue date Format: yyyyMMdd Note: Clients to convert this to appropriate DateTime type.

Returns:

  • (String)


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

def issue_date
  @issue_date
end

#issue_numberInteger

Issue Number

Returns:

  • (Integer)


52
53
54
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 52

def issue_number
  @issue_number
end

#medium_typeString

Name of the medium type identifier. Example: Fuel Card, Fuel Card with EV, Key fob

Full list below: 1 - Fuel Card 2 - Fuel Card with EV 4 - Fuel Card and Key fob Card 5 - Key fob 6 - Virtual Card 7 - NPII Token 8 - Smartpay

Returns:

  • (String)


226
227
228
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 226

def medium_type
  @medium_type
end

#medium_type_idInteger

Id of the medium type identifier. Example: 1,2,4 Full list below: 1 - Fuel Card 2 - Fuel Card with EV 4 - Fuel Card and Key fob Card 5 - Key fob 6 - Virtual Card 7 - NPII Token 8 – Smartpay

Returns:

  • (Integer)


213
214
215
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 213

def medium_type_id
  @medium_type_id
end

#panString

Card PAN

Returns:

  • (String)


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

def pan
  @pan
end

#purchase_category_codeString

Purchase category code Example: 0 - All Fuels (without VP) and Lubricants 1 - FuelSave only 2 - FuelSave and Lubricants 3 - No Restrictions 4 - VP and FuelSave 5 - Diesel ONLY 6 - Diesel and Lubricants 7 - VP and Lubricants 8 - VP and FuelSave and Lubricants

Returns:

  • (String)


115
116
117
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 115

def purchase_category_code
  @purchase_category_code
end

#purchase_category_idString

Purchase category Id Example: 123, 124, etc.,

Returns:

  • (String)


101
102
103
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 101

def purchase_category_id
  @purchase_category_id
end

#purchase_category_nameString

Purchase category name Example: 0 - All Fuels (without VP) and Lubricants 1 - FuelSave only 2 - FuelSave and Lubricants 3 - No Restrictions 4 - VP and FuelSave 5 - Diesel ONLY 6 - Diesel and Lubricants 7 - VP and Lubricants 8 - VP and FuelSave and Lubricants

Returns:

  • (String)


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

def purchase_category_name
  @purchase_category_name
end

#restriction_currency_codeString

ISO currency code of the country. Example: GBP

Returns:

  • (String)


91
92
93
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 91

def restriction_currency_code
  @restriction_currency_code
end

#restriction_currency_symbolString

Currency symbol of the country. Example: £, $

Returns:

  • (String)


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

def restriction_currency_symbol
  @restriction_currency_symbol
end

#status_descriptionString

Status Description (Active, Temporarily Blocked, etc.,)

Returns:

  • (String)


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

def status_description
  @status_description
end

#status_idInteger

Card Status id

Returns:

  • (Integer)


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

def status_id
  @status_id
end

#vrnString

Vehicle registration number Example: MV65YLH

Returns:

  • (String)


42
43
44
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 42

def vrn
  @vrn
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
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
456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 379

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
  pan = hash.key?('PAN') ? hash['PAN'] : SKIP
  expiry_date = hash.key?('ExpiryDate') ? hash['ExpiryDate'] : SKIP
  status_id = hash.key?('StatusId') ? hash['StatusId'] : SKIP
  status_description =
    hash.key?('StatusDescription') ? hash['StatusDescription'] : SKIP
  driver_name = hash.key?('DriverName') ? hash['DriverName'] : SKIP
  vrn = hash.key?('VRN') ? hash['VRN'] : SKIP
  issue_date = hash.key?('IssueDate') ? hash['IssueDate'] : SKIP
  issue_number = hash.key?('IssueNumber') ? hash['IssueNumber'] : SKIP
   = hash.key?('AccountId') ? hash['AccountId'] : SKIP
   = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
   = hash.key?('AccountName') ? hash['AccountName'] : SKIP
   =
    hash.key?('AccountShortName') ? hash['AccountShortName'] : SKIP
  currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : SKIP
  col_co_currency_code =
    hash.key?('ColCoCurrencyCode') ? hash['ColCoCurrencyCode'] : SKIP
  col_co_currency_symbol =
    hash.key?('ColCoCurrencySymbol') ? hash['ColCoCurrencySymbol'] : SKIP
  restriction_currency_code =
    hash.key?('RestrictionCurrencyCode') ? hash['RestrictionCurrencyCode'] : SKIP
  restriction_currency_symbol =
    hash.key?('RestrictionCurrencySymbol') ? hash['RestrictionCurrencySymbol'] : SKIP
  purchase_category_id =
    hash.key?('PurchaseCategoryId') ? hash['PurchaseCategoryId'] : SKIP
  purchase_category_code =
    hash.key?('PurchaseCategoryCode') ? hash['PurchaseCategoryCode'] : SKIP
  purchase_category_name =
    hash.key?('PurchaseCategoryName') ? hash['PurchaseCategoryName'] : SKIP
  is_superseded = hash.key?('IsSuperseded') ? hash['IsSuperseded'] : SKIP
  is_virtual_card =
    hash.key?('IsVirtualCard') ? hash['IsVirtualCard'] : SKIP
  is_national = hash.key?('IsNational') ? hash['IsNational'] : SKIP
  is_international =
    hash.key?('IsInternational') ? hash['IsInternational'] : SKIP
  is_crt = hash.key?('IsCRT') ? hash['IsCRT'] : SKIP
  is_fleet = hash.key?('IsFleet') ? hash['IsFleet'] : SKIP
  is_shell_sites_only =
    hash.key?('IsShellSitesOnly') ? hash['IsShellSitesOnly'] : SKIP
  is_partner_sites_included =
    hash.key?('IsPartnerSitesIncluded') ? hash['IsPartnerSitesIncluded'] : SKIP
  card_type_id = hash.key?('CardTypeId') ? hash['CardTypeId'] : SKIP
  card_type_code = hash.key?('CardTypeCode') ? hash['CardTypeCode'] : SKIP
  card_type_name = hash.key?('CardTypeName') ? hash['CardTypeName'] : SKIP
  bundle_id = hash.key?('BundleId') ? hash['BundleId'] : SKIP
  medium_type_id = hash.key?('MediumTypeID') ? hash['MediumTypeID'] : SKIP
  medium_type = hash.key?('MediumType') ? hash['MediumType'] : SKIP

  # Create object from extracted values.
  RestrictionCardList.new(card_id,
                          pan,
                          expiry_date,
                          status_id,
                          status_description,
                          driver_name,
                          vrn,
                          issue_date,
                          issue_number,
                          ,
                          ,
                          ,
                          ,
                          currency_code,
                          col_co_currency_code,
                          col_co_currency_symbol,
                          restriction_currency_code,
                          restriction_currency_symbol,
                          purchase_category_id,
                          purchase_category_code,
                          purchase_category_name,
                          is_superseded,
                          is_virtual_card,
                          is_national,
                          is_international,
                          is_crt,
                          is_fleet,
                          is_shell_sites_only,
                          is_partner_sites_included,
                          card_type_id,
                          card_type_code,
                          card_type_name,
                          bundle_id,
                          medium_type_id,
                          medium_type)
end

.namesObject

A mapping from model property names to API property names.



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 229

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['card_id'] = 'CardId'
  @_hash['pan'] = 'PAN'
  @_hash['expiry_date'] = 'ExpiryDate'
  @_hash['status_id'] = 'StatusId'
  @_hash['status_description'] = 'StatusDescription'
  @_hash['driver_name'] = 'DriverName'
  @_hash['vrn'] = 'VRN'
  @_hash['issue_date'] = 'IssueDate'
  @_hash['issue_number'] = 'IssueNumber'
  @_hash['account_id'] = 'AccountId'
  @_hash['account_number'] = 'AccountNumber'
  @_hash['account_name'] = 'AccountName'
  @_hash['account_short_name'] = 'AccountShortName'
  @_hash['currency_code'] = 'CurrencyCode'
  @_hash['col_co_currency_code'] = 'ColCoCurrencyCode'
  @_hash['col_co_currency_symbol'] = 'ColCoCurrencySymbol'
  @_hash['restriction_currency_code'] = 'RestrictionCurrencyCode'
  @_hash['restriction_currency_symbol'] = 'RestrictionCurrencySymbol'
  @_hash['purchase_category_id'] = 'PurchaseCategoryId'
  @_hash['purchase_category_code'] = 'PurchaseCategoryCode'
  @_hash['purchase_category_name'] = 'PurchaseCategoryName'
  @_hash['is_superseded'] = 'IsSuperseded'
  @_hash['is_virtual_card'] = 'IsVirtualCard'
  @_hash['is_national'] = 'IsNational'
  @_hash['is_international'] = 'IsInternational'
  @_hash['is_crt'] = 'IsCRT'
  @_hash['is_fleet'] = 'IsFleet'
  @_hash['is_shell_sites_only'] = 'IsShellSitesOnly'
  @_hash['is_partner_sites_included'] = 'IsPartnerSitesIncluded'
  @_hash['card_type_id'] = 'CardTypeId'
  @_hash['card_type_code'] = 'CardTypeCode'
  @_hash['card_type_name'] = 'CardTypeName'
  @_hash['bundle_id'] = 'BundleId'
  @_hash['medium_type_id'] = 'MediumTypeID'
  @_hash['medium_type'] = 'MediumType'
  @_hash
end

.nullablesObject

An array for nullable fields



311
312
313
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 311

def self.nullables
  []
end

.optionalsObject

An array for optional fields



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'lib/shell_card_management_ap_is/models/restriction_card_list.rb', line 270

def self.optionals
  %w[
    card_id
    pan
    expiry_date
    status_id
    status_description
    driver_name
    vrn
    issue_date
    issue_number
    account_id
    account_number
    account_name
    account_short_name
    currency_code
    col_co_currency_code
    col_co_currency_symbol
    restriction_currency_code
    restriction_currency_symbol
    purchase_category_id
    purchase_category_code
    purchase_category_name
    is_superseded
    is_virtual_card
    is_national
    is_international
    is_crt
    is_fleet
    is_shell_sites_only
    is_partner_sites_included
    card_type_id
    card_type_code
    card_type_name
    bundle_id
    medium_type_id
    medium_type
  ]
end