card-management-sdk 1.0.0

data/lib/shell_card_management_ap_is/models/pin_delivery_details.rb

@@ -0,0 +1,169 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # PINDeliverDetails entity. The fields of this entity are described below.
+  # This is mandatory if PINContactType is 4 else optional and ignored.
+  class PINDeliveryDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contact Name
+    # Max Length: 50
+    # @return [String]
+    attr_accessor :contact_name
+
+    # Contact Title
+    # Max Length: 50
+    # @return [String]
+    attr_accessor :contact_title
+
+    # Company Name for PIN delivery.
+    # Max Length: 50
+    # @return [String]
+    attr_accessor :company_name
+
+    # Address Lines
+    # Max Length: 1024
+    # @return [String]
+    attr_accessor :address_line
+
+    # Zip Code
+    # Max Length: 10
+    # @return [String]
+    attr_accessor :zip_code
+
+    # City
+    # Max Length: 40
+    # @return [String]
+    attr_accessor :city
+
+    # Region
+    # @return [Integer]
+    attr_accessor :region_id
+
+    # Country
+    # @return [Integer]
+    attr_accessor :country_id
+
+    # Cardholder phone number for PIN delivery.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # Cardholder email address for PIN delivery
+    # Max Length : 90
+    # Example: xxxxxx@example.com <br/>Note:Based on the international standard
+    # that there can be Max Length 64 before the @ (the 'Local part’)
+    # =64(minimum of 1) Max Lenth after the (the domain) = 88 (Minimum of 2)
+    # @return [String]
+    attr_accessor :email_address
+
+    # Save PIN Reminder
+    # If SavePINReminder is true, the contact address will be saved database for
+    # PIN reminder.
+    #  <br/>Only allowed for PIN Advice paper delivery.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :save_pin_reminder
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact_name'] = 'ContactName'
+      @_hash['contact_title'] = 'ContactTitle'
+      @_hash['company_name'] = 'CompanyName'
+      @_hash['address_line'] = 'AddressLine'
+      @_hash['zip_code'] = 'ZipCode'
+      @_hash['city'] = 'City'
+      @_hash['region_id'] = 'RegionID'
+      @_hash['country_id'] = 'CountryID'
+      @_hash['phone_number'] = 'PhoneNumber'
+      @_hash['email_address'] = 'EmailAddress'
+      @_hash['save_pin_reminder'] = 'SavePINReminder'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact_name
+        contact_title
+        region_id
+        country_id
+        phone_number
+        email_address
+        save_pin_reminder
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        contact_name
+        contact_title
+        zip_code
+        region_id
+        country_id
+        phone_number
+        email_address
+      ]
+    end
+
+    def initialize(company_name = nil,
+                   address_line = nil,
+                   zip_code = nil,
+                   city = nil,
+                   contact_name = SKIP,
+                   contact_title = SKIP,
+                   region_id = SKIP,
+                   country_id = SKIP,
+                   phone_number = SKIP,
+                   email_address = SKIP,
+                   save_pin_reminder = SKIP)
+      @contact_name = contact_name unless contact_name == SKIP
+      @contact_title = contact_title unless contact_title == SKIP
+      @company_name = company_name
+      @address_line = address_line
+      @zip_code = zip_code
+      @city = city
+      @region_id = region_id unless region_id == SKIP
+      @country_id = country_id unless country_id == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @save_pin_reminder = save_pin_reminder unless save_pin_reminder == 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.
+      company_name = hash.key?('CompanyName') ? hash['CompanyName'] : nil
+      address_line = hash.key?('AddressLine') ? hash['AddressLine'] : nil
+      zip_code = hash.key?('ZipCode') ? hash['ZipCode'] : nil
+      city = hash.key?('City') ? hash['City'] : nil
+      contact_name = hash.key?('ContactName') ? hash['ContactName'] : SKIP
+      contact_title = hash.key?('ContactTitle') ? hash['ContactTitle'] : SKIP
+      region_id = hash.key?('RegionID') ? hash['RegionID'] : SKIP
+      country_id = hash.key?('CountryID') ? hash['CountryID'] : SKIP
+      phone_number = hash.key?('PhoneNumber') ? hash['PhoneNumber'] : SKIP
+      email_address = hash.key?('EmailAddress') ? hash['EmailAddress'] : SKIP
+      save_pin_reminder =
+        hash.key?('SavePINReminder') ? hash['SavePINReminder'] : SKIP
+
+      # Create object from extracted values.
+      PINDeliveryDetails.new(company_name,
+                             address_line,
+                             zip_code,
+                             city,
+                             contact_name,
+                             contact_title,
+                             region_id,
+                             country_id,
+                             phone_number,
+                             email_address,
+                             save_pin_reminder)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/pin_reminder_card_details.rb

@@ -0,0 +1,137 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # Request entity object for PINReminderCardDetails
+  class PINReminderCardDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Card Id 
+    # Optional if Either PANID AND CardExpiryDate or PAN AND CardExpiryDate is
+    # passed, else Mandatory. Example: 275549 .<br/>Note:PANID, PAN & ExpiryDate
+    # parameters will be ignored if CardId is provided.
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # PAN ID - Unique PAN ID 
+    # Optional if Either CardId or PAN AND  ExpiryDate is passed, else
+    # Mandatory. Example: 123456. <br/>Note:PANID parameter will be considered
+    # only if CardId is not provided
+    # @return [Integer]
+    attr_accessor :panid
+
+    # PAN of the card.
+    # Optional if Either CardId or PANID is passed, else Mandatory.
+    # <br/>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 Either PAN or PANID is passed, else optional.
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :card_expiry_date
+
+    # PIN delivery method.
+    # Mandatory
+    # Allowed Values:
+    #    1.	Paper
+    #    2.	Email
+    #    3.	SMS
+    # @return [Integer]
+    attr_accessor :pin_advice_type
+
+    # PIN Contact Type.
+    # Mandatory
+    # Allowed Values:
+    # 1.	Use PIN Delivery contact details stored previously for this card
+    # 2.	Use Card Delivery contact details stored previously for this card
+    # 3.	Use default PIN Delivery contact details stored for this customer
+    # 4.	Use new specific contact for PIN Reminder only
+    # Note: - PINContactType “3” is only allowed for Paper delivery
+    # @return [Integer]
+    attr_accessor :pin_contact_type
+
+    # PINDeliverDetails entity. The fields of this entity are described below.
+    # This is mandatory if PINContactType is 4 else optional and ignored.
+    # @return [PINDeliveryDetails]
+    attr_accessor :pin_deliver_to
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_id'] = 'CardId'
+      @_hash['panid'] = 'PANID'
+      @_hash['pan'] = 'PAN'
+      @_hash['card_expiry_date'] = 'CardExpiryDate'
+      @_hash['pin_advice_type'] = 'PINAdviceType'
+      @_hash['pin_contact_type'] = 'PINContactType'
+      @_hash['pin_deliver_to'] = 'PINDeliverTo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_id
+        panid
+        pan
+        card_expiry_date
+        pin_contact_type
+        pin_deliver_to
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        card_expiry_date
+      ]
+    end
+
+    def initialize(pin_advice_type = nil,
+                   card_id = SKIP,
+                   panid = SKIP,
+                   pan = SKIP,
+                   card_expiry_date = SKIP,
+                   pin_contact_type = SKIP,
+                   pin_deliver_to = SKIP)
+      @card_id = card_id unless card_id == SKIP
+      @panid = panid unless panid == SKIP
+      @pan = pan unless pan == SKIP
+      @card_expiry_date = card_expiry_date unless card_expiry_date == SKIP
+      @pin_advice_type = pin_advice_type
+      @pin_contact_type = pin_contact_type unless pin_contact_type == SKIP
+      @pin_deliver_to = pin_deliver_to unless pin_deliver_to == 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.
+      pin_advice_type = hash.key?('PINAdviceType') ? hash['PINAdviceType'] : nil
+      card_id = hash.key?('CardId') ? hash['CardId'] : SKIP
+      panid = hash.key?('PANID') ? hash['PANID'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      card_expiry_date =
+        hash.key?('CardExpiryDate') ? hash['CardExpiryDate'] : SKIP
+      pin_contact_type =
+        hash.key?('PINContactType') ? hash['PINContactType'] : SKIP
+      pin_deliver_to = PINDeliveryDetails.from_hash(hash['PINDeliverTo']) if hash['PINDeliverTo']
+
+      # Create object from extracted values.
+      PINReminderCardDetails.new(pin_advice_type,
+                                 card_id,
+                                 panid,
+                                 pan,
+                                 card_expiry_date,
+                                 pin_contact_type,
+                                 pin_deliver_to)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/pin_reminder_reference.rb

@@ -0,0 +1,99 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # This class holds the PIN Reminder References
+  class PINReminderReference < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Card Id
+    # @return [Integer]
+    attr_accessor :card_id
+
+    # PAN ID
+    # @return [Integer]
+    attr_accessor :panid
+
+    # PAN
+    # @return [Integer]
+    attr_accessor :pan
+
+    # Expiry date of the card.
+    # Mandatory if Either PAN or PANID is passed, else optional.
+    # Format: yyyyMMdd
+    # @return [String]
+    attr_accessor :card_expiry_date
+
+    # Individual card pin reminder reference number for the Pin Reminder
+    # request.
+    # @return [Integer]
+    attr_accessor :reference_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_id'] = 'CardId'
+      @_hash['panid'] = 'PANID'
+      @_hash['pan'] = 'PAN'
+      @_hash['card_expiry_date'] = 'CardExpiryDate'
+      @_hash['reference_id'] = 'ReferenceId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_id
+        panid
+        pan
+        card_expiry_date
+        reference_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        card_id
+        panid
+        pan
+        card_expiry_date
+      ]
+    end
+
+    def initialize(card_id = SKIP,
+                   panid = SKIP,
+                   pan = SKIP,
+                   card_expiry_date = SKIP,
+                   reference_id = SKIP)
+      @card_id = card_id unless card_id == SKIP
+      @panid = panid unless panid == SKIP
+      @pan = pan unless pan == SKIP
+      @card_expiry_date = card_expiry_date unless card_expiry_date == SKIP
+      @reference_id = reference_id unless reference_id == 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
+      panid = hash.key?('PANID') ? hash['PANID'] : SKIP
+      pan = hash.key?('PAN') ? hash['PAN'] : SKIP
+      card_expiry_date =
+        hash.key?('CardExpiryDate') ? hash['CardExpiryDate'] : SKIP
+      reference_id = hash.key?('ReferenceId') ? hash['ReferenceId'] : SKIP
+
+      # Create object from extracted values.
+      PINReminderReference.new(card_id,
+                               panid,
+                               pan,
+                               card_expiry_date,
+                               reference_id)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/pin_reminder_request.rb

@@ -0,0 +1,135 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # This entity models the data that is received in the https request body of
+  # the PINReminder operation.
+  class PINReminderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account Id of the customer.<br />
+    # Optional if AccountNumber is passed, else Mandatory.<br />
+    # This input is a search criterion, if given.
+    # @return [Integer]
+    attr_accessor :account_id
+
+    # Account Number of the customer.<br />
+    # Optional if AccountId is passed, else Mandatory.<br />
+    # This input is a search criterion, if given.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Collecting Company Code (Shell Code) of the selected payer. <br />
+    # Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia,
+    # Ukraine etc. <br />
+    # It is optional for other countries if ColCoID is provided.
+    # @return [Integer]
+    attr_accessor :col_co_code
+
+    # Collecting Company Id of the selected payer<br />
+    # Optional if ColCoCode is passed else Mandatory.
+    # @return [Integer]
+    attr_accessor :col_co_id
+
+    # Payer Id (i.e. Customer Id of the Payment Customer of the selected
+    # payer.<br />
+    # Optional if PayerNumber is passed else Mandatory
+    # @return [Integer]
+    attr_accessor :payer_id
+
+    # Payer Number (Ex: GB000000123) of the selected payer.<br />
+    # Optional if PayerId is passed else Mandatory
+    # @return [String]
+    attr_accessor :payer_number
+
+    # List of PINReminderCardDetails entity. The fields of this entity are
+    # described below.
+    # @return [Array[PINReminderCardDetails]]
+    attr_accessor :pin_reminder_card_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountId'
+      @_hash['account_number'] = 'AccountNumber'
+      @_hash['col_co_code'] = 'ColCoCode'
+      @_hash['col_co_id'] = 'ColCoId'
+      @_hash['payer_id'] = 'PayerId'
+      @_hash['payer_number'] = 'PayerNumber'
+      @_hash['pin_reminder_card_details'] = 'PINReminderCardDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        account_number
+        col_co_code
+        col_co_id
+        payer_id
+        payer_number
+        pin_reminder_card_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = SKIP,
+                   account_number = SKIP,
+                   col_co_code = SKIP,
+                   col_co_id = SKIP,
+                   payer_id = SKIP,
+                   payer_number = SKIP,
+                   pin_reminder_card_details = 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
+      @col_co_id = col_co_id unless col_co_id == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payer_number = payer_number unless payer_number == SKIP
+      unless pin_reminder_card_details == SKIP
+        @pin_reminder_card_details =
+          pin_reminder_card_details
+      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.
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : SKIP
+      account_number = hash.key?('AccountNumber') ? hash['AccountNumber'] : SKIP
+      col_co_code = hash.key?('ColCoCode') ? hash['ColCoCode'] : SKIP
+      col_co_id = hash.key?('ColCoId') ? hash['ColCoId'] : SKIP
+      payer_id = hash.key?('PayerId') ? hash['PayerId'] : SKIP
+      payer_number = hash.key?('PayerNumber') ? hash['PayerNumber'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      pin_reminder_card_details = nil
+      unless hash['PINReminderCardDetails'].nil?
+        pin_reminder_card_details = []
+        hash['PINReminderCardDetails'].each do |structure|
+          pin_reminder_card_details << (PINReminderCardDetails.from_hash(structure) if structure)
+        end
+      end
+
+      pin_reminder_card_details = SKIP unless hash.key?('PINReminderCardDetails')
+
+      # Create object from extracted values.
+      PINReminderRequest.new(account_id,
+                             account_number,
+                             col_co_code,
+                             col_co_id,
+                             payer_id,
+                             payer_number,
+                             pin_reminder_card_details)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/pin_reminder_response.rb

@@ -0,0 +1,90 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # PINReminderResponse Model.
+  class PINReminderResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique request identifier passed from end user. This identifier helps in
+    # tracing a transaction
+    # @return [String]
+    attr_accessor :request_id
+
+    # Service reference number for tracking.
+    # @return [Integer]
+    attr_accessor :main_reference
+
+    # Indicates overall status of the request. Allowed values: SUCCESS, FAILED
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates overall status of the request. Allowed values: SUCCESS, FAILED
+    # @return [Array[PINReminderReference]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'RequestId'
+      @_hash['main_reference'] = 'MainReference'
+      @_hash['status'] = 'Status'
+      @_hash['data'] = 'Data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+        main_reference
+        status
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP,
+                   main_reference = SKIP,
+                   status = SKIP,
+                   data = SKIP)
+      @request_id = request_id unless request_id == SKIP
+      @main_reference = main_reference unless main_reference == SKIP
+      @status = status unless status == SKIP
+      @data = data unless data == 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
+      main_reference = hash.key?('MainReference') ? hash['MainReference'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['Data'].nil?
+        data = []
+        hash['Data'].each do |structure|
+          data << (PINReminderReference.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('Data')
+
+      # Create object from extracted values.
+      PINReminderResponse.new(request_id,
+                              main_reference,
+                              status,
+                              data)
+    end
+  end
+end

data/lib/shell_card_management_ap_is/models/product_all_of0.rb

@@ -0,0 +1,62 @@
+# shell_card_management_ap_is
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ShellCardManagementApIs
+  # ProductAllOf0 Model.
+  class ProductAllOf0 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The productCode returned by the Gateway API.
+    # Example: 021
+    # @return [String]
+    attr_accessor :global_product_code
+
+    # The description returned by the Gateway API.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['global_product_code'] = 'GlobalProductCode'
+      @_hash['description'] = 'Description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        global_product_code
+        description
+      ]
+    end
+
+    def initialize(global_product_code = nil,
+                   description = nil)
+      @global_product_code = global_product_code
+      @description = description
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      global_product_code =
+        hash.key?('GlobalProductCode') ? hash['GlobalProductCode'] : nil
+      description = hash.key?('Description') ? hash['Description'] : nil
+
+      # Create object from extracted values.
+      ProductAllOf0.new(global_product_code,
+                        description)
+    end
+  end
+end