card-management-sdk 1.0.0 → 1.1.0

data/lib/shell_card_management_ap_is/models/account_restriction_response.rb

@@ -9,19 +9,44 @@ module ShellCardManagementApIs
     SKIP = Object.new
     private_constant :SKIP
 
-    # API Request Id
+    # Request Id of the API call
     # @return [String]
     attr_accessor :request_id
 
-    # API Response Status
+    # Account Id on which restriction is applied.
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number on which restriction is applied.
+    # Example: GB000000123
+    # @return [String]
+    attr_accessor :account_number
+
+    # Status of the card usage restriction submitted to Gateway. Based on the
+    # response from Gateway value will be set as either “Success” or “Failed”.
+    # @return [String]
+    attr_accessor :usage_restriction_status
+
+    # Response for the usage restriction in case of an error. This field will
+    # have a value only when “UsageRestrictionStatus” is “Failed”.
     # @return [String]
-    attr_accessor :status
+    attr_accessor :usage_restriction_description
+
+    # Response for the usage restriction in case of an error. This field will
+    # have a value only when “UsageRestrictionStatus” is “Failed”.
+    # @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['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['usage_restriction_status'] = 'UsageRestrictionStatus'
+      @_hash['usage_restriction_description'] = 'UsageRestrictionDescription'
+      @_hash['error'] = 'Error'
       @_hash
     end
 
@@ -29,19 +54,33 @@ module ShellCardManagementApIs
     def self.optionals
       %w[
         request_id
-        status
+        account_id
+        account_number
+        usage_restriction_status
+        usage_restriction_description
+        error
       ]
     end
 
     # An array for nullable fields
     def self.nullables
-      []
+      %w[
+        request_id
+      ]
     end
 
-    def initialize(request_id = SKIP,
-                   status = SKIP)
+    def initialize(request_id = SKIP, account_id = SKIP, account_number = SKIP,
+                   usage_restriction_status = SKIP,
+                   usage_restriction_description = SKIP, error = SKIP)
       @request_id = request_id unless request_id == SKIP
-      @status = status unless status == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @usage_restriction_status = usage_restriction_status unless usage_restriction_status == SKIP
+      unless usage_restriction_description == SKIP
+        @usage_restriction_description =
+          usage_restriction_description
+      end
+      @error = error unless error == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -50,11 +89,21 @@ module ShellCardManagementApIs
 
       # Extract variables from the hash.
       request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
-      status = hash.key?('Status') ? hash['Status'] : SKIP
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      usage_restriction_status =
+        hash.key?('UsageRestrictionStatus') ? hash['UsageRestrictionStatus'] : SKIP
+      usage_restriction_description =
+        hash.key?('UsageRestrictionDescription') ? hash['UsageRestrictionDescription'] : SKIP
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
 
       # Create object from extracted values.
       AccountRestrictionResponse.new(request_id,
-                                     status)
+                                     account_id,
+                                     account_number,
+                                     usage_restriction_status,
+                                     usage_restriction_description,
+                                     error)
     end
   end
 end

data/lib/shell_card_management_ap_is/models/account_velocity_limit.rb

@@ -21,7 +21,8 @@ module ShellCardManagementApIs
 
     # The limit associated with this velocity with the correct number of digits
     # after the decimal point according to the minor denomination of the
-    # currency of the card issuer (except for COUNT type velocity).
+    # currency of the card issuer.
+    # Example: 1500.55
     # @return [Float]
     attr_accessor :limit
 
@@ -29,6 +30,7 @@ module ShellCardManagementApIs
     # number of digits after the decimal point according to the minor
     # denomination of the currency of the card issuer (except for COUNT type
     # velocity). Not present for PERTRX period.
+    # Example: 1100.55
     # @return [Float]
     attr_accessor :accumulation
 
@@ -36,10 +38,12 @@ module ShellCardManagementApIs
     # number of digits after the decimal point according to the minor
     # denomination of the currency of the card issuer (except for COUNT type
     # velocity). Not present for PERTRX period.
+    # Example: 400.55
     # @return [Float]
     attr_accessor :balance
 
     # Indicate if the limit is overridden or default. (false for default).
+    # Example: false
     # @return [TrueClass | FalseClass]
     attr_accessor :override
 
@@ -54,6 +58,8 @@ module ShellCardManagementApIs
     # it or below. 0 indicates no alerts will be sent. Not present if not set
     # (issuer value threshold limit applies if available). Not present for COUNT
     # type velocity.
+    # Example: 50.55
+    # This is an optional output field.
     # @return [Float]
     attr_accessor :threshold
 
@@ -87,26 +93,12 @@ module ShellCardManagementApIs
 
     # An array for nullable fields
     def self.nullables
-      %w[
-        type
-        period
-        limit
-        accumulation
-        balance
-        override
-        product_group
-        threshold
-      ]
+      []
     end
 
-    def initialize(type = SKIP,
-                   period = SKIP,
-                   limit = SKIP,
-                   accumulation = SKIP,
-                   balance = SKIP,
-                   override = SKIP,
-                   product_group = SKIP,
-                   threshold = SKIP)
+    def initialize(type = SKIP, period = SKIP, limit = SKIP,
+                   accumulation = SKIP, balance = SKIP, override = SKIP,
+                   product_group = SKIP, threshold = SKIP)
       @type = type unless type == SKIP
       @period = period unless period == SKIP
       @limit = limit unless limit == SKIP

data/lib/shell_card_management_ap_is/models/accounts.rb

@@ -43,8 +43,7 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(account_id = SKIP,
-                   account_number = SKIP)
+    def initialize(account_id = SKIP, account_number = SKIP)
       @account_id = account_id unless account_id == SKIP
       @account_number = account_number unless account_number == SKIP
     end

data/lib/shell_card_management_ap_is/models/address.rb

@@ -111,17 +111,10 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(address_id = SKIP,
-                   address_line1 = SKIP,
-                   address_line2 = SKIP,
-                   address_line3 = SKIP,
-                   zip_code = SKIP,
-                   city = SKIP,
-                   region_id = SKIP,
-                   country_iso_code = SKIP,
-                   country = SKIP,
-                   telephone = SKIP,
-                   email_address = SKIP,
+    def initialize(address_id = SKIP, address_line1 = SKIP,
+                   address_line2 = SKIP, address_line3 = SKIP, zip_code = SKIP,
+                   city = SKIP, region_id = SKIP, country_iso_code = SKIP,
+                   country = SKIP, telephone = SKIP, email_address = SKIP,
                    fax = SKIP)
       @address_id = address_id unless address_id == SKIP
       @address_line1 = address_line1 unless address_line1 == SKIP

data/lib/shell_card_management_ap_is/models/audit_request.rb

@@ -71,14 +71,26 @@ module ShellCardManagementApIs
     # @return [Integer]
     attr_accessor :page_size
 
-    # To search for requests submitted until this date.
-    # Optional 
-    # Format: yyyyMMdd 
-    # Example: 20200130
-    # If ToDate is not provided and FromDate is provided, then ToDate will be
-    # considered as current date or 30 days from FromDate, whichever is earlier.
-    # However, when both FromDate and ToDate is not provided then last 30 days
-    # will be considered for filtering.
+    # Type of requests to be fetched.
+    # Optional
+    # Allowed values:
+    # •	OrderCard
+    # •	CreateCardGroup
+    # •	PINReminder
+    # •	MoveCard
+    # •	UpdateCardStatus
+    # •	UpdateCardGroup
+    # •	AutoRenew
+    # •	BulkCardOrder
+    # •	BulkCardBlock
+    # •	BulkCardOrderMultiAccount
+    # •	MobilePaymentRegistration
+    # •	UpdateCompanyInfo
+    # •	BCOSummary
+    # •	BCOMultiAccountSummary
+    # •	BCBSummary
+    # •	FundTransfer
+    # •	DeliveryAddressUpdate
     # @return [Array[String]]
     attr_accessor :requested_operation
 
@@ -185,19 +197,11 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(status = SKIP,
-                   payer_number = SKIP,
-                   payer_id = SKIP,
-                   account_number = SKIP,
-                   col_co_code = SKIP,
-                   col_co_id = SKIP,
-                   accounts = SKIP,
-                   page_size = SKIP,
-                   requested_operation = SKIP,
-                   sort_order = SKIP,
-                   search_text = SKIP,
-                   current_page = SKIP,
-                   from_date = SKIP,
+    def initialize(status = SKIP, payer_number = SKIP, payer_id = SKIP,
+                   account_number = SKIP, col_co_code = SKIP, col_co_id = SKIP,
+                   accounts = SKIP, page_size = SKIP,
+                   requested_operation = SKIP, sort_order = SKIP,
+                   search_text = SKIP, current_page = SKIP, from_date = SKIP,
                    to_date = SKIP)
       @status = status unless status == SKIP
       @payer_number = payer_number unless payer_number == SKIP

data/lib/shell_card_management_ap_is/models/audit_response.rb

@@ -64,12 +64,8 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(audits = SKIP,
-                   current_page = SKIP,
-                   row_count = SKIP,
-                   total_pages = SKIP,
-                   error = SKIP,
-                   request_id = SKIP)
+    def initialize(audits = SKIP, current_page = SKIP, row_count = SKIP,
+                   total_pages = SKIP, error = SKIP, request_id = SKIP)
       @audits = audits unless audits == SKIP
       @current_page = current_page unless current_page == SKIP
       @row_count = row_count unless row_count == SKIP

data/lib/shell_card_management_ap_is/models/audit_response_audits_items.rb

@@ -297,8 +297,7 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(account_id = SKIP,
-                   account_number = SKIP,
+    def initialize(account_id = SKIP, account_number = SKIP,
                    additional_information1 = SKIP,
                    additional_information2 = SKIP,
                    additional_information3 = SKIP,
@@ -307,26 +306,14 @@ module ShellCardManagementApIs
                    additional_information6 = SKIP,
                    additional_information7 = SKIP,
                    additional_information8 = SKIP,
-                   additional_information9 = SKIP,
-                   card_group_id = SKIP,
-                   card_group_name = SKIP,
-                   card_id = SKIP,
-                   col_co_code = SKIP,
-                   col_co_id = SKIP,
-                   error_code = SKIP,
-                   error_string = SKIP,
-                   global_request_id = SKIP,
-                   pan = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   processed_on = SKIP,
-                   requested_by = SKIP,
-                   requested_operation = SKIP,
-                   request_reference = SKIP,
-                   request_type = SKIP,
-                   status = SKIP,
-                   submitted_on = SKIP,
-                   sub_request_reference = SKIP,
+                   additional_information9 = SKIP, card_group_id = SKIP,
+                   card_group_name = SKIP, card_id = SKIP, col_co_code = SKIP,
+                   col_co_id = SKIP, error_code = SKIP, error_string = SKIP,
+                   global_request_id = SKIP, pan = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, processed_on = SKIP,
+                   requested_by = SKIP, requested_operation = SKIP,
+                   request_reference = SKIP, request_type = SKIP, status = SKIP,
+                   submitted_on = SKIP, sub_request_reference = SKIP,
                    user_display_name = 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/auto_renew_card_request.rb

@@ -68,11 +68,8 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(col_co_id = SKIP,
-                   col_co_code = SKIP,
-                   payer_number = SKIP,
-                   payer_id = SKIP,
-                   auto_renew_cards = SKIP)
+    def initialize(col_co_id = SKIP, col_co_code = SKIP, payer_number = SKIP,
+                   payer_id = SKIP, auto_renew_cards = 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

data/lib/shell_card_management_ap_is/models/auto_renew_card_request_auto_renew_cards_items.rb

@@ -63,11 +63,8 @@ module ShellCardManagementApIs
       []
     end
 
-    def initialize(reissue_setting = nil,
-                   account_number = SKIP,
-                   account_id = SKIP,
-                   pan = SKIP,
-                   card_id = SKIP)
+    def initialize(reissue_setting = nil, account_number = SKIP,
+                   account_id = SKIP, pan = 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

data/lib/shell_card_management_ap_is/models/auto_renew_card_response.rb

@@ -53,9 +53,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/auto_renew_card_response_data_items.rb

@@ -41,8 +41,7 @@ module ShellCardManagementApIs
       ]
     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)
       @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
     end

data/lib/shell_card_management_ap_is/models/bank_account.rb

@@ -123,19 +123,11 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(account_number = SKIP,
-                   bank_name = SKIP,
-                   account_name = SKIP,
-                   date_effective = SKIP,
-                   date_terminated = SKIP,
-                   iban = SKIP,
-                   currency_code = SKIP,
-                   currency_symbol = SKIP,
-                   country_iso_code = SKIP,
-                   country = SKIP,
-                   sort_code = SKIP,
-                   swift_code = SKIP,
-                   bank_type = SKIP)
+    def initialize(account_number = SKIP, bank_name = SKIP, account_name = SKIP,
+                   date_effective = SKIP, date_terminated = SKIP, iban = SKIP,
+                   currency_code = SKIP, currency_symbol = SKIP,
+                   country_iso_code = SKIP, country = SKIP, sort_code = SKIP,
+                   swift_code = SKIP, bank_type = SKIP)
       @account_number = account_number unless account_number == SKIP
       @bank_name = bank_name unless bank_name == SKIP
       @account_name = account_name unless account_name == SKIP

data/lib/shell_card_management_ap_is/models/{search_account_limit_request_filters.rb → budle_details_request.rb}

@@ -4,12 +4,12 @@
 # ( https://apimatic.io ).
 
 module ShellCardManagementApIs
-  # SearchAccountLimitRequestFilters Model.
-  class SearchAccountLimitRequestFilters < BaseModel
+  # BudleDetailsRequest Model.
+  class BudleDetailsRequest < BaseModel
     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
@@ -26,10 +26,10 @@ module ShellCardManagementApIs
     # @return [Integer]
     attr_accessor :col_co_code
 
-    # Payer Id  of the selected payer.
+    # Payer Id of the selected payer.
     # Optional if PayerNumber is passed else Mandatory
     # Example: 123456
-    # @return [Integer]
+    # @return [String]
     attr_accessor :payer_id
 
     # Payer Number of the selected payer.
@@ -38,17 +38,24 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :payer_number
 
-    # Optional if AccountNumber is passed else Mandatory
+    # 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.
-    # Optional if AccountId is passed else Mandatory
+    # Optional if Account Id is passed else Mandatory
     # Example: GB000000123
     # @return [String]
     attr_accessor :account_number
 
+    # Bundle Id associated with account
+    # Mandatory.
+    # Example: 835662721
+    # @return [String]
+    attr_accessor :bundle_id
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -58,6 +65,7 @@ module ShellCardManagementApIs
       @_hash['payer_number'] = 'PayerNumber'
       @_hash['account_id'] = 'AccountId'
       @_hash['account_number'] = 'AccountNumber'
+      @_hash['bundle_id'] = 'BundleId'
       @_hash
     end
 
@@ -70,28 +78,25 @@ module ShellCardManagementApIs
         payer_number
         account_id
         account_number
+        bundle_id
       ]
     end
 
     # An array for nullable fields
     def self.nullables
-      %w[
-        col_co_id
-      ]
+      []
     end
 
-    def initialize(col_co_id = SKIP,
-                   col_co_code = SKIP,
-                   payer_id = SKIP,
-                   payer_number = 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_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 unless bundle_id == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -105,14 +110,16 @@ module ShellCardManagementApIs
       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.
-      SearchAccountLimitRequestFilters.new(col_co_id,
-                                           col_co_code,
-                                           payer_id,
-                                           payer_number,
-                                           account_id,
-                                           account_number)
+      BudleDetailsRequest.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/{create_bundle_response_data_items_cards_items.rb → bundle_card_restriction_status.rb}

@@ -4,12 +4,13 @@
 # ( https://apimatic.io ).
 
 module ShellCardManagementApIs
-  # CreateBundleResponseDataItemsCardsItems Model.
-  class CreateBundleResponseDataItemsCardsItems < BaseModel
+  # BundleCardRestrictionStatus Model.
+  class BundleCardRestrictionStatus < BaseModel
     SKIP = Object.new
     private_constant :SKIP
 
     # Card PAN.
+    # Example: 7002051006629890645
     # @return [String]
     attr_accessor :pan
 
@@ -44,7 +45,7 @@ module ShellCardManagementApIs
       pan = hash.key?('PAN') ? hash['PAN'] : SKIP
 
       # Create object from extracted values.
-      CreateBundleResponseDataItemsCardsItems.new(pan)
+      BundleCardRestrictionStatus.new(pan)
     end
   end
 end