card-management-sdk 1.1.0 → 1.2.0

data/lib/shell_card_management_ap_is/models/audit_response_audits_items.rb

@@ -114,23 +114,23 @@ module ShellCardManagementApIs
 
     # User requested operation. 
     # Possible values:
-    # •	OrderCard
-    # •	CreateCardGroup
-    # •	PINReminder
-    # •	MoveCard
-    # •	UpdateCardStatus
-    # •	UpdateCardGroup
-    # •	AutoRenew
-    # •	BulkCardOrder
-    # •	BulkCardBlock
-    # •	BulkCardOrderMultiAccount
-    # •	MobilePaymentRegistration
-    # •	UpdateCompanyInfo
-    # •	BCOSummary
-    # •	BCOMultiAccountSummary
-    # •	BCBSummary
-    # •	FundTransfer
-    # •	DeliveryAddressUpdate
+    # •    OrderCard
+    # •    CreateCardGroup
+    # •    PINReminder
+    # •    MoveCard
+    # •    UpdateCardStatus
+    # •    UpdateCardGroup
+    # •    AutoRenew
+    # •    BulkCardOrder
+    # •    BulkCardBlock
+    # •    BulkCardOrderMultiAccount
+    # •    MobilePaymentRegistration
+    # •    UpdateCompanyInfo
+    # •    BCOSummary
+    # •    BCOMultiAccountSummary
+    # •    BCBSummary
+    # •    FundTransfer
+    # •    DeliveryAddressUpdate
     # @return [String]
     attr_accessor :requested_operation
 
@@ -140,35 +140,35 @@ module ShellCardManagementApIs
 
     # Request type initiated under the requested operation. 
     # Possible values:
-    # •	OrderCard
-    # •	CreateCardGroup
-    # •	PINReminder
-    # •	MoveCard
-    # •	UpdateCardStatus
-    # •	UpdateCardGroup
-    # •	AutoRenew
-    # •	BulkCardOrder
-    # •	BulkCardBlock
-    # •	BulkCardOrderMultiAccount
-    # •	MobilePaymentRegistration
-    # •	UpdateCompanyInfo
-    # •	BCOSummary
-    # •	BCOMultiAccountSummary
-    # •	BCBSummary
-    # •	FundTransfer
-    # •	DeliveryAddressUpdate
+    # •    OrderCard
+    # •    CreateCardGroup
+    # •    PINReminder
+    # •    MoveCard
+    # •    UpdateCardStatus
+    # •    UpdateCardGroup
+    # •    AutoRenew
+    # •    BulkCardOrder
+    # •    BulkCardBlock
+    # •    BulkCardOrderMultiAccount
+    # •    MobilePaymentRegistration
+    # •    UpdateCompanyInfo
+    # •    BCOSummary
+    # •    BCOMultiAccountSummary
+    # •    BCBSummary
+    # •    FundTransfer
+    # •    DeliveryAddressUpdate
     # @return [String]
     attr_accessor :request_type
 
     # Status of the request.
     # Possible values:
-    # •	Success
-    # •	Failed
-    # •	InProgress
-    # •	Submitted
-    # •	Rejected
-    # •	PendingApproval
-    # •	MailedToCSC
+    # •    Success
+    # •    Failed
+    # •    InProgress
+    # •    Submitted
+    # •    Rejected
+    # •    PendingApproval
+    # •    MailedToCSC
     # @return [String]
     attr_accessor :status
 

data/lib/shell_card_management_ap_is/models/auto_renew_card_request_auto_renew_cards_items.rb

@@ -24,6 +24,12 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :pan
 
+    # Card PAN ID.
+    # Optional if CardId is given, else mandatory.
+    # Note: PANID is ignored if CardId is given.
+    # @return [Float]
+    attr_accessor :panid
+
     # Card Id of the card.
     # Optional if PAN is passed, else Mandatory.
     # @return [Integer]
@@ -43,6 +49,7 @@ module ShellCardManagementApIs
       @_hash['account_number'] = 'AccountNumber'
       @_hash['account_id'] = 'AccountId'
       @_hash['pan'] = 'PAN'
+      @_hash['panid'] = 'PANID'
       @_hash['card_id'] = 'CardId'
       @_hash['reissue_setting'] = 'ReissueSetting'
       @_hash
@@ -54,6 +61,7 @@ module ShellCardManagementApIs
         account_number
         account_id
         pan
+        panid
         card_id
       ]
     end
@@ -64,10 +72,11 @@ module ShellCardManagementApIs
     end
 
     def initialize(reissue_setting = nil, account_number = SKIP,
-                   account_id = SKIP, pan = SKIP, card_id = SKIP)
+                   account_id = SKIP, pan = SKIP, panid = SKIP, card_id = SKIP)
       @account_number = account_number unless account_number == SKIP
       @account_id = account_id unless account_id == SKIP
       @pan = pan unless pan == SKIP
+      @panid = panid unless panid == SKIP
       @card_id = card_id unless card_id == SKIP
       @reissue_setting = reissue_setting
     end
@@ -82,6 +91,7 @@ module ShellCardManagementApIs
       account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
       account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
       pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      panid = hash.key?('PANID') ? hash['PANID'] : SKIP
       card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
 
       # Create object from extracted values.
@@ -89,6 +99,7 @@ module ShellCardManagementApIs
                                                   account_number,
                                                   account_id,
                                                   pan,
+                                                  panid,
                                                   card_id)
     end
   end

data/lib/shell_card_management_ap_is/models/auto_renew_card_response_data_items.rb

@@ -17,11 +17,16 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :card_id_and_pan
 
+    # PANID of the card
+    # @return [Float]
+    attr_accessor :panid
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['auto_renew_reference_id'] = 'AutoRenewReferenceId'
       @_hash['card_id_and_pan'] = 'CardIdAndPAN'
+      @_hash['panid'] = 'PANID'
       @_hash
     end
 
@@ -30,6 +35,7 @@ module ShellCardManagementApIs
       %w[
         auto_renew_reference_id
         card_id_and_pan
+        panid
       ]
     end
 
@@ -38,12 +44,15 @@ module ShellCardManagementApIs
       %w[
         auto_renew_reference_id
         card_id_and_pan
+        panid
       ]
     end
 
-    def initialize(auto_renew_reference_id = SKIP, card_id_and_pan = SKIP)
+    def initialize(auto_renew_reference_id = SKIP, card_id_and_pan = SKIP,
+                   panid = SKIP)
       @auto_renew_reference_id = auto_renew_reference_id unless auto_renew_reference_id == SKIP
       @card_id_and_pan = card_id_and_pan unless card_id_and_pan == SKIP
+      @panid = panid unless panid == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -54,10 +63,12 @@ module ShellCardManagementApIs
       auto_renew_reference_id =
         hash.key?('AutoRenewReferenceId') ? hash['AutoRenewReferenceId'] : SKIP
       card_id_and_pan = hash.key?('CardIdAndPAN') ? hash['CardIdAndPAN'] : SKIP
+      panid = hash.key?('PANID') ? hash['PANID'] : SKIP
 
       # Create object from extracted values.
       AutoRenewCardResponseDataItems.new(auto_renew_reference_id,
-                                         card_id_and_pan)
+                                         card_id_and_pan,
+                                         panid)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/bundle_restriction.rb

@@ -13,8 +13,8 @@ module ShellCardManagementApIs
     # restriction. 
     # Mandatory
     # Allowed values –
-    # •	Add: Apply the given restriction on the bundle.
-    # •	Default: No Day/Time restriction will be applied on the bundle in
+    # •    Add: Apply the given restriction on the bundle.
+    # •    Default: No Day/Time restriction will be applied on the bundle in
     # Gateway.
     # @return [String]
     attr_accessor :day_time_restriction_action
@@ -23,8 +23,8 @@ module ShellCardManagementApIs
     # restriction. 
     # Mandatory
     # Allowed values –
-    # •	Add: Apply the given restriction on the bundle.
-    # •	Default: No location restriction will be applied on the bundle in
+    # •    Add: Apply the given restriction on the bundle.
+    # •    Default: No location restriction will be applied on the bundle in
     # Gateway.
     # @return [String]
     attr_accessor :location_restriction_action
@@ -33,24 +33,39 @@ module ShellCardManagementApIs
     # restriction. 
     # Mandatory
     # Allowed values –
-    # •	Add: Apply the given restriction on the bundle.
-    # •	Default: No location restriction will be applied on the bundle in
+    # •    Add: Apply the given restriction on the bundle.
+    # •    Default: No location restriction will be applied on the bundle in
     # Gateway.
-    # @return [UsageRestrictionsCard]
+    # @return [Object]
     attr_accessor :usage_restrictions
 
-    # Details of the day/time restrictions such as weekdays and time range in
-    # which transactions should be allowed on the card.
-    # @return [DayTimeRestriction]
+    # The value indicates what actions to be performed with respect to location
+    # restriction. 
+    # Mandatory
+    # Allowed values –
+    # •    Add: Apply the given restriction on the bundle.
+    # •    Default: No location restriction will be applied on the bundle in
+    # Gateway.
+    # @return [DayTimeRestrictions]
     attr_accessor :day_time_restrictions
 
-    # Details of the day/time restrictions such as weekdays and time range in
-    # which transactions should be allowed on the card.
-    # @return [ProductRestrictionCard]
+    # The value indicates what actions to be performed with respect to location
+    # restriction. 
+    # Mandatory
+    # Allowed values –
+    # •    Add: Apply the given restriction on the bundle.
+    # •    Default: No location restriction will be applied on the bundle in
+    # Gateway.
+    # @return [Object]
     attr_accessor :product_restrictions
 
-    # Details of the day/time restrictions such as weekdays and time range in
-    # which transactions should be allowed on the card.
+    # The value indicates what actions to be performed with respect to location
+    # restriction. 
+    # Mandatory
+    # Allowed values –
+    # •    Add: Apply the given restriction on the bundle.
+    # •    Default: No location restriction will be applied on the bundle in
+    # Gateway.
     # @return [LocationRestriction]
     attr_accessor :location_restrictions
 
@@ -83,8 +98,6 @@ module ShellCardManagementApIs
       %w[
         day_time_restriction_action
         location_restriction_action
-        usage_restrictions
-        product_restrictions
       ]
     end
 
@@ -115,12 +128,12 @@ module ShellCardManagementApIs
         hash.key?('DayTimeRestrictionAction') ? hash['DayTimeRestrictionAction'] : SKIP
       location_restriction_action =
         hash.key?('LocationRestrictionAction') ? hash['LocationRestrictionAction'] : SKIP
-      usage_restrictions = UsageRestrictionsCard.from_hash(hash['UsageRestrictions']) if
-        hash['UsageRestrictions']
-      day_time_restrictions = DayTimeRestriction.from_hash(hash['DayTimeRestrictions']) if
+      usage_restrictions =
+        hash.key?('UsageRestrictions') ? hash['UsageRestrictions'] : SKIP
+      day_time_restrictions = DayTimeRestrictions.from_hash(hash['DayTimeRestrictions']) if
         hash['DayTimeRestrictions']
-      product_restrictions = ProductRestrictionCard.from_hash(hash['ProductRestrictions']) if
-        hash['ProductRestrictions']
+      product_restrictions =
+        hash.key?('ProductRestrictions') ? hash['ProductRestrictions'] : SKIP
       location_restrictions = LocationRestriction.from_hash(hash['LocationRestrictions']) if
         hash['LocationRestrictions']
 

data/lib/shell_card_management_ap_is/models/bundle_restriction_update.rb

@@ -38,7 +38,7 @@ module ShellCardManagementApIs
     # bundle.
     # Optional
     # Default value is False.
-    # @return [UsageRestrictionsCard]
+    # @return [Object]
     attr_accessor :usage_restrictions
 
     # Identifier of the day/time restriction profile to be updated for the
@@ -56,7 +56,7 @@ module ShellCardManagementApIs
     # Identifier of the day/time restriction profile to be updated for the
     # bundle in Gateway.
     # Optional
-    # @return [ProductRestrictionCard]
+    # @return [Object]
     attr_accessor :product_restrictions
 
     # Identifier of the location restriction profile to be updated for the
@@ -109,9 +109,7 @@ module ShellCardManagementApIs
         reset_day_time_restriction
         reset_location_restriction
         reset_product_restriction
-        usage_restrictions
         day_time_restriction_profile_id
-        product_restrictions
       ]
     end
 
@@ -159,14 +157,14 @@ module ShellCardManagementApIs
         hash.key?('ResetLocationRestriction') ? hash['ResetLocationRestriction'] : SKIP
       reset_product_restriction =
         hash.key?('ResetProductRestriction') ? hash['ResetProductRestriction'] : SKIP
-      usage_restrictions = UsageRestrictionsCard.from_hash(hash['UsageRestrictions']) if
-        hash['UsageRestrictions']
+      usage_restrictions =
+        hash.key?('UsageRestrictions') ? hash['UsageRestrictions'] : SKIP
       day_time_restriction_profile_id =
         hash.key?('DayTimeRestrictionProfileId') ? hash['DayTimeRestrictionProfileId'] : SKIP
       day_time_restrictions = CardDayTimeRestrictions.from_hash(hash['DayTimeRestrictions']) if
         hash['DayTimeRestrictions']
-      product_restrictions = ProductRestrictionCard.from_hash(hash['ProductRestrictions']) if
-        hash['ProductRestrictions']
+      product_restrictions =
+        hash.key?('ProductRestrictions') ? hash['ProductRestrictions'] : SKIP
       location_restriction_profile_id =
         hash.key?('LocationRestrictionProfileId') ? hash['LocationRestrictionProfileId'] : SKIP
       location_restrictions = LocationRestriction.from_hash(hash['LocationRestrictions']) if

data/lib/shell_card_management_ap_is/models/bundled_restrictions_list.rb

@@ -9,23 +9,19 @@ module ShellCardManagementApIs
     SKIP = Object.new
     private_constant :SKIP
 
-    # Details of the usage restrictions such as day/week/month value and volume
-    # restrictions applied on the card.
-    # @return [UsageRestriction]
+    # TODO: Write general description for this method
+    # @return [Object]
     attr_accessor :usage_restrictions
 
-    # Details of the day/time restrictions such as weekdays and time range in
-    # which transactions should be allowed on the card.
-    # @return [DayTimeRestriction]
+    # TODO: Write general description for this method
+    # @return [DayTimeRestrictions]
     attr_accessor :day_time_restrictions
 
-    # Details of the day/time restrictions such as weekdays and time range in
-    # which transactions should be allowed on the card.
+    # TODO: Write general description for this method
     # @return [BundledDetailsProductList]
     attr_accessor :product_restrictions
 
-    # Details of the day/time restrictions such as weekdays and time range in
-    # which transactions should be allowed on the card.
+    # TODO: Write general description for this method
     # @return [LocationRestriction]
     attr_accessor :location_restrictions
 
@@ -51,9 +47,7 @@ module ShellCardManagementApIs
 
     # An array for nullable fields
     def self.nullables
-      %w[
-        usage_restrictions
-      ]
+      []
     end
 
     def initialize(usage_restrictions = SKIP, day_time_restrictions = SKIP,
@@ -69,9 +63,9 @@ module ShellCardManagementApIs
       return nil unless hash
 
       # Extract variables from the hash.
-      usage_restrictions = UsageRestriction.from_hash(hash['UsageRestrictions']) if
-        hash['UsageRestrictions']
-      day_time_restrictions = DayTimeRestriction.from_hash(hash['DayTimeRestrictions']) if
+      usage_restrictions =
+        hash.key?('UsageRestrictions') ? hash['UsageRestrictions'] : SKIP
+      day_time_restrictions = DayTimeRestrictions.from_hash(hash['DayTimeRestrictions']) if
         hash['DayTimeRestrictions']
       product_restrictions = BundledDetailsProductList.from_hash(hash['ProductRestrictions']) if
         hash['ProductRestrictions']

data/lib/shell_card_management_ap_is/models/card.rb

@@ -175,10 +175,18 @@ module ShellCardManagementApIs
     # @return [TrueClass | FalseClass]
     attr_accessor :odometer_input
 
-    # Card PAN Mask PAN (Mask all digits except the Last 6 digits of the PAN)
+    # Card PAN
     # @return [String]
     attr_accessor :pan
 
+    # Card PAN Mask PAN (Mask all digits except the Last 6 digits of the PAN)
+    # @return [String]
+    attr_accessor :masked_pan
+
+    # Card PAN ID.
+    # @return [Float]
+    attr_accessor :panid
+
     # Purchase category code
     # @return [String]
     attr_accessor :purchase_category_code
@@ -326,6 +334,8 @@ module ShellCardManagementApIs
       @_hash['local_currency_symbol'] = 'LocalCurrencySymbol'
       @_hash['odometer_input'] = 'OdometerInput'
       @_hash['pan'] = 'PAN'
+      @_hash['masked_pan'] = 'MaskedPAN'
+      @_hash['panid'] = 'PANID'
       @_hash['purchase_category_code'] = 'PurchaseCategoryCode'
       @_hash['purchase_category_id'] = 'PurchaseCategoryId'
       @_hash['purchase_category_name'] = 'PurchaseCategoryName'
@@ -383,6 +393,8 @@ module ShellCardManagementApIs
         local_currency_symbol
         odometer_input
         pan
+        masked_pan
+        panid
         purchase_category_code
         purchase_category_id
         purchase_category_name
@@ -461,11 +473,12 @@ module ShellCardManagementApIs
                    is_virtual_card = SKIP, last_modified_date = SKIP,
                    last_used_date = SKIP, local_currency_code = SKIP,
                    local_currency_symbol = SKIP, odometer_input = SKIP,
-                   pan = SKIP, purchase_category_code = SKIP,
-                   purchase_category_id = SKIP, purchase_category_name = SKIP,
-                   reason = SKIP, reissue_setting = SKIP,
-                   status_description = SKIP, status_id = SKIP,
-                   token_type_id = SKIP, token_type_name = SKIP, vrn = SKIP,
+                   pan = SKIP, masked_pan = SKIP, panid = SKIP,
+                   purchase_category_code = SKIP, purchase_category_id = SKIP,
+                   purchase_category_name = SKIP, reason = SKIP,
+                   reissue_setting = SKIP, status_description = SKIP,
+                   status_id = SKIP, token_type_id = SKIP,
+                   token_type_name = SKIP, vrn = SKIP,
                    client_reference_id = SKIP, is_emv_contact = SKIP,
                    is_emv_contactless = SKIP, is_rfid = SKIP, rfiduid = SKIP,
                    emaid = SKIP, ev_printed_number = SKIP,
@@ -506,6 +519,8 @@ module ShellCardManagementApIs
       @local_currency_symbol = local_currency_symbol unless local_currency_symbol == SKIP
       @odometer_input = odometer_input unless odometer_input == SKIP
       @pan = pan unless pan == SKIP
+      @masked_pan = masked_pan unless masked_pan == SKIP
+      @panid = panid unless panid == SKIP
       @purchase_category_code = purchase_category_code unless purchase_category_code == SKIP
       @purchase_category_id = purchase_category_id unless purchase_category_id == SKIP
       @purchase_category_name = purchase_category_name unless purchase_category_name == SKIP
@@ -583,6 +598,8 @@ module ShellCardManagementApIs
         hash.key?('LocalCurrencySymbol') ? hash['LocalCurrencySymbol'] : SKIP
       odometer_input = hash.key?('OdometerInput') ? hash['OdometerInput'] : SKIP
       pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      masked_pan = hash.key?('MaskedPAN') ? hash['MaskedPAN'] : SKIP
+      panid = hash.key?('PANID') ? hash['PANID'] : SKIP
       purchase_category_code =
         hash.key?('PurchaseCategoryCode') ? hash['PurchaseCategoryCode'] : SKIP
       purchase_category_id =
@@ -646,6 +663,8 @@ module ShellCardManagementApIs
                local_currency_symbol,
                odometer_input,
                pan,
+               masked_pan,
+               panid,
                purchase_category_code,
                purchase_category_id,
                purchase_category_name,

data/lib/shell_card_management_ap_is/models/card_detail.rb

@@ -174,47 +174,47 @@ module ShellCardManagementApIs
     # Card delivery type.<br />
     # Mandatory <br />
     # Allowed Value: <br />
-    # 1.	Customer Address(Default) <br />
-    # 2.	New Delivery Address
+    # 1.    Customer Address(Default) <br />
+    # 2.    New Delivery Address
     # @return [Integer]
     attr_accessor :card_delivery_type
 
     # Card delivery type.<br />
     # Mandatory <br />
     # Allowed Value: <br />
-    # 1.	Customer Address(Default) <br />
-    # 2.	New Delivery Address
+    # 1.    Customer Address(Default) <br />
+    # 2.    New Delivery Address
     # @return [CardContact]
     attr_accessor :card_contact
 
     # PIN delivery address type selection.<br />
     # Optional<br />
     # Allowed Values:<br />
-    # 1.	Customer Address(Default)<br />
-    # 2.	Card Address<br />
-    # 3.	New Delivery Address
+    # 1.    Customer Address(Default)<br />
+    # 2.    Card Address<br />
+    # 3.    New Delivery Address
     # @return [Integer]
     attr_accessor :pin_delivery_address_type
 
     # 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
+    # 1.    Paper<br />
+    # 2.    Email<br />
+    # 3.    SMS<br />
+    # 4.    None <br /> **Note:** Paper delivery not applicable for
+    # selfselctedPIN type
     # @return [Integer]
     attr_accessor :pin_advice_type
 
     # 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
+    # 1.    Paper<br />
+    # 2.    Email<br />
+    # 3.    SMS<br />
+    # 4.    None <br /> **Note:** Paper delivery not applicable for
+    # selfselctedPIN type
     # @return [PINContact]
     attr_accessor :pin_contact
 
@@ -232,9 +232,9 @@ module ShellCardManagementApIs
     # 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 />
+    # •    “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
     # @return [String]
     attr_accessor :caller
@@ -263,10 +263,10 @@ module ShellCardManagementApIs
     # Optional.<br />
     # Default: NO_VALIDATION<br />
     # Allowed values:<br />
-    # •	ALERT<br />
-    # •	DECLINE<br />
-    # •	DECLINE_ALERT<br />
-    # •	NO_VALIDATION<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.
     # @return [String]
@@ -343,9 +343,11 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :client_reference_id
 
-    # 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
+    # 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.
     # @return [CardDetailAutoRenewEnum]
     attr_accessor :auto_renew