card-management-sdk 1.0.0 → 1.2.0

data/lib/shell_card_management_ap_is/models/summary_request.rb

@@ -271,9 +271,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
 
@@ -288,9 +288,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
 
@@ -406,41 +406,23 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(card_status = nil,
-                   request_id = nil,
-                   account_id = SKIP,
-                   account_number = SKIP,
-                   col_co_code = SKIP,
-                   col_co_country_code = SKIP,
-                   col_co_id = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   card_group_id = SKIP,
-                   card_group_name = SKIP,
-                   expiring_in_days = SKIP,
-                   issued_after = SKIP,
-                   pan_ends_with = SKIP,
-                   driver_name = SKIP,
-                   vehicle_registration_number = SKIP,
-                   include_cards = SKIP,
-                   exclude_cards = SKIP,
-                   exclude_bundle_id = SKIP,
-                   card_segment = SKIP,
-                   purchase_category_code = SKIP,
-                   card_type_code = SKIP,
+    def initialize(card_status = nil, request_id = nil, account_id = SKIP,
+                   account_number = SKIP, col_co_code = SKIP,
+                   col_co_country_code = SKIP, col_co_id = SKIP,
+                   payer_id = SKIP, payer_number = SKIP, card_group_id = SKIP,
+                   card_group_name = SKIP, expiring_in_days = SKIP,
+                   issued_after = SKIP, pan_ends_with = SKIP,
+                   driver_name = SKIP, vehicle_registration_number = SKIP,
+                   include_cards = SKIP, exclude_cards = SKIP,
+                   exclude_bundle_id = SKIP, card_segment = SKIP,
+                   purchase_category_code = SKIP, card_type_code = SKIP,
                    exclude_pending_renewal_cards = SKIP,
                    exclude_cancelled_cards = SKIP,
-                   exclude_replaced_cards = SKIP,
-                   exclude_fraud_cards = SKIP,
-                   exclude_card_group_id = SKIP,
-                   exclude_card_group_name = SKIP,
-                   creation_date = SKIP,
-                   effective_date = SKIP,
-                   network = SKIP,
-                   coverage = SKIP,
-                   expiry_month = SKIP,
-                   exclude_old_cards = SKIP,
-                   reissue_setting = SKIP)
+                   exclude_replaced_cards = SKIP, exclude_fraud_cards = SKIP,
+                   exclude_card_group_id = SKIP, exclude_card_group_name = SKIP,
+                   creation_date = SKIP, effective_date = SKIP, network = SKIP,
+                   coverage = SKIP, expiry_month = SKIP,
+                   exclude_old_cards = SKIP, reissue_setting = SKIP)
       @account_id = account_id unless account_id == SKIP
       @account_number = account_number unless account_number == SKIP
       @col_co_code = col_co_code unless col_co_code == SKIP

data/lib/shell_card_management_ap_is/models/summary_response.rb

@@ -115,18 +115,12 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(active_cards = SKIP,
-                   blocked_cards = SKIP,
-                   cancelled_cards = SKIP,
-                   expired_cards = SKIP,
-                   expiring_cards = SKIP,
-                   fraud_cards = SKIP,
-                   new_cards = SKIP,
-                   renewal_pending_cards = SKIP,
-                   replaced_cards = SKIP,
+    def initialize(active_cards = SKIP, blocked_cards = SKIP,
+                   cancelled_cards = SKIP, expired_cards = SKIP,
+                   expiring_cards = SKIP, fraud_cards = SKIP, new_cards = SKIP,
+                   renewal_pending_cards = SKIP, replaced_cards = SKIP,
                    temporary_block_by_customer = SKIP,
-                   temporary_block_by_shell = SKIP,
-                   total_cards = SKIP)
+                   temporary_block_by_shell = SKIP, total_cards = SKIP)
       @active_cards = active_cards unless active_cards == SKIP
       @blocked_cards = blocked_cards unless blocked_cards == SKIP
       @cancelled_cards = cancelled_cards unless cancelled_cards == SKIP

data/lib/shell_card_management_ap_is/models/{summary_of_bundle_response_data_items.rb → summaryofbundle_response.rb}

@@ -4,11 +4,15 @@
 # ( https://apimatic.io ).
 
 module ShellCardManagementApIs
-  # SummaryOfBundleResponseDataItems Model.
-  class SummaryOfBundleResponseDataItems < BaseModel
+  # SummaryofbundleResponse Model.
+  class SummaryofbundleResponse < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
+    # Request Id of the API call
+    # @return [String]
+    attr_accessor :request_id
+
     # Payer Id of the bundles and cards.
     # Example: 123456
     # @return [Integer]
@@ -19,8 +23,8 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :payer_number
 
-    # Account ID of the bundle.
-    # Example: 123456
+    # Payer Number of the bundles and cards.
+    # Example: GB000000123
     # @return [Integer]
     attr_accessor :account_id
 
@@ -33,51 +37,54 @@ module ShellCardManagementApIs
     # @return [Integer]
     attr_accessor :count_of_cards_not_in_bundle
 
-    # List of Card Bundles
-    # @return [Array[SummaryOfBundleResponseDataItemsCardBundlesItems]]
+    # Count of cards that are not part of the bundle in a given account.
+    # @return [CardBundle]
     attr_accessor :card_bundles
 
+    # Count of cards that are not part of the bundle in a given account.
+    # @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['payer_id'] = 'PayerId'
       @_hash['payer_number'] = 'PayerNumber'
       @_hash['account_id'] = 'AccountId'
       @_hash['account_number'] = 'AccountNumber'
       @_hash['count_of_cards_not_in_bundle'] = 'CountOfCardsNotInBundle'
       @_hash['card_bundles'] = 'CardBundles'
+      @_hash['error'] = 'Error'
       @_hash
     end
 
     # An array for optional fields
     def self.optionals
       %w[
+        request_id
         payer_id
         payer_number
         account_id
         account_number
         count_of_cards_not_in_bundle
         card_bundles
+        error
       ]
     end
 
     # An array for nullable fields
     def self.nullables
       %w[
-        payer_id
-        payer_number
-        account_id
-        account_number
-        count_of_cards_not_in_bundle
+        request_id
       ]
     end
 
-    def initialize(payer_id = SKIP,
-                   payer_number = SKIP,
-                   account_id = SKIP,
-                   account_number = SKIP,
-                   count_of_cards_not_in_bundle = SKIP,
-                   card_bundles = SKIP)
+    def initialize(request_id = SKIP, payer_id = SKIP, payer_number = SKIP,
+                   account_id = SKIP, account_number = SKIP,
+                   count_of_cards_not_in_bundle = SKIP, card_bundles = SKIP,
+                   error = SKIP)
+      @request_id = request_id unless request_id == 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
@@ -87,6 +94,7 @@ module ShellCardManagementApIs
           count_of_cards_not_in_bundle
       end
       @card_bundles = card_bundles unless card_bundles == SKIP
+      @error = error unless error == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -94,30 +102,25 @@ module ShellCardManagementApIs
       return nil unless hash
 
       # Extract variables from the hash.
+      request_id = hash.key?('RequestId') ? hash['RequestId'] : 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
       count_of_cards_not_in_bundle =
         hash.key?('CountOfCardsNotInBundle') ? hash['CountOfCardsNotInBundle'] : SKIP
-      # Parameter is an array, so we need to iterate through it
-      card_bundles = nil
-      unless hash['CardBundles'].nil?
-        card_bundles = []
-        hash['CardBundles'].each do |structure|
-          card_bundles << (SummaryOfBundleResponseDataItemsCardBundlesItems.from_hash(structure) if structure)
-        end
-      end
-
-      card_bundles = SKIP unless hash.key?('CardBundles')
+      card_bundles = CardBundle.from_hash(hash['CardBundles']) if hash['CardBundles']
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
 
       # Create object from extracted values.
-      SummaryOfBundleResponseDataItems.new(payer_id,
-                                           payer_number,
-                                           account_id,
-                                           account_number,
-                                           count_of_cards_not_in_bundle,
-                                           card_bundles)
+      SummaryofbundleResponse.new(request_id,
+                                  payer_id,
+                                  payer_number,
+                                  account_id,
+                                  account_number,
+                                  count_of_cards_not_in_bundle,
+                                  card_bundles,
+                                  error)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/{summaryof_bundle.rb → summaryofbundler_request.rb}

@@ -4,8 +4,8 @@
 # ( https://apimatic.io ).
 
 module ShellCardManagementApIs
-  # SummaryofBundle Model.
-  class SummaryofBundle < BaseModel
+  # SummaryofbundlerRequest Model.
+  class SummaryofbundlerRequest < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
@@ -13,6 +13,7 @@ module ShellCardManagementApIs
     # Optional if ColCoCode is passed else Mandatory.
     # Example:
     # 1 for Philippines
+    # 5 for UK
     # @return [Integer]
     attr_accessor :col_co_id
 
@@ -25,32 +26,34 @@ module ShellCardManagementApIs
     # @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.
-    # Either PayerId or PayerNumber or both must be passed.
+    # Optional if PayerId is passed else Mandatory
     # Example: GB000000123
     # @return [String]
     attr_accessor :payer_number
 
-    # Payer Id of the selected payer.
-    # Either PayerId or PayerNumber or both must be passed.
-    # Example: 123456
-    # @return [Integer]
-    attr_accessor :payer_id
-
-    # Account ID of the customer.
-    # Either AccountId or AccountNumber or both must be passed.
+    # Account Id of the customer.
+    # Optional if Account Number is passed else Mandatory
     # Example: 123456
     # @return [Integer]
     attr_accessor :account_id
 
-    # Account Number of the customer. 
-    # Either AccountId or AccountNumber or both must be passed.
+    # Account Number of the customer.
+    # Optional if Account Id is passed else Mandatory
     # Example: GB000000123
     # @return [String]
     attr_accessor :account_number
 
-    # Identifier of the card bundle in Gateway.
-    # Mandatory
+    # List of Bundle Id associated with account
+    # Optional.
+    # When not present all the bundles in the given account will be returned in
+    # the response.
     # @return [Array[String]]
     attr_accessor :bundle_id
 
@@ -59,8 +62,8 @@ module ShellCardManagementApIs
       @_hash = {} if @_hash.nil?
       @_hash['col_co_id'] = 'ColCoId'
       @_hash['col_co_code'] = 'ColCoCode'
-      @_hash['payer_number'] = 'PayerNumber'
       @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
       @_hash['account_id'] = 'AccountId'
       @_hash['account_number'] = 'AccountNumber'
       @_hash['bundle_id'] = 'BundleId'
@@ -72,32 +75,36 @@ module ShellCardManagementApIs
       %w[
         col_co_id
         col_co_code
-        payer_number
         payer_id
+        payer_number
         account_id
         account_number
+        bundle_id
       ]
     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(bundle_id = nil,
-                   col_co_id = SKIP,
-                   col_co_code = SKIP,
-                   payer_number = SKIP,
-                   payer_id = SKIP,
-                   account_id = SKIP,
-                   account_number = SKIP)
+    def initialize(col_co_id = SKIP, col_co_code = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, account_id = SKIP,
+                   account_number = SKIP, bundle_id = SKIP)
       @col_co_id = col_co_id unless col_co_id == SKIP
       @col_co_code = col_co_code unless col_co_code == SKIP
-      @payer_number = payer_number unless payer_number == 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
-      @bundle_id = bundle_id
+      @bundle_id = bundle_id unless bundle_id == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -105,22 +112,22 @@ module ShellCardManagementApIs
       return nil unless hash
 
       # Extract variables from the hash.
-      bundle_id = hash.key?('BundleId') ? hash['BundleId'] : nil
       col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
       col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
-      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : 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
+      bundle_id = hash.key?('BundleId') ? hash['BundleId'] : SKIP
 
       # Create object from extracted values.
-      SummaryofBundle.new(bundle_id,
-                          col_co_id,
-                          col_co_code,
-                          payer_number,
-                          payer_id,
-                          account_id,
-                          account_number)
+      SummaryofbundlerRequest.new(col_co_id,
+                                  col_co_code,
+                                  payer_id,
+                                  payer_number,
+                                  account_id,
+                                  account_number,
+                                  bundle_id)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/update_bundle_request.rb

@@ -9,7 +9,7 @@ module ShellCardManagementApIs
     SKIP = Object.new
     private_constant :SKIP
 
-    # Collecting Company Id of the selected payer. 
+    # Collecting Company Id  of the selected payer. 
     # Optional if ColCoCode is passed else Mandatory.
     # Example:
     # 1 for Philippines
@@ -17,18 +17,39 @@ module ShellCardManagementApIs
     # @return [Integer]
     attr_accessor :col_co_id
 
+    # Collecting Company 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.
     # Either PayerId or PayerNumber or both must be passed.
     # Example: 123456
-    # @return [Integer]
+    # @return [String]
     attr_accessor :payer_id
 
+    # Payer Number of the selected payer.
+    # Either PayerId or PayerNumber or both must be passed.
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :payer_number
+
     # Account ID of the customer.
     # Either AccountId or AccountNumber or both must be passed.
     # Example: 123456
     # @return [Integer]
     attr_accessor :account_id
 
+    # Account Number of the customer. 
+    # Either AccountId or AccountNumber or both must be passed.
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :account_number
+
     # Identifier of the bundle in Gateway.
     # Mandatory
     # @return [String]
@@ -37,9 +58,9 @@ module ShellCardManagementApIs
     # The value indicates the action to be performed with the request.
     # Mandatory
     # Allowed values:
-    # •	Add
-    # •	Update
-    # •	Remove
+    # •    Add
+    # •    Update
+    # •    Remove
     # @return [String]
     attr_accessor :request_action
 
@@ -47,7 +68,7 @@ module ShellCardManagementApIs
     # Mandatory for Add / Remove request action. Ignored for Update action.
     # Example: 7002051006629890645
     # When PAN matches with multiple cards, the restriction will be applied on
-    # the latest issued card
+    # the latest issued card.
     # @return [Array[String]]
     attr_accessor :cards
 
@@ -55,8 +76,8 @@ module ShellCardManagementApIs
     # restrictions on the list of cards being added or removed.
     # Mandatory for Add / Remove request action. Ignored for Update action.
     # Allowed values:
-    # •	Update
-    # •	None
+    # •    Update
+    # •    None
     # @return [String]
     attr_accessor :usage_restriction_action
 
@@ -64,46 +85,25 @@ module ShellCardManagementApIs
     # restrictions on the list of cards being added or removed.
     # Mandatory for Add / Remove request action. Ignored for Update action.
     # Allowed values:
-    # •	Update
-    # •	None
-    # @return [BundleRestriction]
+    # •    Update
+    # •    None
+    # @return [BundleRestrictionUpdate]
     attr_accessor :restrictions
 
-    # 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 Number of the selected payer.
-    # Either PayerId or PayerNumber or both must be passed.
-    # Example: GB000000123
-    # @return [String]
-    attr_accessor :payer_number
-
-    # Account Number of the customer. 
-    # Either AccountId or AccountNumber or both must be passed.
-    # 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['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['bundle_id'] = 'BundleId'
       @_hash['request_action'] = 'RequestAction'
       @_hash['cards'] = 'Cards'
       @_hash['usage_restriction_action'] = 'UsageRestrictionAction'
       @_hash['restrictions'] = 'Restrictions'
-      @_hash['col_co_code'] = 'ColCoCode'
-      @_hash['payer_number'] = 'PayerNumber'
-      @_hash['account_number'] = 'AccountNumber'
       @_hash
     end
 
@@ -111,14 +111,12 @@ module ShellCardManagementApIs
     def self.optionals
       %w[
         col_co_id
-        payer_id
-        account_id
-        cards
-        usage_restriction_action
-        restrictions
         col_co_code
+        payer_id
         payer_number
+        account_id
         account_number
+        restrictions
       ]
     end
 
@@ -126,37 +124,33 @@ module ShellCardManagementApIs
     def self.nullables
       %w[
         col_co_id
-        payer_id
-        account_id
-        request_action
         col_co_code
+        payer_id
         payer_number
+        account_id
         account_number
+        bundle_id
+        request_action
+        usage_restriction_action
       ]
     end
 
-    def initialize(bundle_id = nil,
-                   request_action = nil,
-                   col_co_id = SKIP,
-                   payer_id = SKIP,
-                   account_id = SKIP,
-                   cards = SKIP,
-                   usage_restriction_action = SKIP,
-                   restrictions = SKIP,
-                   col_co_code = SKIP,
-                   payer_number = SKIP,
-                   account_number = SKIP)
+    def initialize(bundle_id = nil, request_action = nil, cards = nil,
+                   usage_restriction_action = nil, col_co_id = SKIP,
+                   col_co_code = SKIP, payer_id = SKIP, payer_number = SKIP,
+                   account_id = SKIP, account_number = SKIP,
+                   restrictions = 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
       @bundle_id = bundle_id
       @request_action = request_action
-      @cards = cards unless cards == SKIP
-      @usage_restriction_action = usage_restriction_action unless usage_restriction_action == SKIP
+      @cards = cards
+      @usage_restriction_action = usage_restriction_action
       @restrictions = restrictions unless restrictions == SKIP
-      @col_co_code = col_co_code unless col_co_code == SKIP
-      @payer_number = payer_number unless payer_number == SKIP
-      @account_number = account_number unless account_number == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -166,29 +160,30 @@ module ShellCardManagementApIs
       # Extract variables from the hash.
       bundle_id = hash.key?('BundleId') ? hash['BundleId'] : nil
       request_action = hash.key?('RequestAction') ? hash['RequestAction'] : nil
-      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
-      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
-      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
-      cards = hash.key?('Cards') ? hash['Cards'] : SKIP
+      cards = hash.key?('Cards') ? hash['Cards'] : nil
       usage_restriction_action =
-        hash.key?('UsageRestrictionAction') ? hash['UsageRestrictionAction'] : SKIP
-      restrictions = BundleRestriction.from_hash(hash['Restrictions']) if hash['Restrictions']
+        hash.key?('UsageRestrictionAction') ? hash['UsageRestrictionAction'] : nil
+      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
+      restrictions = BundleRestrictionUpdate.from_hash(hash['Restrictions']) if
+        hash['Restrictions']
 
       # Create object from extracted values.
       UpdateBundleRequest.new(bundle_id,
                               request_action,
-                              col_co_id,
-                              payer_id,
-                              account_id,
                               cards,
                               usage_restriction_action,
-                              restrictions,
+                              col_co_id,
                               col_co_code,
+                              payer_id,
                               payer_number,
-                              account_number)
+                              account_id,
+                              account_number,
+                              restrictions)
     end
   end
 end