pnz-payments-sdk 1.0.0

data/lib/account_and_transaction_api_specification/models/balance_model.rb

@@ -0,0 +1,136 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AccountAndTransactionApiSpecification
+  # Balance object schema
+  class BalanceModel < 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
+
+    # 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
+
+    # Indicates the date (and time) of the balance.
+    # 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 :date_time
+
+    # Indicates the date (and time) of the balance.
+    # 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 [Array[CreditLine]]
+    attr_accessor :credit_line
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountId'
+      @_hash['amount'] = 'Amount'
+      @_hash['credit_debit_indicator'] = 'CreditDebitIndicator'
+      @_hash['type'] = 'Type'
+      @_hash['date_time'] = 'DateTime'
+      @_hash['credit_line'] = 'CreditLine'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        credit_line
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = nil, amount = nil, credit_debit_indicator = nil,
+                   type = nil, date_time = nil, credit_line = SKIP)
+      @account_id = account_id
+      @amount = amount
+      @credit_debit_indicator = credit_debit_indicator
+      @type = type
+      @date_time = date_time
+      @credit_line = credit_line unless credit_line == 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
+      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
+      date_time = if hash.key?('DateTime')
+                    (DateTimeHelper.from_rfc3339(hash['DateTime']) if hash['DateTime'])
+                  end
+      # Parameter is an array, so we need to iterate through it
+      credit_line = nil
+      unless hash['CreditLine'].nil?
+        credit_line = []
+        hash['CreditLine'].each do |structure|
+          credit_line << (CreditLine.from_hash(structure) if structure)
+        end
+      end
+
+      credit_line = SKIP unless hash.key?('CreditLine')
+
+      # Create object from extracted values.
+      BalanceModel.new(account_id,
+                       amount,
+                       credit_debit_indicator,
+                       type,
+                       date_time,
+                       credit_line)
+    end
+
+    def to_custom_date_time
+      DateTimeHelper.to_rfc3339(date_time)
+    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}, amount: #{@amount}, credit_debit_indicator:"\
+      " #{@credit_debit_indicator}, type: #{@type}, date_time: #{@date_time}, credit_line:"\
+      " #{@credit_line}>"
+    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}, amount: #{@amount.inspect},"\
+      " credit_debit_indicator: #{@credit_debit_indicator.inspect}, type: #{@type.inspect},"\
+      " date_time: #{@date_time.inspect}, credit_line: #{@credit_line.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/balance_model_type_enum.rb

@@ -0,0 +1,47 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Balance type, in a coded form.
+  class BalanceModelTypeEnum
+    BALANCE_MODEL_TYPE_ENUM = [
+      # TODO: Write general description for CLOSINGAVAILABLE
+      CLOSINGAVAILABLE = 'ClosingAvailable'.freeze,
+
+      # TODO: Write general description for CLOSINGBOOKED
+      CLOSINGBOOKED = 'ClosingBooked'.freeze,
+
+      # TODO: Write general description for EXPECTED
+      EXPECTED = 'Expected'.freeze,
+
+      # TODO: Write general description for FORWARDAVAILABLE
+      FORWARDAVAILABLE = 'ForwardAvailable'.freeze,
+
+      # TODO: Write general description for INFORMATION
+      INFORMATION = 'Information'.freeze,
+
+      # TODO: Write general description for INTERIMAVAILABLE
+      INTERIMAVAILABLE = 'InterimAvailable'.freeze,
+
+      # TODO: Write general description for INTERIMBOOKED
+      INTERIMBOOKED = 'InterimBooked'.freeze,
+
+      # TODO: Write general description for OPENINGAVAILABLE
+      OPENINGAVAILABLE = 'OpeningAvailable'.freeze,
+
+      # TODO: Write general description for OPENINGBOOKED
+      OPENINGBOOKED = 'OpeningBooked'.freeze,
+
+      # TODO: Write general description for PREVIOUSLYCLOSEDBOOKED
+      PREVIOUSLYCLOSEDBOOKED = 'PreviouslyClosedBooked'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BALANCE_MODEL_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/balances_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
+  # BalancesResponse Model.
+  class BalancesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [BalancesResponseData]
+    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 = BalancesResponseData.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.
+      BalancesResponse.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/balances_response_data.rb

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

data/lib/account_and_transaction_api_specification/models/bank_transaction_code.rb

@@ -0,0 +1,69 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Set of elements used to fully identify the type of underlying transaction
+  # resulting in an entry.
+  class BankTransactionCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specifies the family within a domain.
+    # @return [String]
+    attr_accessor :code
+
+    # Specifies the sub-product family within a specific family.
+    # @return [String]
+    attr_accessor :sub_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'Code'
+      @_hash['sub_code'] = 'SubCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = nil, sub_code = nil)
+      @code = code
+      @sub_code = sub_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      code = hash.key?('Code') ? hash['Code'] : nil
+      sub_code = hash.key?('SubCode') ? hash['SubCode'] : nil
+
+      # Create object from extracted values.
+      BankTransactionCode.new(code,
+                              sub_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, sub_code: #{@sub_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, sub_code: #{@sub_code.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/base_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
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/account_and_transaction_api_specification/models/becs_remittance.rb

@@ -0,0 +1,109 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Unique reference, as assigned by the creditor, to unambiguously refer to the
+  # payment transaction. Usage: If available, the initiating party should
+  # provide this reference in the structured remittance information, to enable
+  # reconciliation by the creditor upon receipt of the amount of money. If the
+  # business context requires the use of a creditor reference or a payment remit
+  # identification, and only one identifier can be passed through the end-to-end
+  # chain, the creditor's reference or payment remittance identification should
+  # be quoted in the end-to-end transaction identification. NZ - Remittance
+  # information for use with BECS Electronic Credit payment scheme. The
+  # Particulars, Code and Reference fields are currently constrained by
+  # providers.  The design choice has been made not to constrain through schema
+  # restrictions, to allow for future changes that remove the constraint. Note
+  # that not all banks will accept all valid characters, in which case a
+  # descriptive 400 Bad Request will be returned. Constraining to a-z, A-Z, -
+  # (dash) and 0-9 is advised. One example is abc-XYZ-123
+  class BECSRemittance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :creditor_name
+
+    # TODO: Write general description for this method
+    # @return [CreditorReference]
+    attr_accessor :creditor_reference
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :debtor_name
+
+    # TODO: Write general description for this method
+    # @return [CreditorReference]
+    attr_accessor :debtor_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['creditor_name'] = 'CreditorName'
+      @_hash['creditor_reference'] = 'CreditorReference'
+      @_hash['debtor_name'] = 'DebtorName'
+      @_hash['debtor_reference'] = 'DebtorReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        creditor_reference
+        debtor_name
+        debtor_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(creditor_name = nil, creditor_reference = SKIP,
+                   debtor_name = SKIP, debtor_reference = SKIP)
+      @creditor_name = creditor_name
+      @creditor_reference = creditor_reference unless creditor_reference == SKIP
+      @debtor_name = debtor_name unless debtor_name == SKIP
+      @debtor_reference = debtor_reference unless debtor_reference == 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.
+      creditor_name = hash.key?('CreditorName') ? hash['CreditorName'] : nil
+      creditor_reference = CreditorReference.from_hash(hash['CreditorReference']) if
+        hash['CreditorReference']
+      debtor_name = hash.key?('DebtorName') ? hash['DebtorName'] : SKIP
+      debtor_reference = CreditorReference.from_hash(hash['DebtorReference']) if
+        hash['DebtorReference']
+
+      # Create object from extracted values.
+      BECSRemittance.new(creditor_name,
+                         creditor_reference,
+                         debtor_name,
+                         debtor_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} creditor_name: #{@creditor_name}, creditor_reference:"\
+      " #{@creditor_reference}, debtor_name: #{@debtor_name}, debtor_reference:"\
+      " #{@debtor_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} creditor_name: #{@creditor_name.inspect}, creditor_reference:"\
+      " #{@creditor_reference.inspect}, debtor_name: #{@debtor_name.inspect}, debtor_reference:"\
+      " #{@debtor_reference.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/beneficiaries_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
+  # BeneficiariesResponse Model.
+  class BeneficiariesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [BeneficiariesResponseData]
+    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 = BeneficiariesResponseData.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.
+      BeneficiariesResponse.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