pnz-payments-sdk 1.0.0

data/lib/account_and_transaction_api_specification/models/postal_address.rb

@@ -0,0 +1,138 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Information that locates and identifies a specific address, as defined by
+  # postal services.
+  class PostalAddress < 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 such as state, region, county.
+    # @return [String]
+    attr_accessor :country_sub_division
+
+    # Nation with its own government.
+    # @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.
+      PostalAddress.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/previous_payment_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
+  # The amount of the most recent direct debit collection.
+  class PreviousPaymentAmount < 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.
+      PreviousPaymentAmount.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/proprietary_bank_transaction_code.rb

@@ -0,0 +1,70 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Set of elements to fully identify a proprietary bank transaction code.
+  class ProprietaryBankTransactionCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Proprietary bank transaction code to identify the underlying transaction.
+    # @return [String]
+    attr_accessor :code
+
+    # Identification of the issuer of the proprietary bank transaction code.
+    # @return [String]
+    attr_accessor :issuer
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'Code'
+      @_hash['issuer'] = 'Issuer'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        issuer
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = nil, issuer = SKIP)
+      @code = code
+      @issuer = issuer unless issuer == 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.
+      code = hash.key?('Code') ? hash['Code'] : nil
+      issuer = hash.key?('Issuer') ? hash['Issuer'] : SKIP
+
+      # Create object from extracted values.
+      ProprietaryBankTransactionCode.new(code,
+                                         issuer)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, issuer: #{@issuer}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, issuer: #{@issuer.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/reference.rb

@@ -0,0 +1,95 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Reference Model.
+  class Reference < 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.
+      Reference.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/risk.rb

@@ -0,0 +1,164 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # The Risk section is sent by the initiating party to the API Provider. It is
+  # used to specify additional details for risk scoring.
+  class Risk < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Location of the end-user on the earth specified by two numbers
+    # representing vertical and horizontal position
+    # @return [GeoLocation]
+    attr_accessor :geo_location
+
+    # Specifies the payment context
+    # @return [PaymentContextCodeEnum]
+    attr_accessor :payment_context_code
+
+    # Category code conforms to ISO 18245, related to the type of services or
+    # goods the merchant provides for the transaction
+    # @return [String]
+    attr_accessor :merchant_category_code
+
+    # The unique customer identifier of the Customer with the merchant.
+    # @return [String]
+    attr_accessor :merchant_customer_identification
+
+    # Information that locates and identifies a specific address, as defined by
+    # postal services or in free format text.
+    # @return [DeliveryAddress]
+    attr_accessor :delivery_address
+
+    # Name of the end user facing application
+    # @return [String]
+    attr_accessor :end_user_app_name
+
+    # Version of the end user facing application
+    # @return [String]
+    attr_accessor :end_user_app_version
+
+    # Name of the merchant
+    # @return [String]
+    attr_accessor :merchant_name
+
+    # NZ business number for the merchant
+    # @return [String]
+    attr_accessor :merchant_nzbn
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['geo_location'] = 'GeoLocation'
+      @_hash['payment_context_code'] = 'PaymentContextCode'
+      @_hash['merchant_category_code'] = 'MerchantCategoryCode'
+      @_hash['merchant_customer_identification'] =
+        'MerchantCustomerIdentification'
+      @_hash['delivery_address'] = 'DeliveryAddress'
+      @_hash['end_user_app_name'] = 'EndUserAppName'
+      @_hash['end_user_app_version'] = 'EndUserAppVersion'
+      @_hash['merchant_name'] = 'MerchantName'
+      @_hash['merchant_nzbn'] = 'MerchantNZBN'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        geo_location
+        payment_context_code
+        merchant_category_code
+        merchant_customer_identification
+        delivery_address
+        end_user_app_name
+        end_user_app_version
+        merchant_name
+        merchant_nzbn
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(geo_location = SKIP, payment_context_code = SKIP,
+                   merchant_category_code = SKIP,
+                   merchant_customer_identification = SKIP,
+                   delivery_address = SKIP, end_user_app_name = SKIP,
+                   end_user_app_version = SKIP, merchant_name = SKIP,
+                   merchant_nzbn = SKIP)
+      @geo_location = geo_location unless geo_location == SKIP
+      @payment_context_code = payment_context_code unless payment_context_code == SKIP
+      @merchant_category_code = merchant_category_code unless merchant_category_code == SKIP
+      unless merchant_customer_identification == SKIP
+        @merchant_customer_identification =
+          merchant_customer_identification
+      end
+      @delivery_address = delivery_address unless delivery_address == SKIP
+      @end_user_app_name = end_user_app_name unless end_user_app_name == SKIP
+      @end_user_app_version = end_user_app_version unless end_user_app_version == SKIP
+      @merchant_name = merchant_name unless merchant_name == SKIP
+      @merchant_nzbn = merchant_nzbn unless merchant_nzbn == 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.
+      geo_location = GeoLocation.from_hash(hash['GeoLocation']) if hash['GeoLocation']
+      payment_context_code =
+        hash.key?('PaymentContextCode') ? hash['PaymentContextCode'] : SKIP
+      merchant_category_code =
+        hash.key?('MerchantCategoryCode') ? hash['MerchantCategoryCode'] : SKIP
+      merchant_customer_identification =
+        hash.key?('MerchantCustomerIdentification') ? hash['MerchantCustomerIdentification'] : SKIP
+      delivery_address = DeliveryAddress.from_hash(hash['DeliveryAddress']) if
+        hash['DeliveryAddress']
+      end_user_app_name =
+        hash.key?('EndUserAppName') ? hash['EndUserAppName'] : SKIP
+      end_user_app_version =
+        hash.key?('EndUserAppVersion') ? hash['EndUserAppVersion'] : SKIP
+      merchant_name = hash.key?('MerchantName') ? hash['MerchantName'] : SKIP
+      merchant_nzbn = hash.key?('MerchantNZBN') ? hash['MerchantNZBN'] : SKIP
+
+      # Create object from extracted values.
+      Risk.new(geo_location,
+               payment_context_code,
+               merchant_category_code,
+               merchant_customer_identification,
+               delivery_address,
+               end_user_app_name,
+               end_user_app_version,
+               merchant_name,
+               merchant_nzbn)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} geo_location: #{@geo_location}, payment_context_code:"\
+      " #{@payment_context_code}, merchant_category_code: #{@merchant_category_code},"\
+      " merchant_customer_identification: #{@merchant_customer_identification}, delivery_address:"\
+      " #{@delivery_address}, end_user_app_name: #{@end_user_app_name}, end_user_app_version:"\
+      " #{@end_user_app_version}, merchant_name: #{@merchant_name}, merchant_nzbn:"\
+      " #{@merchant_nzbn}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} geo_location: #{@geo_location.inspect}, payment_context_code:"\
+      " #{@payment_context_code.inspect}, merchant_category_code:"\
+      " #{@merchant_category_code.inspect}, merchant_customer_identification:"\
+      " #{@merchant_customer_identification.inspect}, delivery_address:"\
+      " #{@delivery_address.inspect}, end_user_app_name: #{@end_user_app_name.inspect},"\
+      " end_user_app_version: #{@end_user_app_version.inspect}, merchant_name:"\
+      " #{@merchant_name.inspect}, merchant_nzbn: #{@merchant_nzbn.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/scheduled_payment_model.rb

@@ -0,0 +1,155 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AccountAndTransactionApiSpecification
+  # ScheduledPaymentModel Model.
+  class ScheduledPaymentModel < 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 scheduled payment
+    # resource. This identifier has no meaning to the account owner.
+    # @return [String]
+    attr_accessor :scheduled_payment_id
+
+    # The date on which the scheduled payment will be made.
+    # 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 :scheduled_payment_date_time
+
+    # Specifies the scheduled payment date type requested
+    # @return [ScheduledTypeEnum]
+    attr_accessor :scheduled_type
+
+    # Amount of money of the cash balance after a transaction entry is applied
+    # to the account..
+    # @return [InstructedAmount]
+    attr_accessor :instructed_amount
+
+    # Amount of money of the cash balance after a transaction entry is applied
+    # to the account..
+    # @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['scheduled_payment_id'] = 'ScheduledPaymentId'
+      @_hash['scheduled_payment_date_time'] = 'ScheduledPaymentDateTime'
+      @_hash['scheduled_type'] = 'ScheduledType'
+      @_hash['instructed_amount'] = 'InstructedAmount'
+      @_hash['reference'] = 'Reference'
+      @_hash['creditor_agent'] = 'CreditorAgent'
+      @_hash['creditor_account'] = 'CreditorAccount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        scheduled_payment_id
+        reference
+        creditor_agent
+        creditor_account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = nil, scheduled_payment_date_time = nil,
+                   scheduled_type = nil, instructed_amount = nil,
+                   scheduled_payment_id = SKIP, reference = SKIP,
+                   creditor_agent = SKIP, creditor_account = SKIP)
+      @account_id = account_id
+      @scheduled_payment_id = scheduled_payment_id unless scheduled_payment_id == SKIP
+      @scheduled_payment_date_time = scheduled_payment_date_time
+      @scheduled_type = scheduled_type
+      @instructed_amount = instructed_amount
+      @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
+      scheduled_payment_date_time = if hash.key?('ScheduledPaymentDateTime')
+                                      (DateTimeHelper.from_rfc3339(hash['ScheduledPaymentDateTime']) if hash['ScheduledPaymentDateTime'])
+                                    end
+      scheduled_type = hash.key?('ScheduledType') ? hash['ScheduledType'] : nil
+      instructed_amount = InstructedAmount.from_hash(hash['InstructedAmount']) if
+        hash['InstructedAmount']
+      scheduled_payment_id =
+        hash.key?('ScheduledPaymentId') ? hash['ScheduledPaymentId'] : 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.
+      ScheduledPaymentModel.new(account_id,
+                                scheduled_payment_date_time,
+                                scheduled_type,
+                                instructed_amount,
+                                scheduled_payment_id,
+                                reference,
+                                creditor_agent,
+                                creditor_account)
+    end
+
+    def to_custom_scheduled_payment_date_time
+      DateTimeHelper.to_rfc3339(scheduled_payment_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}, scheduled_payment_id: #{@scheduled_payment_id},"\
+      " scheduled_payment_date_time: #{@scheduled_payment_date_time}, scheduled_type:"\
+      " #{@scheduled_type}, instructed_amount: #{@instructed_amount}, 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}, scheduled_payment_id:"\
+      " #{@scheduled_payment_id.inspect}, scheduled_payment_date_time:"\
+      " #{@scheduled_payment_date_time.inspect}, scheduled_type: #{@scheduled_type.inspect},"\
+      " instructed_amount: #{@instructed_amount.inspect}, reference: #{@reference.inspect},"\
+      " creditor_agent: #{@creditor_agent.inspect}, creditor_account:"\
+      " #{@creditor_account.inspect}>"
+    end
+  end
+end