pnz-payments-sdk 1.0.0

data/lib/account_and_transaction_api_specification/models/account_response.rb

@@ -0,0 +1,76 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # AccountResponse Model.
+  class AccountResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AccountResponseData]
+    attr_accessor :data
+
+    # Links relevant to the payload
+    # @return [Links]
+    attr_accessor :links
+
+    # Links relevant to the payload
+    # @return [Meta]
+    attr_accessor :meta
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'Data'
+      @_hash['links'] = 'Links'
+      @_hash['meta'] = 'Meta'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = nil, links = nil, meta = nil)
+      @data = data
+      @links = links
+      @meta = meta
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      data = AccountResponseData.from_hash(hash['Data']) if hash['Data']
+      links = Links.from_hash(hash['Links']) if hash['Links']
+      meta = Meta.from_hash(hash['Meta']) if hash['Meta']
+
+      # Create object from extracted values.
+      AccountResponse.new(data,
+                          links,
+                          meta)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}, links: #{@links}, meta: #{@meta}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}, links: #{@links.inspect}, meta: #{@meta.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/account_response_data.rb

@@ -0,0 +1,71 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # AccountResponseData Model.
+  class AccountResponseData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account
+    # @return [Array[AccountModel]]
+    attr_accessor :account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account'] = 'Account'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account = SKIP)
+      @account = account unless account == 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.
+      # Parameter is an array, so we need to iterate through it
+      account = nil
+      unless hash['Account'].nil?
+        account = []
+        hash['Account'].each do |structure|
+          account << (AccountModel.from_hash(structure) if structure)
+        end
+      end
+
+      account = SKIP unless hash.key?('Account')
+
+      # Create object from extracted values.
+      AccountResponseData.new(account)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account: #{@account}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account: #{@account.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/account_scheme_model_enum.rb

@@ -0,0 +1,23 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # AccountSchemeModel.
+  class AccountSchemeModelEnum
+    ACCOUNT_SCHEME_MODEL_ENUM = [
+      # TODO: Write general description for BECSELECTRONICCREDIT
+      BECSELECTRONICCREDIT = 'BECSElectronicCredit'.freeze,
+
+      # TODO: Write general description for MASKEDCARDNUMBER
+      MASKEDCARDNUMBER = 'MaskedCardNumber'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_SCHEME_MODEL_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/account_sub_type_enum.rb

@@ -0,0 +1,41 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Specifies the sub type of account (product family group).
+  class AccountSubTypeEnum
+    ACCOUNT_SUB_TYPE_ENUM = [
+      # TODO: Write general description for CHARGECARD
+      CHARGECARD = 'ChargeCard'.freeze,
+
+      # TODO: Write general description for CREDITCARD
+      CREDITCARD = 'CreditCard'.freeze,
+
+      # TODO: Write general description for CURRENTACCOUNT
+      CURRENTACCOUNT = 'CurrentAccount'.freeze,
+
+      # TODO: Write general description for EMONEY
+      EMONEY = 'EMoney'.freeze,
+
+      # TODO: Write general description for LOAN
+      LOAN = 'Loan'.freeze,
+
+      # TODO: Write general description for MORTGAGE
+      MORTGAGE = 'Mortgage'.freeze,
+
+      # TODO: Write general description for PREPAIDCARD
+      PREPAIDCARD = 'PrePaidCard'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'Savings'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_SUB_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/account_type_enum.rb

@@ -0,0 +1,23 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Specifies the type of account (personal or business).
+  class AccountTypeEnum
+    ACCOUNT_TYPE_ENUM = [
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'Business'.freeze,
+
+      # TODO: Write general description for PERSONAL
+      PERSONAL = 'Personal'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/address.rb

@@ -0,0 +1,137 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Postal address of a party.
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifies the nature of the postal address.
+    # @return [AddressTypeOptionEnum]
+    attr_accessor :address_type
+
+    # Information that locates and identifies a specific address, as defined by
+    # postal services, that is presented in free format text.
+    # @return [Array[String]]
+    attr_accessor :address_line
+
+    # Name of a street or thoroughfare.
+    # @return [String]
+    attr_accessor :street_name
+
+    # Number that identifies the position of a building on a street.
+    # @return [String]
+    attr_accessor :building_number
+
+    # Identifier consisting of a group of letters and/or numbers that is added
+    # to a postal address to assist the sorting of mail.
+    # @return [String]
+    attr_accessor :post_code
+
+    # Name of a built-up area, with defined boundaries, and a local government.
+    # @return [String]
+    attr_accessor :town_name
+
+    # Identifies a subdivision of a country eg, state, region, county.
+    # @return [String]
+    attr_accessor :country_sub_division
+
+    # Nation with its own government, occupying a particular territory.
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_type'] = 'AddressType'
+      @_hash['address_line'] = 'AddressLine'
+      @_hash['street_name'] = 'StreetName'
+      @_hash['building_number'] = 'BuildingNumber'
+      @_hash['post_code'] = 'PostCode'
+      @_hash['town_name'] = 'TownName'
+      @_hash['country_sub_division'] = 'CountrySubDivision'
+      @_hash['country'] = 'Country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_type
+        address_line
+        street_name
+        building_number
+        post_code
+        town_name
+        country_sub_division
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, address_type = SKIP, address_line = SKIP,
+                   street_name = SKIP, building_number = SKIP, post_code = SKIP,
+                   town_name = SKIP, country_sub_division = SKIP)
+      @address_type = address_type unless address_type == SKIP
+      @address_line = address_line unless address_line == SKIP
+      @street_name = street_name unless street_name == SKIP
+      @building_number = building_number unless building_number == SKIP
+      @post_code = post_code unless post_code == SKIP
+      @town_name = town_name unless town_name == SKIP
+      @country_sub_division = country_sub_division unless country_sub_division == SKIP
+      @country = country
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      country = hash.key?('Country') ? hash['Country'] : nil
+      address_type = hash.key?('AddressType') ? hash['AddressType'] : SKIP
+      address_line = hash.key?('AddressLine') ? hash['AddressLine'] : SKIP
+      street_name = hash.key?('StreetName') ? hash['StreetName'] : SKIP
+      building_number =
+        hash.key?('BuildingNumber') ? hash['BuildingNumber'] : SKIP
+      post_code = hash.key?('PostCode') ? hash['PostCode'] : SKIP
+      town_name = hash.key?('TownName') ? hash['TownName'] : SKIP
+      country_sub_division =
+        hash.key?('CountrySubDivision') ? hash['CountrySubDivision'] : SKIP
+
+      # Create object from extracted values.
+      Address.new(country,
+                  address_type,
+                  address_line,
+                  street_name,
+                  building_number,
+                  post_code,
+                  town_name,
+                  country_sub_division)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address_type: #{@address_type}, address_line: #{@address_line},"\
+      " street_name: #{@street_name}, building_number: #{@building_number}, post_code:"\
+      " #{@post_code}, town_name: #{@town_name}, country_sub_division: #{@country_sub_division},"\
+      " country: #{@country}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address_type: #{@address_type.inspect}, address_line:"\
+      " #{@address_line.inspect}, street_name: #{@street_name.inspect}, building_number:"\
+      " #{@building_number.inspect}, post_code: #{@post_code.inspect}, town_name:"\
+      " #{@town_name.inspect}, country_sub_division: #{@country_sub_division.inspect}, country:"\
+      " #{@country.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/address_type_enum.rb

@@ -0,0 +1,20 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Identifies the nature of the postal address.
+  class AddressTypeEnum
+    ADDRESS_TYPE_ENUM = [
+      # TODO: Write general description for DELIVERYTO
+      DELIVERYTO = 'DeliveryTo'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ADDRESS_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/address_type_option_enum.rb

@@ -0,0 +1,41 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Identifies the nature of the postal address.
+  class AddressTypeOptionEnum
+    ADDRESS_TYPE_OPTION_ENUM = [
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'Business'.freeze,
+
+      # TODO: Write general description for CORRESPONDENCE
+      CORRESPONDENCE = 'Correspondence'.freeze,
+
+      # TODO: Write general description for DELIVERYTO
+      DELIVERYTO = 'DeliveryTo'.freeze,
+
+      # TODO: Write general description for MAILTO
+      MAILTO = 'MailTo'.freeze,
+
+      # TODO: Write general description for POBOX
+      POBOX = 'POBox'.freeze,
+
+      # TODO: Write general description for POSTAL
+      POSTAL = 'Postal'.freeze,
+
+      # TODO: Write general description for RESIDENTIAL
+      RESIDENTIAL = 'Residential'.freeze,
+
+      # TODO: Write general description for STATEMENT
+      STATEMENT = 'Statement'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ADDRESS_TYPE_OPTION_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/amount.rb

@@ -0,0 +1,71 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Amount of money of the cash balance.
+  class Amount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount
+
+    # A code allocated to a currency by a Maintenance Agency under an
+    # international identification scheme, as described in the latest edition of
+    # the international standard ISO 4217 'Codes for the representation of
+    # currencies and funds'
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'Amount'
+      @_hash['currency'] = 'Currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, currency = nil)
+      @amount = amount
+      @currency = currency
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = hash.key?('Amount') ? hash['Amount'] : nil
+      currency = hash.key?('Currency') ? hash['Currency'] : nil
+
+      # Create object from extracted values.
+      Amount.new(amount,
+                 currency)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/authorisation_type_enum.rb

@@ -0,0 +1,26 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # The card authorisation type.
+  class AuthorisationTypeEnum
+    AUTHORISATION_TYPE_ENUM = [
+      # TODO: Write general description for CONTACTLESS
+      CONTACTLESS = 'Contactless'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'None'.freeze,
+
+      # TODO: Write general description for PIN
+      PIN = 'PIN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AUTHORISATION_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/balance.rb

@@ -0,0 +1,82 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Set of elements used to define the balance as a numerical representation of
+  # the net increases and decreases in an account after a transaction entry is
+  # applied to the account.
+  class Balance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of money of the cash balance.
+    # @return [Amount]
+    attr_accessor :amount
+
+    # Indicates whether the balance is a credit or a debit balance. Usage: A
+    # zero balance is considered to be a credit balance.
+    # @return [CreditDebitIndicatorEnum]
+    attr_accessor :credit_debit_indicator
+
+    # Balance type, in a coded form.
+    # @return [BalanceModelTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'Amount'
+      @_hash['credit_debit_indicator'] = 'CreditDebitIndicator'
+      @_hash['type'] = 'Type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, credit_debit_indicator = nil, type = nil)
+      @amount = amount
+      @credit_debit_indicator = credit_debit_indicator
+      @type = type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = Amount.from_hash(hash['Amount']) if hash['Amount']
+      credit_debit_indicator =
+        hash.key?('CreditDebitIndicator') ? hash['CreditDebitIndicator'] : nil
+      type = hash.key?('Type') ? hash['Type'] : nil
+
+      # Create object from extracted values.
+      Balance.new(amount,
+                  credit_debit_indicator,
+                  type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, credit_debit_indicator: #{@credit_debit_indicator},"\
+      " type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, credit_debit_indicator:"\
+      " #{@credit_debit_indicator.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end