pnz-payments-sdk 1.0.0

data/lib/account_and_transaction_api_specification/models/delivery_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 or in free format text.
+  class DeliveryAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifies the nature of the postal address.
+    # @return [AddressTypeEnum]
+    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, for instance state, region, county.
+    # @return [String]
+    attr_accessor :country_sub_division
+
+    # Nation with its own government, occupying a particular territory.
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_type'] = 'AddressType'
+      @_hash['address_line'] = 'AddressLine'
+      @_hash['street_name'] = 'StreetName'
+      @_hash['building_number'] = 'BuildingNumber'
+      @_hash['post_code'] = 'PostCode'
+      @_hash['town_name'] = 'TownName'
+      @_hash['country_sub_division'] = 'CountrySubDivision'
+      @_hash['country'] = 'Country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_type
+        address_line
+        street_name
+        building_number
+        post_code
+        town_name
+        country_sub_division
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, address_type = SKIP, address_line = SKIP,
+                   street_name = SKIP, building_number = SKIP, post_code = SKIP,
+                   town_name = SKIP, country_sub_division = SKIP)
+      @address_type = address_type unless address_type == SKIP
+      @address_line = address_line unless address_line == SKIP
+      @street_name = street_name unless street_name == SKIP
+      @building_number = building_number unless building_number == SKIP
+      @post_code = post_code unless post_code == SKIP
+      @town_name = town_name unless town_name == SKIP
+      @country_sub_division = country_sub_division unless country_sub_division == SKIP
+      @country = country
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      country = hash.key?('Country') ? hash['Country'] : nil
+      address_type = hash.key?('AddressType') ? hash['AddressType'] : SKIP
+      address_line = hash.key?('AddressLine') ? hash['AddressLine'] : SKIP
+      street_name = hash.key?('StreetName') ? hash['StreetName'] : SKIP
+      building_number =
+        hash.key?('BuildingNumber') ? hash['BuildingNumber'] : SKIP
+      post_code = hash.key?('PostCode') ? hash['PostCode'] : SKIP
+      town_name = hash.key?('TownName') ? hash['TownName'] : SKIP
+      country_sub_division =
+        hash.key?('CountrySubDivision') ? hash['CountrySubDivision'] : SKIP
+
+      # Create object from extracted values.
+      DeliveryAddress.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/direct_debit_model.rb

@@ -0,0 +1,146 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AccountAndTransactionApiSpecification
+  # DirectDebitModel Model.
+  class DirectDebitModel < 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 direct debit
+    # resource. This identifier has no meaning to the account owner.
+    # @return [String]
+    attr_accessor :direct_debit_id
+
+    # Direct Debit reference.
+    # @return [String]
+    attr_accessor :mandate_identification
+
+    # Specifies the status of the direct debit in code form.
+    # @return [DirectDebitStatusCodeEnum]
+    attr_accessor :direct_debit_status_code
+
+    # Name of Service User
+    # @return [String]
+    attr_accessor :name
+
+    # Date of most recent direct debit collection.
+    # 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 :previous_payment_date_time
+
+    # The amount of the most recent direct debit collection.
+    # @return [PreviousPaymentAmount]
+    attr_accessor :previous_payment_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'AccountId'
+      @_hash['direct_debit_id'] = 'DirectDebitId'
+      @_hash['mandate_identification'] = 'MandateIdentification'
+      @_hash['direct_debit_status_code'] = 'DirectDebitStatusCode'
+      @_hash['name'] = 'Name'
+      @_hash['previous_payment_date_time'] = 'PreviousPaymentDateTime'
+      @_hash['previous_payment_amount'] = 'PreviousPaymentAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        direct_debit_id
+        direct_debit_status_code
+        previous_payment_date_time
+        previous_payment_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = nil, mandate_identification = nil, name = nil,
+                   direct_debit_id = SKIP, direct_debit_status_code = SKIP,
+                   previous_payment_date_time = SKIP,
+                   previous_payment_amount = SKIP)
+      @account_id = account_id
+      @direct_debit_id = direct_debit_id unless direct_debit_id == SKIP
+      @mandate_identification = mandate_identification
+      @direct_debit_status_code = direct_debit_status_code unless direct_debit_status_code == SKIP
+      @name = name
+      unless previous_payment_date_time == SKIP
+        @previous_payment_date_time =
+          previous_payment_date_time
+      end
+      @previous_payment_amount = previous_payment_amount unless previous_payment_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
+      mandate_identification =
+        hash.key?('MandateIdentification') ? hash['MandateIdentification'] : nil
+      name = hash.key?('Name') ? hash['Name'] : nil
+      direct_debit_id =
+        hash.key?('DirectDebitId') ? hash['DirectDebitId'] : SKIP
+      direct_debit_status_code =
+        hash.key?('DirectDebitStatusCode') ? hash['DirectDebitStatusCode'] : SKIP
+      previous_payment_date_time = if hash.key?('PreviousPaymentDateTime')
+                                     (DateTimeHelper.from_rfc3339(hash['PreviousPaymentDateTime']) if hash['PreviousPaymentDateTime'])
+                                   else
+                                     SKIP
+                                   end
+      previous_payment_amount = PreviousPaymentAmount.from_hash(hash['PreviousPaymentAmount']) if
+        hash['PreviousPaymentAmount']
+
+      # Create object from extracted values.
+      DirectDebitModel.new(account_id,
+                           mandate_identification,
+                           name,
+                           direct_debit_id,
+                           direct_debit_status_code,
+                           previous_payment_date_time,
+                           previous_payment_amount)
+    end
+
+    def to_custom_previous_payment_date_time
+      DateTimeHelper.to_rfc3339(previous_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}, direct_debit_id: #{@direct_debit_id},"\
+      " mandate_identification: #{@mandate_identification}, direct_debit_status_code:"\
+      " #{@direct_debit_status_code}, name: #{@name}, previous_payment_date_time:"\
+      " #{@previous_payment_date_time}, previous_payment_amount: #{@previous_payment_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}, direct_debit_id:"\
+      " #{@direct_debit_id.inspect}, mandate_identification: #{@mandate_identification.inspect},"\
+      " direct_debit_status_code: #{@direct_debit_status_code.inspect}, name: #{@name.inspect},"\
+      " previous_payment_date_time: #{@previous_payment_date_time.inspect},"\
+      " previous_payment_amount: #{@previous_payment_amount.inspect}>"
+    end
+  end
+end

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

data/lib/account_and_transaction_api_specification/models/direct_debit_status_code_enum.rb

@@ -0,0 +1,23 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Specifies the status of the direct debit in code form.
+  class DirectDebitStatusCodeEnum
+    DIRECT_DEBIT_STATUS_CODE_ENUM = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'Active'.freeze,
+
+      # TODO: Write general description for INACTIVE
+      INACTIVE = 'Inactive'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DIRECT_DEBIT_STATUS_CODE_ENUM.include?(value)
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/error.rb

@@ -0,0 +1,92 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Error Model.
+  class Error < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Low level textual error code.
+    # @return [ErrorCodeEnum]
+    attr_accessor :error_code
+
+    # A free text description of the error that occurred. E.g., 'A mandatory
+    # field isn't supplied'.
+    # @return [String]
+    attr_accessor :message
+
+    # A recommended but optional reference to the JSON Path of the field with
+    # error, e.g., Data.Consent.InstructedAmount.Currency
+    # @return [String]
+    attr_accessor :path
+
+    # URL to help remediate the problem, provide more information or to API
+    # Reference.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_code'] = 'ErrorCode'
+      @_hash['message'] = 'Message'
+      @_hash['path'] = 'Path'
+      @_hash['url'] = 'Url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        path
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(error_code = nil, message = nil, path = SKIP, url = SKIP)
+      @error_code = error_code
+      @message = message
+      @path = path unless path == SKIP
+      @url = url unless url == 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.
+      error_code = hash.key?('ErrorCode') ? hash['ErrorCode'] : nil
+      message = hash.key?('Message') ? hash['Message'] : nil
+      path = hash.key?('Path') ? hash['Path'] : SKIP
+      url = hash.key?('Url') ? hash['Url'] : SKIP
+
+      # Create object from extracted values.
+      Error.new(error_code,
+                message,
+                path,
+                url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, message: #{@message}, path: #{@path}, url:"\
+      " #{@url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, message: #{@message.inspect}, path:"\
+      " #{@path.inspect}, url: #{@url.inspect}>"
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/models/error_code_enum.rb

@@ -0,0 +1,100 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # Low level textual error code.
+  class ErrorCodeEnum
+    ERROR_CODE_ENUM = [
+      # TODO: Write general description for ENUM_FIELDEXPECTED
+      ENUM_FIELDEXPECTED = 'Field.Expected'.freeze,
+
+      # TODO: Write general description for ENUM_FIELDINVALID
+      ENUM_FIELDINVALID = 'Field.Invalid'.freeze,
+
+      # TODO: Write general description for ENUM_FIELDMISSING
+      ENUM_FIELDMISSING = 'Field.Missing'.freeze,
+
+      # TODO: Write general description for ENUM_FIELDUNEXPECTED
+      ENUM_FIELDUNEXPECTED = 'Field.Unexpected'.freeze,
+
+      # TODO: Write general description for ENUM_HEADERINVALID
+      ENUM_HEADERINVALID = 'Header.Invalid'.freeze,
+
+      # TODO: Write general description for ENUM_HEADERMISSING
+      ENUM_HEADERMISSING = 'Header.Missing'.freeze,
+
+      # TODO: Write general description for ENUM_QUERYPARAMINVALID
+      ENUM_QUERYPARAMINVALID = 'QueryParam.Invalid'.freeze,
+
+      # TODO: Write general description for REAUTHENTICATE
+      REAUTHENTICATE = 'Reauthenticate'.freeze,
+
+      # TODO: Write general description for REAUTHORISE
+      REAUTHORISE = 'Reauthorise'.freeze,
+
+      # TODO: Write general description for ENUM_RESOURCECONSENTCREDITORACCOUNT
+      ENUM_RESOURCECONSENTCREDITORACCOUNT = 'Resource.Consent.CreditorAccount'.freeze,
+
+      # TODO: Write general description for ENUM_RESOURCECONSENTDEBTORACCOUNT
+      ENUM_RESOURCECONSENTDEBTORACCOUNT = 'Resource.Consent.DebtorAccount'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_RESOURCECONSENTEXCEEDDATAPERMISSIONS
+      ENUM_RESOURCECONSENTEXCEEDDATAPERMISSIONS = 'Resource.Consent.Exceed.DataPermissions'.freeze,
+
+      # TODO: Write general description for ENUM_RESOURCECONSENTEXCEEDDATES
+      ENUM_RESOURCECONSENTEXCEEDDATES = 'Resource.Consent.Exceed.Dates'.freeze,
+
+      # TODO: Write general description for ENUM_RESOURCECONSENTEXCEEDFREQUENCY
+      ENUM_RESOURCECONSENTEXCEEDFREQUENCY = 'Resource.Consent.Exceed.Frequency'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_RESOURCECONSENTEXCEEDMAXIMUMAMOUNT
+      ENUM_RESOURCECONSENTEXCEEDMAXIMUMAMOUNT = 'Resource.Consent.Exceed.MaximumAmount'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_RESOURCECONSENTEXCEEDTOTALAMOUNT
+      ENUM_RESOURCECONSENTEXCEEDTOTALAMOUNT = 'Resource.Consent.Exceed.TotalAmount'.freeze,
+
+      # TODO: Write general description for ENUM_RESOURCECONSENTEXCEEDTOTALCOUNT
+      ENUM_RESOURCECONSENTEXCEEDTOTALCOUNT = 'Resource.Consent.Exceed.TotalCount'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_RESOURCECONSENTEXCEEDTRANSACTIONDATES
+      ENUM_RESOURCECONSENTEXCEEDTRANSACTIONDATES = 'Resource.Consent.Exceed.TransactionDates'.freeze,
+
+      # TODO: Write general description for ENUM_RESOURCECONSENTINVALIDSTATUS
+      ENUM_RESOURCECONSENTINVALIDSTATUS = 'Resource.Consent.InvalidStatus'.freeze,
+
+      # TODO: Write general description for ENUM_RESOURCECONSENTMISMATCH
+      ENUM_RESOURCECONSENTMISMATCH = 'Resource.Consent.Mismatch'.freeze,
+
+      # TODO: Write general description for ENUM_RESOURCEINVALID
+      ENUM_RESOURCEINVALID = 'Resource.Invalid'.freeze,
+
+      # TODO: Write general description for UNEXPECTEDERROR
+      UNEXPECTEDERROR = 'UnexpectedError'.freeze,
+
+      # TODO: Write general description for ENUM_UNSUPPORTEDACCOUNTIDENTIFIER
+      ENUM_UNSUPPORTEDACCOUNTIDENTIFIER = 'Unsupported.AccountIdentifier'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_UNSUPPORTEDACCOUNTSECONDARYIDENTIFIER
+      ENUM_UNSUPPORTEDACCOUNTSECONDARYIDENTIFIER = 'Unsupported.AccountSecondaryIdentifier'.freeze,
+
+      # TODO: Write general description for ENUM_UNSUPPORTEDCURRENCY
+      ENUM_UNSUPPORTEDCURRENCY = 'Unsupported.Currency'.freeze,
+
+      # TODO: Write general description for ENUM_UNSUPPORTEDSCHEME
+      ENUM_UNSUPPORTEDSCHEME = 'Unsupported.Scheme'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ERROR_CODE_ENUM.include?(value)
+    end
+  end
+end