card-management-sdk 1.0.0 → 1.2.0

data/lib/shell_card_management_ap_is/models/account_response_accounts_items.rb

@@ -32,10 +32,10 @@ module ShellCardManagementApIs
     # Billing/Invoice frequency. The frequency in which the transactions will be
     # considered for invoicing in a bulling run
     # E.g.: 
-    # 1	Daily (all days)
-    # 2	Daily (only working days)
-    # 3	Weekly - Monday
-    # 4	Weekly – Tuesday
+    # 1    Daily (all days)
+    # 2    Daily (only working days)
+    # 3    Weekly - Monday
+    # 4    Weekly – Tuesday
     # Etc.
     # @return [String]
     attr_accessor :billing_frequency_type
@@ -46,10 +46,10 @@ module ShellCardManagementApIs
     attr_accessor :billing_frequency_type_id
 
     # Frequency at which the billing process is triggered. E.g.: 
-    # 1	Daily (all days)
-    # 2	Daily (only working days)
-    # 3	Weekly - Monday
-    # 4	Weekly – Tuesday
+    # 1    Daily (all days)
+    # 2    Daily (only working days)
+    # 3    Weekly - Monday
+    # 4    Weekly – Tuesday
     # Etc.
     # @return [String]
     attr_accessor :billing_run_frequency
@@ -435,60 +435,36 @@ module ShellCardManagementApIs
       ]
     end
 
-    def initialize(account_full_name = SKIP,
-                   account_id = SKIP,
-                   account_number = SKIP,
-                   account_short_name = SKIP,
-                   best_of_indicator = SKIP,
-                   billing_frequency_type = SKIP,
+    def initialize(account_full_name = SKIP, account_id = SKIP,
+                   account_number = SKIP, account_short_name = SKIP,
+                   best_of_indicator = SKIP, billing_frequency_type = SKIP,
                    billing_frequency_type_id = SKIP,
                    billing_run_frequency = SKIP,
                    billing_run_frequency_type_id = SKIP,
-                   col_co_country_code = SKIP,
-                   currency_code = SKIP,
-                   currency_symbol = SKIP,
-                   day1_run = SKIP,
-                   day2_run = SKIP,
-                   day3_run = SKIP,
-                   day4_run = SKIP,
-                   frequency_type = SKIP,
-                   gross_amount = SKIP,
-                   international_pos_language_code = SKIP,
+                   col_co_country_code = SKIP, currency_code = SKIP,
+                   currency_symbol = SKIP, day1_run = SKIP, day2_run = SKIP,
+                   day3_run = SKIP, day4_run = SKIP, frequency_type = SKIP,
+                   gross_amount = SKIP, international_pos_language_code = SKIP,
                    international_pos_language_id = SKIP,
-                   invoice_account_id = SKIP,
-                   invoice_account_number = SKIP,
+                   invoice_account_id = SKIP, invoice_account_number = SKIP,
                    invoice_account_short_name = SKIP,
-                   invoice_distribution_methods = SKIP,
-                   is_international = SKIP,
-                   is_invoice_point = SKIP,
-                   last_modified_date = SKIP,
-                   local_currency_code = SKIP,
-                   local_currency_symbol = SKIP,
-                   local_pos_language_code = SKIP,
-                   local_pos_language_id = SKIP,
-                   net_amount = SKIP,
-                   outstanding_balance = SKIP,
-                   paid_amount = SKIP,
-                   status = SKIP,
-                   status_reason = SKIP,
-                   total_active_card_groups = SKIP,
-                   total_active_cards = SKIP,
-                   total_blocked_cards = SKIP,
-                   total_cancelled_cards = SKIP,
-                   total_cards = SKIP,
-                   total_expired_cards = SKIP,
-                   total_fraud_cards = SKIP,
-                   total_new_cards = SKIP,
+                   invoice_distribution_methods = SKIP, is_international = SKIP,
+                   is_invoice_point = SKIP, last_modified_date = SKIP,
+                   local_currency_code = SKIP, local_currency_symbol = SKIP,
+                   local_pos_language_code = SKIP, local_pos_language_id = SKIP,
+                   net_amount = SKIP, outstanding_balance = SKIP,
+                   paid_amount = SKIP, status = SKIP, status_reason = SKIP,
+                   total_active_card_groups = SKIP, total_active_cards = SKIP,
+                   total_blocked_cards = SKIP, total_cancelled_cards = SKIP,
+                   total_cards = SKIP, total_expired_cards = SKIP,
+                   total_fraud_cards = SKIP, total_new_cards = SKIP,
                    total_renewal_pending_cards = SKIP,
                    total_replaced_cards = SKIP,
                    total_temporary_block_cards_by_customer = SKIP,
                    total_temporary_block_cards_by_shell = SKIP,
-                   vat_amount = SKIP,
-                   is_partner_card = SKIP,
-                   tolls_customer_id = SKIP,
-                   tolls_colco_country_type_id = SKIP,
-                   contracts = SKIP,
-                   is_consortium_member = SKIP)
+                   vat_amount = SKIP, is_partner_card = SKIP,
+                   tolls_customer_id = SKIP, tolls_colco_country_type_id = SKIP,
+                   contracts = SKIP, is_consortium_member = SKIP)
       @account_full_name = account_full_name unless account_full_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/account_restriction_request.rb

@@ -38,21 +38,30 @@ module ShellCardManagementApIs
     # @return [String]
     attr_accessor :payer_number
 
+    # Account ID of the customer on which the restrictions will be applied.
+    # Optional if AccountNumber is passed, else Mandatory. 
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :account_id
+
     # Account Number of the customer on which the restrictions will be applied.
     # Optional if AccountId is passed, else Mandatory.
+    # Example: GB000000123
     # @return [String]
     attr_accessor :account_number
 
+    # True/False.
     # If true, the usage restrictions applied on the account will be removed.
     # Optional
     # Default: False
     # @return [TrueClass | FalseClass]
     attr_accessor :reset_usage_restrictions
 
+    # True/False.
     # If true, the usage restrictions applied on the account will be removed.
     # Optional
     # Default: False
-    # @return [UsageRestrictions]
+    # @return [Object]
     attr_accessor :usage_restrictions
 
     # A mapping from model property names to API property names.
@@ -62,6 +71,7 @@ module ShellCardManagementApIs
       @_hash['col_co_code'] = 'ColCoCode'
       @_hash['payer_id'] = 'PayerId'
       @_hash['payer_number'] = 'PayerNumber'
+      @_hash['account_id'] = 'AccountId'
       @_hash['account_number'] = 'AccountNumber'
       @_hash['reset_usage_restrictions'] = 'ResetUsageRestrictions'
       @_hash['usage_restrictions'] = 'UsageRestrictions'
@@ -75,6 +85,7 @@ module ShellCardManagementApIs
         col_co_code
         payer_id
         payer_number
+        account_id
         account_number
         reset_usage_restrictions
         usage_restrictions
@@ -84,21 +95,25 @@ module ShellCardManagementApIs
     # An array for nullable fields
     def self.nullables
       %w[
+        col_co_id
+        col_co_code
         payer_id
+        payer_number
+        account_id
+        account_number
+        reset_usage_restrictions
       ]
     end
 
-    def initialize(col_co_id = SKIP,
-                   col_co_code = SKIP,
-                   payer_id = SKIP,
-                   payer_number = SKIP,
-                   account_number = SKIP,
-                   reset_usage_restrictions = false,
+    def initialize(col_co_id = SKIP, col_co_code = SKIP, payer_id = SKIP,
+                   payer_number = SKIP, account_id = SKIP,
+                   account_number = SKIP, reset_usage_restrictions = SKIP,
                    usage_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
       @reset_usage_restrictions = reset_usage_restrictions unless reset_usage_restrictions == SKIP
       @usage_restrictions = usage_restrictions unless usage_restrictions == SKIP
@@ -113,16 +128,19 @@ module ShellCardManagementApIs
       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
-      reset_usage_restrictions = hash['ResetUsageRestrictions'] ||= false
-      usage_restrictions = UsageRestrictions.from_hash(hash['UsageRestrictions']) if
-        hash['UsageRestrictions']
+      reset_usage_restrictions =
+        hash.key?('ResetUsageRestrictions') ? hash['ResetUsageRestrictions'] : SKIP
+      usage_restrictions =
+        hash.key?('UsageRestrictions') ? hash['UsageRestrictions'] : SKIP
 
       # Create object from extracted values.
       AccountRestrictionRequest.new(col_co_id,
                                     col_co_code,
                                     payer_id,
                                     payer_number,
+                                    account_id,
                                     account_number,
                                     reset_usage_restrictions,
                                     usage_restrictions)

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

@@ -10,14 +10,14 @@ module ShellCardManagementApIs
     private_constant :SKIP
 
     # Status of requests to be fetched.
-    # •	Success
-    # •	Failed
-    # •	InProgress
-    # •	Submitted
-    # •	Rejected
-    # •	PendingApproval
-    # •	All
-    # •	MailedToCSC
+    # •    Success
+    # •    Failed
+    # •    InProgress
+    # •    Submitted
+    # •    Rejected
+    # •    PendingApproval
+    # •    All
+    # •    MailedToCSC
     # Optional
     # If not passed “All” will be considered as the default value.
     # @return [String]
@@ -71,22 +71,34 @@ 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
 
     # Allowed Sorting Options:
-    # 1.	SubmittedDateDescending
-    # 2.	SubmittedDateAscending 
-    # 3.	AccountNumberAscending
-    # 4.	AccountNumberDescending
+    # 1.    SubmittedDateDescending
+    # 2.    SubmittedDateAscending 
+    # 3.    AccountNumberAscending
+    # 4.    AccountNumberDescending
     # Optional: Default value is 1
     # Example value to be passed: 1,3
     # @return [String]
@@ -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