card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/delete_bundle_request.rb

@@ -0,0 +1,126 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # DeleteBundleRequest Model.
+  class DeleteBundleRequest < 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 [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.
+      DeleteBundleRequest.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/delete_bundle_response.rb

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

data/lib/shell_card_management_ap_is/models/delivery_address_update.rb

@@ -0,0 +1,112 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # List of cards for delivery address update. Maximum number of cards that can
+  # be provided in the list is 50
+  class DeliveryAddressUpdate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Card Id of the card.
+    # Optional if  PAN is passed, else Mandatory.
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # PAN of the card.
+    # Optional if CardId is passed, else Mandatory. 
+    # Note: -
+    # PAN & ExpiryDate parameters will be considered only if CardId & PANID are
+    # not provided.
+    # @return [String]
+    attr_accessor :pan
+
+    # Expiry date of the card.
+    # Mandatory if PAN is passed, else optional.
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :card_expiry_date
+
+    # Whether to use the default delivery address configured at customer (or
+    # card group) level as the delivery address for this card.
+    # Mandatory
+    # Note: If value is false then ‘UpdateCardRenewalAddress’ is mandatory. If
+    # value set to ‘True’ then
+    # ‘UpdateCardRenewalAddress’ may be null/empty. It will be ignored if
+    # provided.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_customer_default_address
+
+    # Delivery address of card. This address will be used for card reissue and
+    # PIN reminders in future.
+    # Note: Mandatory when ‘UseCustomerDefaultAddress’ is set to ‘false’. The
+    # field is ignored otherwise.
+    # @return [UpdateCardRenewalAddress]
+    attr_accessor :update_card_renewal_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_id'] = 'CardId'
+      @_hash['pan'] = 'PAN'
+      @_hash['card_expiry_date'] = 'CardExpiryDate'
+      @_hash['use_customer_default_address'] = 'UseCustomerDefaultAddress'
+      @_hash['update_card_renewal_address'] = 'UpdateCardRenewalAddress'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_id
+        pan
+        card_expiry_date
+        update_card_renewal_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(use_customer_default_address = false,
+                   card_id = SKIP,
+                   pan = SKIP,
+                   card_expiry_date = SKIP,
+                   update_card_renewal_address = SKIP)
+      @card_id = card_id unless card_id == SKIP
+      @pan = pan unless pan == SKIP
+      @card_expiry_date = card_expiry_date unless card_expiry_date == SKIP
+      @use_customer_default_address = use_customer_default_address
+      unless update_card_renewal_address == SKIP
+        @update_card_renewal_address =
+          update_card_renewal_address
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      use_customer_default_address = hash['UseCustomerDefaultAddress'] ||= false
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      card_expiry_date =
+        hash.key?('CardExpiryDate') ? hash['CardExpiryDate'] : SKIP
+      if hash['UpdateCardRenewalAddress']
+        update_card_renewal_address = UpdateCardRenewalAddress.from_hash(hash['UpdateCardRenewalAddress'])
+      end
+
+      # Create object from extracted values.
+      DeliveryAddressUpdate.new(use_customer_default_address,
+                                card_id,
+                                pan,
+                                card_expiry_date,
+                                update_card_renewal_address)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/delivery_address_update_references.rb

@@ -0,0 +1,102 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # List of Delivery address update entity. The fields of this entity are
+  # described below.
+  class DeliveryAddressUpdateReferences < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # CardId
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # PAN of the card.
+    # @return [String]
+    attr_accessor :card_pan
+
+    # AccountId
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Individual delivery address update reference number for the delivery
+    # address update request.
+    # @return [Integer]
+    attr_accessor :reference_id
+
+    # Individual error information for the delivery address update request.
+    # @return [String]
+    attr_accessor :error_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_id'] = 'CardId'
+      @_hash['card_pan'] = 'CardPAN'
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['reference_id'] = 'ReferenceId'
+      @_hash['error_info'] = 'ErrorInfo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_id
+        card_pan
+        account_id
+        account_number
+        reference_id
+        error_info
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_id = SKIP,
+                   card_pan = SKIP,
+                   account_id = SKIP,
+                   account_number = SKIP,
+                   reference_id = SKIP,
+                   error_info = SKIP)
+      @card_id = card_id unless card_id == SKIP
+      @card_pan = card_pan unless card_pan == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @reference_id = reference_id unless reference_id == SKIP
+      @error_info = error_info unless error_info == 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.
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      card_pan = hash.key?('CardPAN') ? hash['CardPAN'] : SKIP
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      reference_id = hash.key?('ReferenceId') ? hash['ReferenceId'] : SKIP
+      error_info = hash.key?('ErrorInfo') ? hash['ErrorInfo'] : SKIP
+
+      # Create object from extracted values.
+      DeliveryAddressUpdateReferences.new(card_id,
+                                          card_pan,
+                                          account_id,
+                                          account_number,
+                                          reference_id,
+                                          error_info)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/delivery_address_update_request.rb

@@ -0,0 +1,129 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # DeliveryAddressUpdateRequest Model.
+  class DeliveryAddressUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Collecting Company Id of the selected payer. 
+    # Optional if ColCoCode is passed else Mandatory.
+    # @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.
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Payer Id (i.e. Customer Id of the Payment Customer) of the selected payer.
+    # Optional if PayerNumber is passed else Mandatory
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number (Ex: GB000000123) of the selected payer.
+    # Optional if PayerId is passed else Mandatory
+    # @return [String]
+    attr_accessor :payer_number
+
+    # Account ID of the customer.
+    # Optional if AccountNumber is passed, else mandatory.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.
+    # Optional if AccountId is passed, else mandatory.
+    # This input is a search criterion, if given.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account Number of the customer.
+    # Optional if AccountId is passed, else mandatory.
+    # This input is a search criterion, if given.
+    # @return [Array[DeliveryAddressUpdate]]
+    attr_accessor :delivery_address_updates
+
+    # 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['delivery_address_updates'] = 'DeliveryAddressUpdates'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        col_co_id
+        col_co_code
+        payer_id
+        payer_number
+        account_id
+        account_number
+        delivery_address_updates
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(col_co_id = SKIP,
+                   col_co_code = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   account_id = SKIP,
+                   account_number = SKIP,
+                   delivery_address_updates = 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
+      @delivery_address_updates = delivery_address_updates unless delivery_address_updates == 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.
+      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
+      # Parameter is an array, so we need to iterate through it
+      delivery_address_updates = nil
+      unless hash['DeliveryAddressUpdates'].nil?
+        delivery_address_updates = []
+        hash['DeliveryAddressUpdates'].each do |structure|
+          delivery_address_updates << (DeliveryAddressUpdate.from_hash(structure) if structure)
+        end
+      end
+
+      delivery_address_updates = SKIP unless hash.key?('DeliveryAddressUpdates')
+
+      # Create object from extracted values.
+      DeliveryAddressUpdateRequest.new(col_co_id,
+                                       col_co_code,
+                                       payer_id,
+                                       payer_number,
+                                       account_id,
+                                       account_number,
+                                       delivery_address_updates)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/delivery_address_update_response.rb

@@ -0,0 +1,94 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # DeliveryAddressUpdateResponse Model.
+  class DeliveryAddressUpdateResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Request ID to which was passed on the API request.
+    # @return [String]
+    attr_accessor :request_id
+
+    # Service reference number for tracking.
+    # @return [Integer]
+    attr_accessor :service_reference
+
+    # Service reference number for tracking.
+    # @return [Array[DeliveryAddressUpdateReferences]]
+    attr_accessor :delivery_address_update_references
+
+    # Service reference number for tracking.
+    # @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['service_reference'] = 'ServiceReference'
+      @_hash['delivery_address_update_references'] =
+        'DeliveryAddressUpdateReferences'
+      @_hash['error'] = 'Error'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        service_reference
+        delivery_address_update_references
+        error
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   service_reference = SKIP,
+                   delivery_address_update_references = SKIP,
+                   error = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @service_reference = service_reference unless service_reference == SKIP
+      unless delivery_address_update_references == SKIP
+        @delivery_address_update_references =
+          delivery_address_update_references
+      end
+      @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
+      service_reference =
+        hash.key?('ServiceReference') ? hash['ServiceReference'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      delivery_address_update_references = nil
+      unless hash['DeliveryAddressUpdateReferences'].nil?
+        delivery_address_update_references = []
+        hash['DeliveryAddressUpdateReferences'].each do |structure|
+          delivery_address_update_references << (DeliveryAddressUpdateReferences.from_hash(structure) if structure)
+        end
+      end
+
+      delivery_address_update_references = SKIP unless hash.key?('DeliveryAddressUpdateReferences')
+      error = ErrorStatus.from_hash(hash['Error']) if hash['Error']
+
+      # Create object from extracted values.
+      DeliveryAddressUpdateResponse.new(request_id,
+                                        service_reference,
+                                        delivery_address_update_references,
+                                        error)
+    end
+  end
+end