pnz-payments-sdk 1.0.0

data/lib/account_and_transaction_api_specification/models/beneficiaries_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
+  # BeneficiariesResponseData Model.
+  class BeneficiariesResponseData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Beneficiary
+    # @return [Array[BeneficiaryModel]]
+    attr_accessor :beneficiary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['beneficiary'] = 'Beneficiary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        beneficiary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(beneficiary = SKIP)
+      @beneficiary = beneficiary unless beneficiary == 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
+      beneficiary = nil
+      unless hash['Beneficiary'].nil?
+        beneficiary = []
+        hash['Beneficiary'].each do |structure|
+          beneficiary << (BeneficiaryModel.from_hash(structure) if structure)
+        end
+      end
+
+      beneficiary = SKIP unless hash.key?('Beneficiary')
+
+      # Create object from extracted values.
+      BeneficiariesResponseData.new(beneficiary)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} beneficiary: #{@beneficiary}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} beneficiary: #{@beneficiary.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/beneficiary_model.rb

@@ -0,0 +1,110 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # BeneficiaryModel Model.
+  class BeneficiaryModel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique and immutable identifier used to identify the account resource.
+    # This identifier has no meaning to the account owner.
+    # @return [String]
+    attr_accessor :account_id
+
+    # A unique and immutable identifier used to identify the beneficiary
+    # resource. This identifier has no meaning to the account owner.
+    # @return [String]
+    attr_accessor :beneficiary_id
+
+    # A unique and immutable identifier used to identify the beneficiary
+    # resource. This identifier has no meaning to the account owner.
+    # @return [Reference]
+    attr_accessor :reference
+
+    # Party that manages the account on behalf of the account owner, that is
+    # manages the registration and booking of entries on the account, calculates
+    # balances on the account and provides information about the account.
+    # This is the servicer of the beneficiary account.
+    # @return [CreditorAgent]
+    attr_accessor :creditor_agent
+
+    # Unambiguous identification of the account of the creditor, in the case of
+    # a debit transaction.
+    # @return [CreditorAccount]
+    attr_accessor :creditor_account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountId'
+      @_hash['beneficiary_id'] = 'BeneficiaryId'
+      @_hash['reference'] = 'Reference'
+      @_hash['creditor_agent'] = 'CreditorAgent'
+      @_hash['creditor_account'] = 'CreditorAccount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        beneficiary_id
+        reference
+        creditor_agent
+        creditor_account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = nil, beneficiary_id = SKIP, reference = SKIP,
+                   creditor_agent = SKIP, creditor_account = SKIP)
+      @account_id = account_id
+      @beneficiary_id = beneficiary_id unless beneficiary_id == SKIP
+      @reference = reference unless reference == SKIP
+      @creditor_agent = creditor_agent unless creditor_agent == SKIP
+      @creditor_account = creditor_account unless creditor_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.
+      account_id = hash.key?('AccountId') ? hash['AccountId'] : nil
+      beneficiary_id = hash.key?('BeneficiaryId') ? hash['BeneficiaryId'] : SKIP
+      reference = Reference.from_hash(hash['Reference']) if hash['Reference']
+      creditor_agent = CreditorAgent.from_hash(hash['CreditorAgent']) if hash['CreditorAgent']
+      creditor_account = CreditorAccount.from_hash(hash['CreditorAccount']) if
+        hash['CreditorAccount']
+
+      # Create object from extracted values.
+      BeneficiaryModel.new(account_id,
+                           beneficiary_id,
+                           reference,
+                           creditor_agent,
+                           creditor_account)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id}, beneficiary_id: #{@beneficiary_id}, reference:"\
+      " #{@reference}, creditor_agent: #{@creditor_agent}, creditor_account:"\
+      " #{@creditor_account}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id.inspect}, beneficiary_id:"\
+      " #{@beneficiary_id.inspect}, reference: #{@reference.inspect}, creditor_agent:"\
+      " #{@creditor_agent.inspect}, creditor_account: #{@creditor_account.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/card_instrument.rb

@@ -0,0 +1,97 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Set of elements to describe the card instrument used in the transaction.
+  class CardInstrument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the card scheme.
+    # @return [CardSchemeNameEnum]
+    attr_accessor :card_scheme_name
+
+    # The card authorisation type.
+    # @return [AuthorisationTypeEnum]
+    attr_accessor :authorisation_type
+
+    # Name of the cardholder using the card instrument.
+    # @return [String]
+    attr_accessor :name
+
+    # Identification assigned by an institution to identify the card instrument
+    # used in the transaction. This identification is known by the account
+    # owner, and may be masked.
+    # @return [String]
+    attr_accessor :identification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_scheme_name'] = 'CardSchemeName'
+      @_hash['authorisation_type'] = 'AuthorisationType'
+      @_hash['name'] = 'Name'
+      @_hash['identification'] = 'Identification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        authorisation_type
+        name
+        identification
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_scheme_name = nil, authorisation_type = SKIP,
+                   name = SKIP, identification = SKIP)
+      @card_scheme_name = card_scheme_name
+      @authorisation_type = authorisation_type unless authorisation_type == SKIP
+      @name = name unless name == SKIP
+      @identification = identification unless identification == 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_scheme_name =
+        hash.key?('CardSchemeName') ? hash['CardSchemeName'] : nil
+      authorisation_type =
+        hash.key?('AuthorisationType') ? hash['AuthorisationType'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      identification =
+        hash.key?('Identification') ? hash['Identification'] : SKIP
+
+      # Create object from extracted values.
+      CardInstrument.new(card_scheme_name,
+                         authorisation_type,
+                         name,
+                         identification)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_scheme_name: #{@card_scheme_name}, authorisation_type:"\
+      " #{@authorisation_type}, name: #{@name}, identification: #{@identification}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_scheme_name: #{@card_scheme_name.inspect}, authorisation_type:"\
+      " #{@authorisation_type.inspect}, name: #{@name.inspect}, identification:"\
+      " #{@identification.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/card_scheme_name_enum.rb

@@ -0,0 +1,32 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Name of the card scheme.
+  class CardSchemeNameEnum
+    CARD_SCHEME_NAME_ENUM = [
+      # TODO: Write general description for AMERICANEXPRESS
+      AMERICANEXPRESS = 'AmericanExpress'.freeze,
+
+      # TODO: Write general description for DINERS
+      DINERS = 'Diners'.freeze,
+
+      # TODO: Write general description for DISCOVER
+      DISCOVER = 'Discover'.freeze,
+
+      # TODO: Write general description for MASTERCARD
+      MASTERCARD = 'MasterCard'.freeze,
+
+      # TODO: Write general description for VISA
+      VISA = 'VISA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARD_SCHEME_NAME_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/consent.rb

@@ -0,0 +1,145 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AccountAndTransactionApiSpecification
+  # Contains the requested consent
+  class Consent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specifies the Open Banking account access consent types. This is a list of
+    # the data clusters being consented by the Customer, and requested for
+    # authorisation with the API Provider.
+    # @return [Array[PermissionEnum]]
+    attr_accessor :permissions
+
+    # Specified date and time the permissions will expire. If this is not
+    # populated, the permissions will be open ended.
+    # All dates in the JSON payloads are represented in ISO 8601 date-time
+    # format.
+    # All date-time fields in responses must include the timezone. An example is
+    # below:
+    # 2017-04-05T10:43:07+00:00
+    # @return [DateTime]
+    attr_accessor :expiration_date_time
+
+    # Specified start date and time for the transaction query period. If this is
+    # not populated, the start date will be open ended, and data will be
+    # returned from the earliest available transaction.
+    # All dates in the JSON payloads are represented in ISO 8601 date-time
+    # format.
+    # All date-time fields in responses must include the timezone. An example is
+    # below:
+    # 2017-04-05T10:43:07+00:00
+    # @return [DateTime]
+    attr_accessor :transaction_from_date_time
+
+    # Specified end date and time for the transaction query period. If this is
+    # not populated, the end date will be open ended, and data will be returned
+    # to the latest available transaction.
+    # All dates in the JSON payloads are represented in ISO 8601 date-time
+    # format.
+    # All date-time fields in responses must include the timezone. An example is
+    # below:
+    # 2017-04-05T10:43:07+00:00
+    # @return [DateTime]
+    attr_accessor :transaction_to_date_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['permissions'] = 'Permissions'
+      @_hash['expiration_date_time'] = 'ExpirationDateTime'
+      @_hash['transaction_from_date_time'] = 'TransactionFromDateTime'
+      @_hash['transaction_to_date_time'] = 'TransactionToDateTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expiration_date_time
+        transaction_from_date_time
+        transaction_to_date_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(permissions = nil, expiration_date_time = SKIP,
+                   transaction_from_date_time = SKIP,
+                   transaction_to_date_time = SKIP)
+      @permissions = permissions
+      @expiration_date_time = expiration_date_time unless expiration_date_time == SKIP
+      unless transaction_from_date_time == SKIP
+        @transaction_from_date_time =
+          transaction_from_date_time
+      end
+      @transaction_to_date_time = transaction_to_date_time unless transaction_to_date_time == 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.
+      permissions = hash.key?('Permissions') ? hash['Permissions'] : nil
+      expiration_date_time = if hash.key?('ExpirationDateTime')
+                               (DateTimeHelper.from_rfc3339(hash['ExpirationDateTime']) if hash['ExpirationDateTime'])
+                             else
+                               SKIP
+                             end
+      transaction_from_date_time = if hash.key?('TransactionFromDateTime')
+                                     (DateTimeHelper.from_rfc3339(hash['TransactionFromDateTime']) if hash['TransactionFromDateTime'])
+                                   else
+                                     SKIP
+                                   end
+      transaction_to_date_time = if hash.key?('TransactionToDateTime')
+                                   (DateTimeHelper.from_rfc3339(hash['TransactionToDateTime']) if hash['TransactionToDateTime'])
+                                 else
+                                   SKIP
+                                 end
+
+      # Create object from extracted values.
+      Consent.new(permissions,
+                  expiration_date_time,
+                  transaction_from_date_time,
+                  transaction_to_date_time)
+    end
+
+    def to_custom_expiration_date_time
+      DateTimeHelper.to_rfc3339(expiration_date_time)
+    end
+
+    def to_custom_transaction_from_date_time
+      DateTimeHelper.to_rfc3339(transaction_from_date_time)
+    end
+
+    def to_custom_transaction_to_date_time
+      DateTimeHelper.to_rfc3339(transaction_to_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} permissions: #{@permissions}, expiration_date_time:"\
+      " #{@expiration_date_time}, transaction_from_date_time: #{@transaction_from_date_time},"\
+      " transaction_to_date_time: #{@transaction_to_date_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} permissions: #{@permissions.inspect}, expiration_date_time:"\
+      " #{@expiration_date_time.inspect}, transaction_from_date_time:"\
+      " #{@transaction_from_date_time.inspect}, transaction_to_date_time:"\
+      " #{@transaction_to_date_time.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/credit_debit_indicator_enum.rb

@@ -0,0 +1,24 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Indicates whether the balance is a credit or a debit balance. Usage: A zero
+  # balance is considered to be a credit balance.
+  class CreditDebitIndicatorEnum
+    CREDIT_DEBIT_INDICATOR_ENUM = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'Credit'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'Debit'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CREDIT_DEBIT_INDICATOR_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/credit_line.rb

@@ -0,0 +1,82 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # CreditLine Model.
+  class CreditLine < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether or not the credit line is included in the balance of the
+    # account. Usage: If not present, credit line is not included in the balance
+    # amount of the account.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :included
+
+    # Amount of money of the cash balance.
+    # @return [Amount]
+    attr_accessor :amount
+
+    # Limit type, in a coded form.
+    # @return [CreditLineTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['included'] = 'Included'
+      @_hash['amount'] = 'Amount'
+      @_hash['type'] = 'Type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(included = nil, amount = SKIP, type = SKIP)
+      @included = included
+      @amount = amount unless amount == SKIP
+      @type = type unless type == 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.
+      included = hash.key?('Included') ? hash['Included'] : nil
+      amount = Amount.from_hash(hash['Amount']) if hash['Amount']
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+
+      # Create object from extracted values.
+      CreditLine.new(included,
+                     amount,
+                     type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} included: #{@included}, amount: #{@amount}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} included: #{@included.inspect}, amount: #{@amount.inspect}, type:"\
+      " #{@type.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/credit_line_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
+  # Limit type, in a coded form.
+  class CreditLineTypeEnum
+    CREDIT_LINE_TYPE_ENUM = [
+      # TODO: Write general description for PREAGREED
+      PREAGREED = 'Pre-Agreed'.freeze,
+
+      # TODO: Write general description for EMERGENCY
+      EMERGENCY = 'Emergency'.freeze,
+
+      # TODO: Write general description for TEMPORARY
+      TEMPORARY = 'Temporary'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CREDIT_LINE_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/creditor_account.rb

@@ -0,0 +1,102 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Unambiguous identification of the account of the creditor, in the case of a
+  # debit transaction.
+  class CreditorAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AccountSchemeModelEnum]
+    attr_accessor :scheme_name
+
+    # Identification assigned by an institution to identify an account. This
+    # identification is known by the account owner.
+    # @return [String]
+    attr_accessor :identification
+
+    # Name of the account, as assigned by the account servicing institution, in
+    # agreement with the account owner in order to provide an additional means
+    # of identification of the account.
+    # Usage: The account name is different from the account owner name. The
+    # account name is used in certain user communities to provide a means of
+    # identifying the account, in addition to the account owner's identity and
+    # the account number.
+    # @return [String]
+    attr_accessor :name
+
+    # This is secondary identification of the account, as assigned by the
+    # account servicing institution.
+    # @return [String]
+    attr_accessor :secondary_identification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['scheme_name'] = 'SchemeName'
+      @_hash['identification'] = 'Identification'
+      @_hash['name'] = 'Name'
+      @_hash['secondary_identification'] = 'SecondaryIdentification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        secondary_identification
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(scheme_name = nil, identification = nil, name = SKIP,
+                   secondary_identification = SKIP)
+      @scheme_name = scheme_name
+      @identification = identification
+      @name = name unless name == SKIP
+      @secondary_identification = secondary_identification unless secondary_identification == 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.
+      scheme_name = hash.key?('SchemeName') ? hash['SchemeName'] : nil
+      identification =
+        hash.key?('Identification') ? hash['Identification'] : nil
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      secondary_identification =
+        hash.key?('SecondaryIdentification') ? hash['SecondaryIdentification'] : SKIP
+
+      # Create object from extracted values.
+      CreditorAccount.new(scheme_name,
+                          identification,
+                          name,
+                          secondary_identification)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_name: #{@scheme_name}, identification: #{@identification}, name:"\
+      " #{@name}, secondary_identification: #{@secondary_identification}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_name: #{@scheme_name.inspect}, identification:"\
+      " #{@identification.inspect}, name: #{@name.inspect}, secondary_identification:"\
+      " #{@secondary_identification.inspect}>"
+    end
+  end
+end