pnz-payments-sdk 1.0.0

data/lib/account_and_transaction_api_specification/models/statement.rb

@@ -0,0 +1,313 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AccountAndTransactionApiSpecification
+  # Statement Model.
+  class Statement < 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
+
+    # Unique identifier for the statement resource within an servicing
+    # institution. This identifier is both unique and immutable.
+    # @return [String]
+    attr_accessor :statement_id
+
+    # Unique reference for the statement. This reference may be optionally
+    # populated if available.
+    # @return [String]
+    attr_accessor :statement_reference
+
+    # Statement type, in a coded form.
+    # @return [StatementTypeEnum]
+    attr_accessor :type
+
+    # Date and time at which the statement period starts.
+    # 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 :start_date_time
+
+    # Date and time at which the statement period ends.
+    # 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 :end_date_time
+
+    # Date and time at which the resource was created.
+    # 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 :creation_date_time
+
+    # Other descriptions that may be available for the statement resource.
+    # @return [Array[String]]
+    attr_accessor :statement_description
+
+    # Set of elements used to provide details of a benefit or reward amount for
+    # the statement resource.
+    # @return [Array[StatementBenefit]]
+    attr_accessor :statement_benefit
+
+    # Set of elements used to provide details of a fee for the statement
+    # resource.
+    # @return [Array[StatementFee]]
+    attr_accessor :statement_fee
+
+    # Set of elements used to provide details of a generic interest amount
+    # related to the statement resource.
+    # @return [Array[StatementInterest]]
+    attr_accessor :statement_interest
+
+    # Set of elements used to provide details of a generic date time for the
+    # statement resource.
+    # @return [Array[StatementDateTime]]
+    attr_accessor :statement_date_time
+
+    # Set of elements used to provide details of a generic rate related to the
+    # statement resource.
+    # @return [Array[StatementRate]]
+    attr_accessor :statement_rate
+
+    # Set of elements used to provide details of a generic number value related
+    # to the statement resource.
+    # @return [Array[StatementValue]]
+    attr_accessor :statement_value
+
+    # Set of elements used to provide details of a generic amount for the
+    # statement resource.
+    # @return [Array[StatementAmount]]
+    attr_accessor :statement_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountId'
+      @_hash['statement_id'] = 'StatementId'
+      @_hash['statement_reference'] = 'StatementReference'
+      @_hash['type'] = 'Type'
+      @_hash['start_date_time'] = 'StartDateTime'
+      @_hash['end_date_time'] = 'EndDateTime'
+      @_hash['creation_date_time'] = 'CreationDateTime'
+      @_hash['statement_description'] = 'StatementDescription'
+      @_hash['statement_benefit'] = 'StatementBenefit'
+      @_hash['statement_fee'] = 'StatementFee'
+      @_hash['statement_interest'] = 'StatementInterest'
+      @_hash['statement_date_time'] = 'StatementDateTime'
+      @_hash['statement_rate'] = 'StatementRate'
+      @_hash['statement_value'] = 'StatementValue'
+      @_hash['statement_amount'] = 'StatementAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        statement_id
+        statement_reference
+        statement_description
+        statement_benefit
+        statement_fee
+        statement_interest
+        statement_date_time
+        statement_rate
+        statement_value
+        statement_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = nil, type = nil, start_date_time = nil,
+                   end_date_time = nil, creation_date_time = nil,
+                   statement_id = SKIP, statement_reference = SKIP,
+                   statement_description = SKIP, statement_benefit = SKIP,
+                   statement_fee = SKIP, statement_interest = SKIP,
+                   statement_date_time = SKIP, statement_rate = SKIP,
+                   statement_value = SKIP, statement_amount = SKIP)
+      @account_id = account_id
+      @statement_id = statement_id unless statement_id == SKIP
+      @statement_reference = statement_reference unless statement_reference == SKIP
+      @type = type
+      @start_date_time = start_date_time
+      @end_date_time = end_date_time
+      @creation_date_time = creation_date_time
+      @statement_description = statement_description unless statement_description == SKIP
+      @statement_benefit = statement_benefit unless statement_benefit == SKIP
+      @statement_fee = statement_fee unless statement_fee == SKIP
+      @statement_interest = statement_interest unless statement_interest == SKIP
+      @statement_date_time = statement_date_time unless statement_date_time == SKIP
+      @statement_rate = statement_rate unless statement_rate == SKIP
+      @statement_value = statement_value unless statement_value == SKIP
+      @statement_amount = statement_amount unless statement_amount == 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
+      type = hash.key?('Type') ? hash['Type'] : nil
+      start_date_time = if hash.key?('StartDateTime')
+                          (DateTimeHelper.from_rfc3339(hash['StartDateTime']) if hash['StartDateTime'])
+                        end
+      end_date_time = if hash.key?('EndDateTime')
+                        (DateTimeHelper.from_rfc3339(hash['EndDateTime']) if hash['EndDateTime'])
+                      end
+      creation_date_time = if hash.key?('CreationDateTime')
+                             (DateTimeHelper.from_rfc3339(hash['CreationDateTime']) if hash['CreationDateTime'])
+                           end
+      statement_id = hash.key?('StatementId') ? hash['StatementId'] : SKIP
+      statement_reference =
+        hash.key?('StatementReference') ? hash['StatementReference'] : SKIP
+      statement_description =
+        hash.key?('StatementDescription') ? hash['StatementDescription'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      statement_benefit = nil
+      unless hash['StatementBenefit'].nil?
+        statement_benefit = []
+        hash['StatementBenefit'].each do |structure|
+          statement_benefit << (StatementBenefit.from_hash(structure) if structure)
+        end
+      end
+
+      statement_benefit = SKIP unless hash.key?('StatementBenefit')
+      # Parameter is an array, so we need to iterate through it
+      statement_fee = nil
+      unless hash['StatementFee'].nil?
+        statement_fee = []
+        hash['StatementFee'].each do |structure|
+          statement_fee << (StatementFee.from_hash(structure) if structure)
+        end
+      end
+
+      statement_fee = SKIP unless hash.key?('StatementFee')
+      # Parameter is an array, so we need to iterate through it
+      statement_interest = nil
+      unless hash['StatementInterest'].nil?
+        statement_interest = []
+        hash['StatementInterest'].each do |structure|
+          statement_interest << (StatementInterest.from_hash(structure) if structure)
+        end
+      end
+
+      statement_interest = SKIP unless hash.key?('StatementInterest')
+      # Parameter is an array, so we need to iterate through it
+      statement_date_time = nil
+      unless hash['StatementDateTime'].nil?
+        statement_date_time = []
+        hash['StatementDateTime'].each do |structure|
+          statement_date_time << (StatementDateTime.from_hash(structure) if structure)
+        end
+      end
+
+      statement_date_time = SKIP unless hash.key?('StatementDateTime')
+      # Parameter is an array, so we need to iterate through it
+      statement_rate = nil
+      unless hash['StatementRate'].nil?
+        statement_rate = []
+        hash['StatementRate'].each do |structure|
+          statement_rate << (StatementRate.from_hash(structure) if structure)
+        end
+      end
+
+      statement_rate = SKIP unless hash.key?('StatementRate')
+      # Parameter is an array, so we need to iterate through it
+      statement_value = nil
+      unless hash['StatementValue'].nil?
+        statement_value = []
+        hash['StatementValue'].each do |structure|
+          statement_value << (StatementValue.from_hash(structure) if structure)
+        end
+      end
+
+      statement_value = SKIP unless hash.key?('StatementValue')
+      # Parameter is an array, so we need to iterate through it
+      statement_amount = nil
+      unless hash['StatementAmount'].nil?
+        statement_amount = []
+        hash['StatementAmount'].each do |structure|
+          statement_amount << (StatementAmount.from_hash(structure) if structure)
+        end
+      end
+
+      statement_amount = SKIP unless hash.key?('StatementAmount')
+
+      # Create object from extracted values.
+      Statement.new(account_id,
+                    type,
+                    start_date_time,
+                    end_date_time,
+                    creation_date_time,
+                    statement_id,
+                    statement_reference,
+                    statement_description,
+                    statement_benefit,
+                    statement_fee,
+                    statement_interest,
+                    statement_date_time,
+                    statement_rate,
+                    statement_value,
+                    statement_amount)
+    end
+
+    def to_custom_start_date_time
+      DateTimeHelper.to_rfc3339(start_date_time)
+    end
+
+    def to_custom_end_date_time
+      DateTimeHelper.to_rfc3339(end_date_time)
+    end
+
+    def to_custom_creation_date_time
+      DateTimeHelper.to_rfc3339(creation_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}, statement_id: #{@statement_id},"\
+      " statement_reference: #{@statement_reference}, type: #{@type}, start_date_time:"\
+      " #{@start_date_time}, end_date_time: #{@end_date_time}, creation_date_time:"\
+      " #{@creation_date_time}, statement_description: #{@statement_description},"\
+      " statement_benefit: #{@statement_benefit}, statement_fee: #{@statement_fee},"\
+      " statement_interest: #{@statement_interest}, statement_date_time: #{@statement_date_time},"\
+      " statement_rate: #{@statement_rate}, statement_value: #{@statement_value},"\
+      " statement_amount: #{@statement_amount}>"
+    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}, statement_id: #{@statement_id.inspect},"\
+      " statement_reference: #{@statement_reference.inspect}, type: #{@type.inspect},"\
+      " start_date_time: #{@start_date_time.inspect}, end_date_time: #{@end_date_time.inspect},"\
+      " creation_date_time: #{@creation_date_time.inspect}, statement_description:"\
+      " #{@statement_description.inspect}, statement_benefit: #{@statement_benefit.inspect},"\
+      " statement_fee: #{@statement_fee.inspect}, statement_interest:"\
+      " #{@statement_interest.inspect}, statement_date_time: #{@statement_date_time.inspect},"\
+      " statement_rate: #{@statement_rate.inspect}, statement_value: #{@statement_value.inspect},"\
+      " statement_amount: #{@statement_amount.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/statement_amount.rb

@@ -0,0 +1,81 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Set of elements used to provide details of a generic amount for the
+  # statement resource.
+  class StatementAmount < 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
+
+    # Amount type, in a coded form.
+    # @return [StatementAmountTypeEnum]
+    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.
+      StatementAmount.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

data/lib/account_and_transaction_api_specification/models/statement_amount_type_enum.rb

@@ -0,0 +1,83 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Amount type, in a coded form.
+  class StatementAmountTypeEnum
+    STATEMENT_AMOUNT_TYPE_ENUM = [
+      # TODO: Write general description for ARREARSCLOSINGBALANCE
+      ARREARSCLOSINGBALANCE = 'ArrearsClosingBalance'.freeze,
+
+      # TODO: Write general description for AVAILABLEBALANCE
+      AVAILABLEBALANCE = 'AvailableBalance'.freeze,
+
+      # TODO: Write general description for AVERAGEBALANCEWHENINCREDIT
+      AVERAGEBALANCEWHENINCREDIT = 'AverageBalanceWhenInCredit'.freeze,
+
+      # TODO: Write general description for AVERAGEBALANCEWHENINDEBIT
+      AVERAGEBALANCEWHENINDEBIT = 'AverageBalanceWhenInDebit'.freeze,
+
+      # TODO: Write general description for AVERAGEDAILYBALANCE
+      AVERAGEDAILYBALANCE = 'AverageDailyBalance'.freeze,
+
+      # TODO: Write general description for BALANCETRANSFERCLOSINGBALANCE
+      BALANCETRANSFERCLOSINGBALANCE = 'BalanceTransferClosingBalance'.freeze,
+
+      # TODO: Write general description for CASHCLOSINGBALANCE
+      CASHCLOSINGBALANCE = 'CashClosingBalance'.freeze,
+
+      # TODO: Write general description for CLOSINGBALANCE
+      CLOSINGBALANCE = 'ClosingBalance'.freeze,
+
+      # TODO: Write general description for CREDITLIMIT
+      CREDITLIMIT = 'CreditLimit'.freeze,
+
+      # TODO: Write general description for CURRENTPAYMENT
+      CURRENTPAYMENT = 'CurrentPayment'.freeze,
+
+      # TODO: Write general description for DIRECTDEBITPAYMENTDUE
+      DIRECTDEBITPAYMENTDUE = 'DirectDebitPaymentDue'.freeze,
+
+      # TODO: Write general description for MINIMUMPAYMENTDUE
+      MINIMUMPAYMENTDUE = 'MinimumPaymentDue'.freeze,
+
+      # TODO: Write general description for PREVIOUSCLOSINGBALANCE
+      PREVIOUSCLOSINGBALANCE = 'PreviousClosingBalance'.freeze,
+
+      # TODO: Write general description for PREVIOUSPAYMENT
+      PREVIOUSPAYMENT = 'PreviousPayment'.freeze,
+
+      # TODO: Write general description for PURCHASECLOSINGBALANCE
+      PURCHASECLOSINGBALANCE = 'PurchaseClosingBalance'.freeze,
+
+      # TODO: Write general description for STARTINGBALANCE
+      STARTINGBALANCE = 'StartingBalance'.freeze,
+
+      # TODO: Write general description for TOTALADJUSTMENTS
+      TOTALADJUSTMENTS = 'TotalAdjustments'.freeze,
+
+      # TODO: Write general description for TOTALCASHADVANCES
+      TOTALCASHADVANCES = 'TotalCashAdvances'.freeze,
+
+      # TODO: Write general description for TOTALCHARGES
+      TOTALCHARGES = 'TotalCharges'.freeze,
+
+      # TODO: Write general description for TOTALCREDITS
+      TOTALCREDITS = 'TotalCredits'.freeze,
+
+      # TODO: Write general description for TOTALDEBITS
+      TOTALDEBITS = 'TotalDebits'.freeze,
+
+      # TODO: Write general description for TOTALPURCHASES
+      TOTALPURCHASES = 'TotalPurchases'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATEMENT_AMOUNT_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/statement_benefit.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 provide details of a benefit or reward amount for
+  # the statement resource.
+  class StatementBenefit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of money of the cash balance.
+    # @return [Amount]
+    attr_accessor :amount
+
+    # Benefit type, in a coded form.
+    # @return [StatementBenefitTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'Amount'
+      @_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, type = nil)
+      @amount = amount
+      @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']
+      type = hash.key?('Type') ? hash['Type'] : nil
+
+      # Create object from extracted values.
+      StatementBenefit.new(amount,
+                           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}, 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}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/statement_benefit_type_enum.rb

@@ -0,0 +1,29 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Benefit type, in a coded form.
+  class StatementBenefitTypeEnum
+    STATEMENT_BENEFIT_TYPE_ENUM = [
+      # TODO: Write general description for CASHBACK
+      CASHBACK = 'Cashback'.freeze,
+
+      # TODO: Write general description for INSURANCE
+      INSURANCE = 'Insurance'.freeze,
+
+      # TODO: Write general description for TRAVELDISCOUNT
+      TRAVELDISCOUNT = 'TravelDiscount'.freeze,
+
+      # TODO: Write general description for TRAVELINSURANCE
+      TRAVELINSURANCE = 'TravelInsurance'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATEMENT_BENEFIT_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/statement_date_time.rb

@@ -0,0 +1,81 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AccountAndTransactionApiSpecification
+  # Set of elements used to provide details of a generic date time for the
+  # statement resource.
+  class StatementDateTime < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date and time associated with the date time type.
+    # 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
+
+    # Date time type, in a coded form.
+    # @return [StatementDateTimeTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date_time'] = 'DateTime'
+      @_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(date_time = nil, type = nil)
+      @date_time = date_time
+      @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.
+      date_time = if hash.key?('DateTime')
+                    (DateTimeHelper.from_rfc3339(hash['DateTime']) if hash['DateTime'])
+                  end
+      type = hash.key?('Type') ? hash['Type'] : nil
+
+      # Create object from extracted values.
+      StatementDateTime.new(date_time,
+                            type)
+    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} date_time: #{@date_time}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} date_time: #{@date_time.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end