card-management-sdk 1.0.0 → 1.2.0

data/lib/shell_card_management_ap_is/models/schedule_card_block_cards_items.rb

@@ -57,6 +57,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 [String]
+    attr_accessor :panid
+
     # Expiry date of the card.
     # Optional if CardId is passed, else Mandatory.
     # Format: yyyyMMdd
@@ -67,32 +73,32 @@ module ShellCardManagementApIs
     # Action
     # Mandatory
     # Possible values are:
-    # •	AddOrUpdate – adds a new request or updates any existing requests, with
-    # overlapping dates, for the card
-    # •	AddAndOverwriteAll - all the existing requests of the given card will be
-    # removed and a new request with the specified FromDate and ToDate will be
-    # added.
-    # •	Delete – deletes any existing request with the same start date and end
-    # date for the card
-    # •	DeleteAll – deletes all saved future dated requests (all block and
+    # •    AddOrUpdate – adds a new request or updates any existing requests,
+    # with overlapping dates, for the card
+    # •    AddAndOverwriteAll - all the existing requests of the given card will
+    # be removed and a new request with the specified FromDate and ToDate will
+    # be added.
+    # •    Delete – deletes any existing request with the same start date and
+    # end date for the card
+    # •    DeleteAll – deletes all saved future dated requests (all block and
     # unblock requests) of the card.
     # @return [String]
     attr_accessor :action
 
     # Effective start date of Block / Unblock
     # Allowed Formats: –
-    # •	yyyyMMdd
-    # •	yyyyMMdd HH:mm
+    # •    yyyyMMdd
+    # •    yyyyMMdd HH:mm
     # Eg: 20230512 14:30, 20230512
     # Optional
     # Default value: 
-    # •	 If the card status is “Active” then Current date & Time
-    # •	If the card status is “TemporaryBlock (Customer)” then null.
+    # •     If the card status is “Active” then Current date & Time
+    # •    If the card status is “TemporaryBlock (Customer)” then null.
     # Note:
-    # •	Time is considered only when “IsTimeSupported” is true else it will be
-    # treated as a date.
-    # •	Time will be passed in UTC time-zone.
-    # •	If the Card Status is “Temporary Block (Customer)” and FromDate is
+    # •    Time is considered only when “IsTimeSupported” is true else it will
+    # be treated as a date.
+    # •    Time will be passed in UTC time-zone.
+    # •    If the Card Status is “Temporary Block (Customer)” and FromDate is
     # provided – The fromdate & time is considered as starting period of unblock
     # request.
     # @return [String]
@@ -100,20 +106,21 @@ module ShellCardManagementApIs
 
     # Effective end date of Block / Unblock
     # Allowed Formats: –
-    # •	yyyyMMdd
-    # •	yyyyMMdd HH:mm
+    # •    yyyyMMdd
+    # •    yyyyMMdd HH:mm
     # Eg: 20230512 14:30, 20230512
     # Optional – When the Card status is Active else mandatory.
     # When not provided, the card will remain blocked until manually unblocked.
     # Note:
-    # •	Time is considered only when the “IsTimeSupported” flag is set as true,
-    # else it will be considered as only date.
-    # •	Date & Time passed in the request will be considered in UTC time-zone.
-    # •	If the card is currently in ‘Temporary Block (Customer)’ status, then
+    # •    Time is considered only when the “IsTimeSupported” flag is set as
+    # true, else it will be considered as only date.
+    # •    Date & Time passed in the request will be considered in UTC
+    # time-zone.
+    # •    If the card is currently in ‘Temporary Block (Customer)’ status, then
     # this date is treated as the unblock date and is mandatory.
-    # •	If the Card Status is “Temporary Block (Customer)” and FromDate & ToDate
-    # is provided - The request will be considered as a scheduled specific
-    # period unblock request.
+    # •    If the Card Status is “Temporary Block (Customer)” and FromDate &
+    # ToDate is provided - The request will be considered as a scheduled
+    # specific period unblock request.
     # @return [String]
     attr_accessor :to_date
 
@@ -143,6 +150,7 @@ module ShellCardManagementApIs
       @_hash['payer_number'] = 'PayerNumber'
       @_hash['card_id'] = 'CardId'
       @_hash['pan'] = 'PAN'
+      @_hash['panid'] = 'PANID'
       @_hash['card_expiry_date'] = 'CardExpiryDate'
       @_hash['action'] = 'Action'
       @_hash['from_date'] = 'FromDate'
@@ -163,6 +171,7 @@ module ShellCardManagementApIs
         payer_number
         card_id
         pan
+        panid
         card_expiry_date
         from_date
         to_date
@@ -178,20 +187,11 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(action = nil,
-                   col_co_code = SKIP,
-                   col_co_id = SKIP,
-                   account_id = SKIP,
-                   account_number = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   card_id = SKIP,
-                   pan = SKIP,
-                   card_expiry_date = SKIP,
-                   from_date = SKIP,
-                   to_date = SKIP,
-                   caller = SKIP,
-                   notify_caller = SKIP)
+    def initialize(action = nil, col_co_code = SKIP, col_co_id = SKIP,
+                   account_id = SKIP, account_number = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, card_id = SKIP, pan = SKIP,
+                   panid = SKIP, card_expiry_date = SKIP, from_date = SKIP,
+                   to_date = SKIP, caller = SKIP, notify_caller = SKIP)
       @col_co_code = col_co_code unless col_co_code == SKIP
       @col_co_id = col_co_id unless col_co_id == SKIP
       @account_id = account_id unless account_id == SKIP
@@ -200,6 +200,7 @@ module ShellCardManagementApIs
       @payer_number = payer_number unless payer_number == SKIP
       @card_id = card_id unless card_id == SKIP
       @pan = pan unless pan == SKIP
+      @panid = panid unless panid == SKIP
       @card_expiry_date = card_expiry_date unless card_expiry_date == SKIP
       @action = action
       @from_date = from_date unless from_date == SKIP
@@ -222,6 +223,7 @@ module ShellCardManagementApIs
       payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
       card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
       pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      panid = hash.key?('PANID') ? hash['PANID'] : SKIP
       card_expiry_date =
         hash.key?('CardExpiryDate') ? hash['CardExpiryDate'] : SKIP
       from_date = hash.key?('FromDate') ? hash['FromDate'] : SKIP
@@ -239,6 +241,7 @@ module ShellCardManagementApIs
                                       payer_number,
                                       card_id,
                                       pan,
+                                      panid,
                                       card_expiry_date,
                                       from_date,
                                       to_date,

data/lib/shell_card_management_ap_is/models/schedule_card_block_request.rb

@@ -42,8 +42,7 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(is_time_supported = SKIP,
-                   schedule_card_block_cards = SKIP)
+    def initialize(is_time_supported = SKIP, schedule_card_block_cards = SKIP)
       @is_time_supported = is_time_supported unless is_time_supported == SKIP
       unless schedule_card_block_cards == SKIP
         @schedule_card_block_cards =

data/lib/shell_card_management_ap_is/models/schedule_card_block_response.rb

@@ -52,9 +52,7 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(main_reference = SKIP,
-                   request_id = SKIP,
-                   status = SKIP,
+    def initialize(main_reference = SKIP, request_id = SKIP, status = SKIP,
                    data = SKIP)
       @main_reference = main_reference unless main_reference == SKIP
       @request_id = request_id unless request_id == SKIP

data/lib/shell_card_management_ap_is/models/schedule_card_block_response_data_items.rb

@@ -59,9 +59,7 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(card_id = SKIP,
-                   from_date = SKIP,
-                   to_date = SKIP,
+    def initialize(card_id = SKIP, from_date = SKIP, to_date = SKIP,
                    reference_id = SKIP)
       @card_id = card_id unless card_id == SKIP
       @from_date = from_date unless from_date == SKIP

data/lib/shell_card_management_ap_is/models/search_account_limit_request.rb

@@ -9,31 +9,90 @@ module ShellCardManagementApIs
     SKIP = Object.new
     private_constant :SKIP
 
-    # TODO: Write general description for this method
-    # @return [SearchAccountLimitRequestFilters]
-    attr_accessor :filters
+    # Collecting Company Id of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # Example:
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Collecting Company Code (Shell Code) of the selected payer. 
+    # Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia,
+    # Ukraine etc. It is optional for other countries if ColCoID is provided.
+    # Example:
+    # 86 for Philippines
+    # 5 for UK
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer Id of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Account ID of the customer.
+    # Optional if AccountNumber is passed else Mandatory
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.
+    # Optional if AccountId is passed else Mandatory
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :account_number
 
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
-      @_hash['filters'] = 'Filters'
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
       @_hash
     end
 
     # An array for optional fields
     def self.optionals
       %w[
-        filters
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        account_id
+        account_number
       ]
     end
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        account_id
+        account_number
+      ]
     end
 
-    def initialize(filters = SKIP)
-      @filters = filters unless filters == SKIP
+    def initialize(col_co_id = SKIP, col_co_code = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, account_id = SKIP,
+                   account_number = SKIP)
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @col_co_code = col_co_code unless col_co_code == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -41,10 +100,20 @@ module ShellCardManagementApIs
       return nil unless hash
 
       # Extract variables from the hash.
-      filters = SearchAccountLimitRequestFilters.from_hash(hash['Filters']) if hash['Filters']
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
 
       # Create object from extracted values.
-      SearchAccountLimitRequest.new(filters)
+      SearchAccountLimitRequest.new(col_co_id,
+                                    col_co_code,
+                                    payer_id,
+                                    payer_number,
+                                    account_id,
+                                    account_number)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/search_account_limit_response.rb

@@ -9,24 +9,49 @@ module ShellCardManagementApIs
     SKIP = Object.new
     private_constant :SKIP
 
-    # TODO: Write general description for this method
+    # Request Id of the API call
     # @return [String]
     attr_accessor :request_id
 
-    # TODO: Write general description for this method
+    # Account ID of the customer.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number
+    # Example: GB99215176
+    # @return [String]
+    attr_accessor :account_number
+
+    # 3 digit Shell global fuel product code, if already set up.
+    # Example: 021
+    # @return [String]
+    attr_accessor :reference_product
+
+    # The restriction condition code.
+    # Example: DECLINE_ALERT
     # @return [String]
-    attr_accessor :status
+    attr_accessor :restriction_condition
 
-    # TODO: Write general description for this method
-    # @return [SearchAccountLimitResponseData]
-    attr_accessor :data
+    # The restriction condition code.
+    # Example: DECLINE_ALERT
+    # @return [Array[AccountVelocityLimit]]
+    attr_accessor :velocity_limits
+
+    # The restriction condition code.
+    # Example: DECLINE_ALERT
+    # @return [ErrorStatus]
+    attr_accessor :error
 
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['request_id'] = 'RequestId'
-      @_hash['status'] = 'Status'
-      @_hash['data'] = 'Data'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['reference_product'] = 'ReferenceProduct'
+      @_hash['restriction_condition'] = 'RestrictionCondition'
+      @_hash['velocity_limits'] = 'VelocityLimits'
+      @_hash['error'] = 'Error'
       @_hash
     end
 
@@ -34,22 +59,32 @@ module ShellCardManagementApIs
     def self.optionals
       %w[
         request_id
-        status
-        data
+        account_id
+        account_number
+        reference_product
+        restriction_condition
+        velocity_limits
+        error
       ]
     end
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        request_id
+      ]
     end
 
-    def initialize(request_id = SKIP,
-                   status = SKIP,
-                   data = SKIP)
+    def initialize(request_id = SKIP, account_id = SKIP, account_number = SKIP,
+                   reference_product = SKIP, restriction_condition = SKIP,
+                   velocity_limits = SKIP, error = SKIP)
       @request_id = request_id unless request_id == SKIP
-      @status = status unless status == SKIP
-      @data = data unless data == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @reference_product = reference_product unless reference_product == SKIP
+      @restriction_condition = restriction_condition unless restriction_condition == SKIP
+      @velocity_limits = velocity_limits unless velocity_limits == SKIP
+      @error = error unless error == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -58,13 +93,32 @@ module ShellCardManagementApIs
 
       # Extract variables from the hash.
       request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
-      status = hash.key?('Status') ? hash['Status'] : SKIP
-      data = SearchAccountLimitResponseData.from_hash(hash['Data']) if hash['Data']
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      reference_product =
+        hash.key?('ReferenceProduct') ? hash['ReferenceProduct'] : SKIP
+      restriction_condition =
+        hash.key?('RestrictionCondition') ? hash['RestrictionCondition'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      velocity_limits = nil
+      unless hash['VelocityLimits'].nil?
+        velocity_limits = []
+        hash['VelocityLimits'].each do |structure|
+          velocity_limits << (AccountVelocityLimit.from_hash(structure) if structure)
+        end
+      end
+
+      velocity_limits = SKIP unless hash.key?('VelocityLimits')
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
 
       # Create object from extracted values.
       SearchAccountLimitResponse.new(request_id,
-                                     status,
-                                     data)
+                                     account_id,
+                                     account_number,
+                                     reference_product,
+                                     restriction_condition,
+                                     velocity_limits,
+                                     error)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/search_card.rb

@@ -20,11 +20,18 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :pan
 
+    # Card PANID 
+    #  optional id cardid given, else mandatory 
+    # Note: PANID is ignored if CardId is given.
+    # @return [Float]
+    attr_accessor :panid
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['card_id'] = 'CardId'
       @_hash['pan'] = 'PAN'
+      @_hash['panid'] = 'PANID'
       @_hash
     end
 
@@ -33,6 +40,7 @@ module ShellCardManagementApIs
       %w[
         card_id
         pan
+        panid
       ]
     end
 
@@ -44,10 +52,10 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(card_id = SKIP,
-                   pan = SKIP)
+    def initialize(card_id = SKIP, pan = SKIP, panid = SKIP)
       @card_id = card_id unless card_id == SKIP
       @pan = pan unless pan == SKIP
+      @panid = panid unless panid == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -57,10 +65,12 @@ module ShellCardManagementApIs
       # Extract variables from the hash.
       card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
       pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      panid = hash.key?('PANID') ? hash['PANID'] : SKIP
 
       # Create object from extracted values.
       SearchCard.new(card_id,
-                     pan)
+                     pan,
+                     panid)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/search_card_request.rb

@@ -9,8 +9,8 @@ module ShellCardManagementApIs
     SKIP = Object.new
     private_constant :SKIP
 
-    # Encapsulate the Search details request.
-    # @return [SearchRequest]
+    # TODO: Write general description for this method
+    # @return [Filters]
     attr_accessor :filters
 
     # Page Size – Number of records to show on a page
@@ -46,9 +46,7 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(filters = SKIP,
-                   page_size = SKIP,
-                   page = SKIP)
+    def initialize(filters = SKIP, page_size = SKIP, page = SKIP)
       @filters = filters unless filters == SKIP
       @page_size = page_size unless page_size == SKIP
       @page = page unless page == SKIP
@@ -59,7 +57,7 @@ module ShellCardManagementApIs
       return nil unless hash
 
       # Extract variables from the hash.
-      filters = SearchRequest.from_hash(hash['Filters']) if hash['Filters']
+      filters = Filters.from_hash(hash['Filters']) if hash['Filters']
       page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
       page = hash.key?('Page') ? hash['Page'] : SKIP
 

data/lib/shell_card_management_ap_is/models/{restriction_search_card_request_filters_cards_items.rb → search_card_restriction.rb}

@@ -4,47 +4,50 @@
 # ( https://apimatic.io ).
 
 module ShellCardManagementApIs
-  # RestrictionSearchCardRequestFiltersCardsItems Model.
-  class RestrictionSearchCardRequestFiltersCardsItems < BaseModel
+  # SearchCardRestriction Model.
+  class SearchCardRestriction < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
+    # Unique Card Id 
+    # Optional if PAN is given, else mandatory.
+    # @return [Integer]
+    attr_accessor :card_id
+
     # Card PAN.
     # Optional if CardId is given, else mandatory. 
     # Note: PAN is ignored if CardId is given.
+    # Example: 7002051006629890645
     # @return [String]
     attr_accessor :pan
 
-    # Unique Card Id in GFN.
-    # Optional if PAN is given, else mandatory.
-    # @return [Integer]
-    attr_accessor :card_id
-
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
-      @_hash['pan'] = 'PAN'
       @_hash['card_id'] = 'CardId'
+      @_hash['pan'] = 'PAN'
       @_hash
     end
 
     # An array for optional fields
     def self.optionals
       %w[
-        pan
         card_id
+        pan
       ]
     end
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        card_id
+        pan
+      ]
     end
 
-    def initialize(pan = SKIP,
-                   card_id = SKIP)
-      @pan = pan unless pan == SKIP
+    def initialize(card_id = SKIP, pan = SKIP)
       @card_id = card_id unless card_id == SKIP
+      @pan = pan unless pan == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -52,12 +55,12 @@ module ShellCardManagementApIs
       return nil unless hash
 
       # Extract variables from the hash.
-      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
       card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
 
       # Create object from extracted values.
-      RestrictionSearchCardRequestFiltersCardsItems.new(pan,
-                                                        card_id)
+      SearchCardRestriction.new(card_id,
+                                pan)
     end
   end
 end