card-management-sdk 1.0.0 → 1.2.0

data/lib/shell_card_management_ap_is/models/{restriction_search_card_request_filters.rb → search_card_restriction_req.rb}

@@ -4,11 +4,19 @@
 # ( https://apimatic.io ).
 
 module ShellCardManagementApIs
-  # RestrictionSearchCardRequestFilters Model.
-  class RestrictionSearchCardRequestFilters < BaseModel
+  # SearchCardRestrictionReq Model.
+  class SearchCardRestrictionReq < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
+    # Collecting Company Id of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # Example:
+    # 1 for Philippines
+    # 5 for UK
+    # @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.
@@ -18,13 +26,11 @@ module ShellCardManagementApIs
     # @return [Integer]
     attr_accessor :col_co_code
 
-    # Collecting Company Id (in GFN) of the selected payer. 
-    # Optional if ColCoCode is passed else Mandatory.
-    # Example:
-    # 1 for Philippines
-    # 5 for UK
+    # Payer Id (i.e. Customer Id of the Payment Customer) of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # Example: 123456
     # @return [Integer]
-    attr_accessor :col_co_id
+    attr_accessor :payer_id
 
     # Payer Number of the selected payer.
     # Optional if PayerId is passed else Mandatory
@@ -32,38 +38,32 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :payer_number
 
-    # Payer Id  of the selected payer.
-    # Optional if PayerNumber is passed else Mandatory
-    # Example: 123456
-    # @return [Integer]
-    attr_accessor :payer_id
-
-    # Payer Id  of the selected payer.
-    # Optional if PayerNumber is passed else Mandatory
-    # Example: 123456
+    # Payer Number of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # Example: GB000000123
     # @return [Accounts]
     attr_accessor :accounts
 
-    # Identifier of the Card bundle in Gateway.
+    # Identifier of the Card bundle
     # Optional if cards list is given, else mandatory.
+    # This input is a search criterion, if given.
     # @return [String]
     attr_accessor :bundle_id
 
-    # Identifier of the Card bundle in Gateway.
+    # Identifier of the Card bundle
     # Optional if cards list is given, else mandatory.
-    # @return [Array[RestrictionSearchCardRequestFiltersCardsItems]]
+    # This input is a search criterion, if given.
+    # @return [SearchCardRestriction]
     attr_accessor :cards
 
-    # Whether to include location restriction of the cards in the response
+    # True/False
+    # Whether to include location restriction of the cards in the response.
+    # Optional
+    # Default ‘false’
     # @return [TrueClass | FalseClass]
     attr_accessor :include_location_restrictions
 
-    # When True: service will return the inherited values for the usage limits
-    # (from card-program or account as available) when it is not overridden on
-    # the card.
-    # @return [TrueClass | FalseClass]
-    attr_accessor :include_inherited_limits
-
+    # Default value is False,
     # When the value is True, API will return bundle Id associated with cards in
     # the response, if available. 
     # Note: Use ‘Null’ or ‘False’ for optimum performance. A delay in response
@@ -71,59 +71,67 @@ module ShellCardManagementApIs
     # @return [TrueClass | FalseClass]
     attr_accessor :include_bundle_details
 
+    # Default value is True,
+    # When True: service will return the inherited values for the usage limits
+    # (from card-program or account as available) when it is not overridden on
+    # the card.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_inherited_limits
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
-      @_hash['col_co_code'] = 'ColCoCode'
       @_hash['col_co_id'] = 'ColCoId'
-      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['col_co_code'] = 'ColCoCode'
       @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
       @_hash['accounts'] = 'Accounts'
       @_hash['bundle_id'] = 'BundleId'
       @_hash['cards'] = 'Cards'
       @_hash['include_location_restrictions'] = 'IncludeLocationRestrictions'
-      @_hash['include_inherited_limits'] = 'IncludeInheritedLimits'
       @_hash['include_bundle_details'] = 'IncludeBundleDetails'
+      @_hash['include_inherited_limits'] = 'IncludeInheritedLimits'
       @_hash
     end
 
     # An array for optional fields
     def self.optionals
       %w[
-        col_co_code
         col_co_id
-        payer_number
+        col_co_code
         payer_id
+        payer_number
         accounts
         bundle_id
         cards
         include_location_restrictions
-        include_inherited_limits
         include_bundle_details
+        include_inherited_limits
       ]
     end
 
     # An array for nullable fields
     def self.nullables
       %w[
+        col_co_id
+        col_co_code
+        payer_id
         bundle_id
+        include_location_restrictions
+        include_bundle_details
+        include_inherited_limits
       ]
     end
 
-    def initialize(col_co_code = SKIP,
-                   col_co_id = SKIP,
-                   payer_number = SKIP,
-                   payer_id = SKIP,
-                   accounts = SKIP,
-                   bundle_id = SKIP,
-                   cards = SKIP,
-                   include_location_restrictions = false,
-                   include_inherited_limits = false,
-                   include_bundle_details = false)
-      @col_co_code = col_co_code unless col_co_code == SKIP
+    def initialize(col_co_id = SKIP, col_co_code = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, accounts = SKIP, bundle_id = SKIP,
+                   cards = SKIP, include_location_restrictions = SKIP,
+                   include_bundle_details = SKIP,
+                   include_inherited_limits = SKIP)
       @col_co_id = col_co_id unless col_co_id == SKIP
-      @payer_number = payer_number unless payer_number == 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
       @accounts = accounts unless accounts == SKIP
       @bundle_id = bundle_id unless bundle_id == SKIP
       @cards = cards unless cards == SKIP
@@ -131,8 +139,8 @@ module ShellCardManagementApIs
         @include_location_restrictions =
           include_location_restrictions
       end
-      @include_inherited_limits = include_inherited_limits unless include_inherited_limits == SKIP
       @include_bundle_details = include_bundle_details unless include_bundle_details == SKIP
+      @include_inherited_limits = include_inherited_limits unless include_inherited_limits == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -140,38 +148,31 @@ module ShellCardManagementApIs
       return nil unless hash
 
       # Extract variables from the hash.
-      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
       col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
-      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : 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
       accounts = Accounts.from_hash(hash['Accounts']) if hash['Accounts']
       bundle_id = hash.key?('BundleId') ? hash['BundleId'] : SKIP
-      # Parameter is an array, so we need to iterate through it
-      cards = nil
-      unless hash['Cards'].nil?
-        cards = []
-        hash['Cards'].each do |structure|
-          cards << (RestrictionSearchCardRequestFiltersCardsItems.from_hash(structure) if structure)
-        end
-      end
-
-      cards = SKIP unless hash.key?('Cards')
+      cards = SearchCardRestriction.from_hash(hash['Cards']) if hash['Cards']
       include_location_restrictions =
-        hash['IncludeLocationRestrictions'] ||= false
-      include_inherited_limits = hash['IncludeInheritedLimits'] ||= false
-      include_bundle_details = hash['IncludeBundleDetails'] ||= false
+        hash.key?('IncludeLocationRestrictions') ? hash['IncludeLocationRestrictions'] : SKIP
+      include_bundle_details =
+        hash.key?('IncludeBundleDetails') ? hash['IncludeBundleDetails'] : SKIP
+      include_inherited_limits =
+        hash.key?('IncludeInheritedLimits') ? hash['IncludeInheritedLimits'] : SKIP
 
       # Create object from extracted values.
-      RestrictionSearchCardRequestFilters.new(col_co_code,
-                                              col_co_id,
-                                              payer_number,
-                                              payer_id,
-                                              accounts,
-                                              bundle_id,
-                                              cards,
-                                              include_location_restrictions,
-                                              include_inherited_limits,
-                                              include_bundle_details)
+      SearchCardRestrictionReq.new(col_co_id,
+                                   col_co_code,
+                                   payer_id,
+                                   payer_number,
+                                   accounts,
+                                   bundle_id,
+                                   cards,
+                                   include_location_restrictions,
+                                   include_bundle_details,
+                                   include_inherited_limits)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/search_card_restriction_res.rb

@@ -0,0 +1,89 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # SearchCardRestrictionRes Model.
+  class SearchCardRestrictionRes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Request Id of the API call
+    # @return [String]
+    attr_accessor :request_id
+
+    # Request Id of the API call
+    # @return [Array[RestrictionCardList]]
+    attr_accessor :cards
+
+    # Request Id of the API call
+    # @return [Restriction]
+    attr_accessor :restrictions
+
+    # Request Id of the API call
+    # @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['cards'] = 'cards'
+      @_hash['restrictions'] = 'Restrictions'
+      @_hash['error'] = 'Error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        cards
+        restrictions
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        request_id
+      ]
+    end
+
+    def initialize(request_id = SKIP, cards = SKIP, restrictions = SKIP,
+                   error = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @cards = cards unless cards == SKIP
+      @restrictions = restrictions unless restrictions == SKIP
+      @error = error unless error == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      cards = nil
+      unless hash['cards'].nil?
+        cards = []
+        hash['cards'].each do |structure|
+          cards << (RestrictionCardList.from_hash(structure) if structure)
+        end
+      end
+
+      cards = SKIP unless hash.key?('cards')
+      restrictions = Restriction.from_hash(hash['Restrictions']) if hash['Restrictions']
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+
+      # Create object from extracted values.
+      SearchCardRestrictionRes.new(request_id,
+                                   cards,
+                                   restrictions,
+                                   error)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/search_product_restriction.rb

@@ -10,7 +10,7 @@ module ShellCardManagementApIs
     private_constant :SKIP
 
     # TODO: Write general description for this method
-    # @return [Array[ProductAllOf0]]
+    # @return [Array[RestrictionProduct]]
     attr_accessor :products
 
     # TODO: Write general description for this method
@@ -38,8 +38,7 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(products = SKIP,
-                   product_groups = SKIP)
+    def initialize(products = SKIP, product_groups = SKIP)
       @products = products unless products == SKIP
       @product_groups = product_groups unless product_groups == SKIP
     end
@@ -54,7 +53,7 @@ module ShellCardManagementApIs
       unless hash['Products'].nil?
         products = []
         hash['Products'].each do |structure|
-          products << (ProductAllOf0.from_hash(structure) if structure)
+          products << (RestrictionProduct.from_hash(structure) if structure)
         end
       end
 

data/lib/shell_card_management_ap_is/models/search_request.rb

@@ -334,9 +334,9 @@ module ShellCardManagementApIs
     # If ‘ALL’, API will return cards with ReIssueSetting value True & False
     # both.<br />
     # Allowed Values:<br />
-    # 1.	All<br />
-    # 2.	True<br />
-    # 3.	False
+    # 1.    All<br />
+    # 2.    True<br />
+    # 3.    False
     # @return [String]
     attr_accessor :reissue_setting
 
@@ -351,9 +351,9 @@ module ShellCardManagementApIs
     # 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
+    # 1.    All<br />
+    # 2.    True<br />
+    # 3.    False
     # @return [String]
     attr_accessor :request_id
 
@@ -488,48 +488,26 @@ module ShellCardManagementApIs
       ]
     end
 
-    def 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,
+    def 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,
+                   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 = account_id unless account_id == SKIP
       @account_number = account_number unless account_number == SKIP

data/lib/shell_card_management_ap_is/models/{location_restrictions_shell_site_restrictions_items.rb → shell_site_restriction.rb}

@@ -4,8 +4,8 @@
 # ( https://apimatic.io ).
 
 module ShellCardManagementApIs
-  # LocationRestrictionsShellSiteRestrictionsItems Model.
-  class LocationRestrictionsShellSiteRestrictionsItems < BaseModel
+  # ShellSiteRestriction Model.
+  class ShellSiteRestriction < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
@@ -17,22 +17,17 @@ module ShellCardManagementApIs
 
     # A list of Site IDs in this country, in the format “AA1111” where “AA” is a
     # 2-character country code and “1111” is a 4-digit site number in that
-    # country, which needs to be either restricted or allowed.
-    # A list of values must be passed for either Sites or SiteGroups or both.
-    # Max 10 sites are allowed for the Shell site Restriction.
+    # country, which is either restricted or allowed.
     # For example, “GB1234”.
     # @return [Array[String]]
     attr_accessor :sites
 
-    # A list of site group ids in this country which needs to be either
-    # restricted or allowed.
-    # A list of values must be passed for either Sites or SiteGroups or both.
-    # Max 10 sites groups are allowed for the Shell site Restriction.
+    # A list of site group ids in this country which is either restricted or
+    # allowed.
     # @return [Array[String]]
     attr_accessor :site_groups
 
     # Flag indicates whether the profile is inclusive or exclusive.
-    # Mandatory
     # Example: False - (inclusive), i.e. the “Sites” & “SiteGroups” properties
     # lists the sites & site groups where the transaction will be allowed.
     # True - (exclusive), i.e. the “Sites” & “SiteGroups” properties lists the
@@ -65,9 +60,7 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(country = SKIP,
-                   sites = SKIP,
-                   site_groups = SKIP,
+    def initialize(country = SKIP, sites = SKIP, site_groups = SKIP,
                    exclusive = SKIP)
       @country = country unless country == SKIP
       @sites = sites unless sites == SKIP
@@ -86,10 +79,10 @@ module ShellCardManagementApIs
       exclusive = hash.key?('Exclusive') ? hash['Exclusive'] : SKIP
 
       # Create object from extracted values.
-      LocationRestrictionsShellSiteRestrictionsItems.new(country,
-                                                         sites,
-                                                         site_groups,
-                                                         exclusive)
+      ShellSiteRestriction.new(country,
+                               sites,
+                               site_groups,
+                               exclusive)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/submitted_card.rb

@@ -58,6 +58,14 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :pan
 
+    # PANID of the card
+    # @return [Float]
+    attr_accessor :panid
+
+    # Card PAN
+    # @return [String]
+    attr_accessor :masked_pan
+
     # Payer id of the customer.<br />
     # Optional if PayerNumber is passed, else Mandatory.
     # @return [Integer]
@@ -80,6 +88,8 @@ module ShellCardManagementApIs
       @_hash['col_co_code'] = 'ColCoCode'
       @_hash['col_co_id'] = 'ColCoId'
       @_hash['pan'] = 'PAN'
+      @_hash['panid'] = 'PANID'
+      @_hash['masked_pan'] = 'MaskedPAN'
       @_hash['payer_id'] = 'PayerId'
       @_hash['payer_number'] = 'PayerNumber'
       @_hash
@@ -97,6 +107,8 @@ module ShellCardManagementApIs
         col_co_code
         col_co_id
         pan
+        panid
+        masked_pan
         payer_id
         payer_number
       ]
@@ -114,21 +126,18 @@ module ShellCardManagementApIs
         col_co_code
         col_co_id
         pan
+        panid
+        masked_pan
         payer_id
         payer_number
       ]
     end
 
     def initialize(replacement_card_reference = SKIP,
-                   update_card_reference = SKIP,
-                   account_id = SKIP,
-                   account_number = SKIP,
-                   card_expiry_date = SKIP,
-                   card_id = SKIP,
-                   col_co_code = SKIP,
-                   col_co_id = SKIP,
-                   pan = SKIP,
-                   payer_id = SKIP,
+                   update_card_reference = SKIP, account_id = SKIP,
+                   account_number = SKIP, card_expiry_date = SKIP,
+                   card_id = SKIP, col_co_code = SKIP, col_co_id = SKIP,
+                   pan = SKIP, panid = SKIP, masked_pan = SKIP, payer_id = SKIP,
                    payer_number = SKIP)
       unless replacement_card_reference == SKIP
         @replacement_card_reference =
@@ -142,6 +151,8 @@ module ShellCardManagementApIs
       @col_co_code = col_co_code unless col_co_code == SKIP
       @col_co_id = col_co_id unless col_co_id == SKIP
       @pan = pan unless pan == SKIP
+      @panid = panid unless panid == SKIP
+      @masked_pan = masked_pan unless masked_pan == SKIP
       @payer_id = payer_id unless payer_id == SKIP
       @payer_number = payer_number unless payer_number == SKIP
     end
@@ -163,6 +174,8 @@ module ShellCardManagementApIs
       col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
       col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
       pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      panid = hash.key?('PANID') ? hash['PANID'] : SKIP
+      masked_pan = hash.key?('MaskedPAN') ? hash['MaskedPAN'] : SKIP
       payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
       payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
 
@@ -176,6 +189,8 @@ module ShellCardManagementApIs
                         col_co_code,
                         col_co_id,
                         pan,
+                        panid,
+                        masked_pan,
                         payer_id,
                         payer_number)
     end