card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/summary_response.rb

@@ -0,0 +1,184 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Encapsulates the details of a Summary response.
+  class SummaryResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total number of active cards for the given search criteria
+    # @return [Integer]
+    attr_accessor :active_cards
+
+    # Total number of cards for the given search criteria that are permanently
+    # blocked (Blocked)
+    # @return [Integer]
+    attr_accessor :blocked_cards
+
+    # Total number of cards for the given search criteria that are cancelled (at
+    # cancelled status) blocked by customer
+    # @return [Integer]
+    attr_accessor :cancelled_cards
+
+    # Total number of expired cards for the given search criteria
+    # @return [Integer]
+    attr_accessor :expired_cards
+
+    # Cards that are active and expiring in X days, X should be configurable
+    # @return [Integer]
+    attr_accessor :expiring_cards
+
+    # Totalnumber of Cards in Fraud status for the given search criteria.
+    # @return [Integer]
+    attr_accessor :fraud_cards
+
+    # Total number of cards in New status for the given search criteria.
+    # @return [Integer]
+    attr_accessor :new_cards
+
+    # Total number of Renewal Pending cards for the given search criteria
+    # @return [Integer]
+    attr_accessor :renewal_pending_cards
+
+    # Cards with status Replaced
+    # @return [Integer]
+    attr_accessor :replaced_cards
+
+    # Total number of cards for the given search criteria that are temporarily
+    # blocked by customer
+    # @return [Integer]
+    attr_accessor :temporary_block_by_customer
+
+    # Total number of cards for the given search criteria that are temporarily
+    # blocked by Shell
+    # @return [Integer]
+    attr_accessor :temporary_block_by_shell
+
+    # Total number of cards for the given search criteria
+    # @return [Integer]
+    attr_accessor :total_cards
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['active_cards'] = 'ActiveCards'
+      @_hash['blocked_cards'] = 'BlockedCards'
+      @_hash['cancelled_cards'] = 'CancelledCards'
+      @_hash['expired_cards'] = 'ExpiredCards'
+      @_hash['expiring_cards'] = 'ExpiringCards'
+      @_hash['fraud_cards'] = 'FraudCards'
+      @_hash['new_cards'] = 'NewCards'
+      @_hash['renewal_pending_cards'] = 'RenewalPendingCards'
+      @_hash['replaced_cards'] = 'ReplacedCards'
+      @_hash['temporary_block_by_customer'] = 'TemporaryBlockByCustomer'
+      @_hash['temporary_block_by_shell'] = 'TemporaryBlockByShell'
+      @_hash['total_cards'] = 'TotalCards'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        active_cards
+        blocked_cards
+        cancelled_cards
+        expired_cards
+        expiring_cards
+        fraud_cards
+        new_cards
+        renewal_pending_cards
+        replaced_cards
+        temporary_block_by_customer
+        temporary_block_by_shell
+        total_cards
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        active_cards
+        blocked_cards
+        cancelled_cards
+        expired_cards
+        expiring_cards
+        fraud_cards
+        new_cards
+        renewal_pending_cards
+        replaced_cards
+        temporary_block_by_customer
+        temporary_block_by_shell
+        total_cards
+      ]
+    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,
+                   temporary_block_by_customer = 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
+      @expired_cards = expired_cards unless expired_cards == SKIP
+      @expiring_cards = expiring_cards unless expiring_cards == SKIP
+      @fraud_cards = fraud_cards unless fraud_cards == SKIP
+      @new_cards = new_cards unless new_cards == SKIP
+      @renewal_pending_cards = renewal_pending_cards unless renewal_pending_cards == SKIP
+      @replaced_cards = replaced_cards unless replaced_cards == SKIP
+      unless temporary_block_by_customer == SKIP
+        @temporary_block_by_customer =
+          temporary_block_by_customer
+      end
+      @temporary_block_by_shell = temporary_block_by_shell unless temporary_block_by_shell == SKIP
+      @total_cards = total_cards unless total_cards == 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.
+      active_cards = hash.key?('ActiveCards') ? hash['ActiveCards'] : SKIP
+      blocked_cards = hash.key?('BlockedCards') ? hash['BlockedCards'] : SKIP
+      cancelled_cards =
+        hash.key?('CancelledCards') ? hash['CancelledCards'] : SKIP
+      expired_cards = hash.key?('ExpiredCards') ? hash['ExpiredCards'] : SKIP
+      expiring_cards = hash.key?('ExpiringCards') ? hash['ExpiringCards'] : SKIP
+      fraud_cards = hash.key?('FraudCards') ? hash['FraudCards'] : SKIP
+      new_cards = hash.key?('NewCards') ? hash['NewCards'] : SKIP
+      renewal_pending_cards =
+        hash.key?('RenewalPendingCards') ? hash['RenewalPendingCards'] : SKIP
+      replaced_cards = hash.key?('ReplacedCards') ? hash['ReplacedCards'] : SKIP
+      temporary_block_by_customer =
+        hash.key?('TemporaryBlockByCustomer') ? hash['TemporaryBlockByCustomer'] : SKIP
+      temporary_block_by_shell =
+        hash.key?('TemporaryBlockByShell') ? hash['TemporaryBlockByShell'] : SKIP
+      total_cards = hash.key?('TotalCards') ? hash['TotalCards'] : SKIP
+
+      # Create object from extracted values.
+      SummaryResponse.new(active_cards,
+                          blocked_cards,
+                          cancelled_cards,
+                          expired_cards,
+                          expiring_cards,
+                          fraud_cards,
+                          new_cards,
+                          renewal_pending_cards,
+                          replaced_cards,
+                          temporary_block_by_customer,
+                          temporary_block_by_shell,
+                          total_cards)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/summaryof_bundle.rb

@@ -0,0 +1,126 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # SummaryofBundle Model.
+  class SummaryofBundle < 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
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Collecting Company Code (Shell Code) of the selected payer. 
+    # Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia,
+    # Ukraine etc. It is optional for other countries if ColCoID is provided.
+    # Example:
+    # 86 for Philippines
+    # 5 for UK
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer Number of the selected payer.
+    # Either PayerId or PayerNumber or both must be passed.
+    # 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.
+    # 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 card bundle in Gateway.
+    # Mandatory
+    # @return [Array[String]]
+    attr_accessor :bundle_id
+
+    # 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_number'] = 'PayerNumber'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['bundle_id'] = 'BundleId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_number
+        payer_id
+        account_id
+        account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    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)
+      @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
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @bundle_id = bundle_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      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
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+
+      # Create object from extracted values.
+      SummaryofBundle.new(bundle_id,
+                          col_co_id,
+                          col_co_code,
+                          payer_number,
+                          payer_id,
+                          account_id,
+                          account_number)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/update_bundle_request.rb

@@ -0,0 +1,194 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # UpdateBundleRequest Model.
+  class UpdateBundleRequest < 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
+
+    # 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.
+    # Example: 123456
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Identifier of the bundle in Gateway.
+    # Mandatory
+    # @return [String]
+    attr_accessor :bundle_id
+
+    # The value indicates the action to be performed with the request.
+    # Mandatory
+    # Allowed values:
+    # •	Add
+    # •	Update
+    # •	Remove
+    # @return [String]
+    attr_accessor :request_action
+
+    # List of Card PANs to be added in the bundle.
+    # 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
+    # @return [Array[String]]
+    attr_accessor :cards
+
+    # The value indicates what actions to be performed with respect to usage
+    # 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 [String]
+    attr_accessor :usage_restriction_action
+
+    # The value indicates what actions to be performed with respect to usage
+    # 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]
+    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['payer_id'] = 'PayerId'
+      @_hash['account_id'] = 'AccountId'
+      @_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
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        payer_id
+        account_id
+        cards
+        usage_restriction_action
+        restrictions
+        col_co_code
+        payer_number
+        account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        col_co_id
+        payer_id
+        account_id
+        request_action
+        col_co_code
+        payer_number
+        account_number
+      ]
+    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)
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @account_id = account_id unless account_id == 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
+      @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.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # 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
+      usage_restriction_action =
+        hash.key?('UsageRestrictionAction') ? hash['UsageRestrictionAction'] : SKIP
+      restrictions = BundleRestriction.from_hash(hash['Restrictions']) if hash['Restrictions']
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+
+      # 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_code,
+                              payer_number,
+                              account_number)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/update_bundle_response.rb

@@ -0,0 +1,70 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # UpdateBundleResponse Model.
+  class UpdateBundleResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # API Request Id
+    # @return [String]
+    attr_accessor :request_id
+
+    # API Response Status
+    # @return [String]
+    attr_accessor :status
+
+    # API Response Status
+    # @return [ErrorDetails]
+    attr_accessor :errors
+
+    # 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['errors'] = 'Errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        status
+        errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   status = SKIP,
+                   errors = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @status = status unless status == SKIP
+      @errors = errors unless errors == 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
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      errors = ErrorDetails.from_hash(hash['Errors']) if hash['Errors']
+
+      # Create object from extracted values.
+      UpdateBundleResponse.new(request_id,
+                               status,
+                               errors)
+    end
+  end
+end