packageruby 1.1.1

data/lib/form3_public_api/models/direct_debit_submission_creation_response.rb

@@ -0,0 +1,60 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # DirectDebitSubmissionCreationResponse Model.
+  class DirectDebitSubmissionCreationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DirectDebitSubmission]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [Links]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = SKIP,
+                   links = SKIP)
+      @data = data unless data == SKIP
+      @links = links unless links == 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.
+      data = DirectDebitSubmission.from_hash(hash['data']) if hash['data']
+      links = Links.from_hash(hash['links']) if hash['links']
+
+      # Create object from extracted values.
+      DirectDebitSubmissionCreationResponse.new(data,
+                                                links)
+    end
+  end
+end

data/lib/form3_public_api/models/direct_debit_submission_details_response.rb

@@ -0,0 +1,60 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # DirectDebitSubmissionDetailsResponse Model.
+  class DirectDebitSubmissionDetailsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DirectDebitSubmission]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [Links]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = SKIP,
+                   links = SKIP)
+      @data = data unless data == SKIP
+      @links = links unless links == 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.
+      data = DirectDebitSubmission.from_hash(hash['data']) if hash['data']
+      links = Links.from_hash(hash['links']) if hash['links']
+
+      # Create object from extracted values.
+      DirectDebitSubmissionDetailsResponse.new(data,
+                                               links)
+    end
+  end
+end

data/lib/form3_public_api/models/direct_debit_submission_relationships.rb

@@ -0,0 +1,50 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # DirectDebitSubmissionRelationships Model.
+  class DirectDebitSubmissionRelationships < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DirectDebit1]
+    attr_accessor :direct_debit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['direct_debit'] = 'direct_debit'
+      @_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.
+      direct_debit = DirectDebit1.from_hash(hash['direct_debit']) if hash['direct_debit']
+
+      # Create object from extracted values.
+      DirectDebitSubmissionRelationships.new(direct_debit)
+    end
+  end
+end

data/lib/form3_public_api/models/direct_debit_submission_status_enum.rb

@@ -0,0 +1,44 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # DirectDebitSubmissionStatus.
+  class DirectDebitSubmissionStatusEnum
+    DIRECT_DEBIT_SUBMISSION_STATUS_ENUM = [
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'accepted'.freeze,
+
+      # TODO: Write general description for RELEASED_TO_GATEWAY
+      RELEASED_TO_GATEWAY = 'released_to_gateway'.freeze,
+
+      # TODO: Write general description for DELIVERY_CONFIRMED
+      DELIVERY_CONFIRMED = 'delivery_confirmed'.freeze,
+
+      # TODO: Write general description for DELIVERY_FAILED
+      DELIVERY_FAILED = 'delivery_failed'.freeze,
+
+      # TODO: Write general description for SUBMITTED
+      SUBMITTED = 'submitted'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for VALIDATION_PENDING
+      VALIDATION_PENDING = 'validation_pending'.freeze,
+
+      # TODO: Write general description for VALIDATION_PASSED
+      VALIDATION_PASSED = 'validation_passed'.freeze,
+
+      # TODO: Write general description for QUEUED_FOR_DELIVERY
+      QUEUED_FOR_DELIVERY = 'queued_for_delivery'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DIRECT_DEBIT_SUBMISSION_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/direct_debit_with_return.rb

@@ -0,0 +1,61 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # DirectDebitWithReturn Model.
+  class DirectDebitWithReturn < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DirectDebit]
+    attr_accessor :direct_debit
+
+    # TODO: Write general description for this method
+    # @return [DirectDebitReturn]
+    attr_accessor :direct_debit_return
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['direct_debit'] = 'direct_debit'
+      @_hash['direct_debit_return'] = 'direct_debit_return'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        direct_debit
+        direct_debit_return
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(direct_debit = SKIP,
+                   direct_debit_return = SKIP)
+      @direct_debit = direct_debit unless direct_debit == SKIP
+      @direct_debit_return = direct_debit_return unless direct_debit_return == 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.
+      direct_debit = DirectDebit.from_hash(hash['direct_debit']) if hash['direct_debit']
+      direct_debit_return = DirectDebitReturn.from_hash(hash['direct_debit_return']) if
+        hash['direct_debit_return']
+
+      # Create object from extracted values.
+      DirectDebitWithReturn.new(direct_debit,
+                                direct_debit_return)
+    end
+  end
+end

data/lib/form3_public_api/models/disputed_transaction.rb

@@ -0,0 +1,57 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # DisputedTransaction Model.
+  class DisputedTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount
+
+    # TODO: Write general description for this method
+    # @return [Date]
+    attr_accessor :date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['date'] = 'date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil,
+                   date = nil)
+      @amount = amount
+      @date = date
+    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
+      date = hash.key?('date') ? hash['date'] : nil
+
+      # Create object from extracted values.
+      DisputedTransaction.new(amount,
+                              date)
+    end
+  end
+end

data/lib/form3_public_api/models/duplicate_transaction_information.rb

@@ -0,0 +1,86 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # DuplicateTransactionInformation Model.
+  class DuplicateTransactionInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identification, as assigned by the initiating party, to
+    # unambiguously identify the transaction. This identification is passed on,
+    # unchanged, throughout the entire end-to-end chain.
+    # @return [String]
+    attr_accessor :end_to_end_reference
+
+    # Reference for the duplicated payment for this Exception and Investigation
+    # case.
+    # @return [Array[QueryReference]]
+    attr_accessor :references
+
+    # Unique identification, as assigned by the first instructing agent, to
+    # unambiguously identify the transaction that is passed on, unchanged,
+    # throughout the entire interbank chain.
+    # @return [String]
+    attr_accessor :scheme_transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['end_to_end_reference'] = 'end_to_end_reference'
+      @_hash['references'] = 'references'
+      @_hash['scheme_transaction_id'] = 'scheme_transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        end_to_end_reference
+        references
+        scheme_transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(end_to_end_reference = SKIP,
+                   references = SKIP,
+                   scheme_transaction_id = SKIP)
+      @end_to_end_reference = end_to_end_reference unless end_to_end_reference == SKIP
+      @references = references unless references == SKIP
+      @scheme_transaction_id = scheme_transaction_id unless scheme_transaction_id == 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.
+      end_to_end_reference =
+        hash.key?('end_to_end_reference') ? hash['end_to_end_reference'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      references = nil
+      unless hash['references'].nil?
+        references = []
+        hash['references'].each do |structure|
+          references << (QueryReference.from_hash(structure) if structure)
+        end
+      end
+
+      references = SKIP unless hash.key?('references')
+      scheme_transaction_id =
+        hash.key?('scheme_transaction_id') ? hash['scheme_transaction_id'] : SKIP
+
+      # Create object from extracted values.
+      DuplicateTransactionInformation.new(end_to_end_reference,
+                                          references,
+                                          scheme_transaction_id)
+    end
+  end
+end

data/lib/form3_public_api/models/file_format_enum.rb

@@ -0,0 +1,23 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # The format of the file that will be submitted/admitted to Form3
+  class FileFormatEnum
+    FILE_FORMAT_ENUM = [
+      # TODO: Write general description for NDJSON
+      NDJSON = 'ndjson'.freeze,
+
+      # TODO: Write general description for STANDARD18
+      STANDARD18 = 'standard18'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FILE_FORMAT_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/file_type_enum.rb

@@ -0,0 +1,23 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # The file type
+  class FileTypeEnum
+    FILE_TYPE_ENUM = [
+      # TODO: Write general description for SWITCH
+      SWITCH = 'switch'.freeze,
+
+      # TODO: Write general description for ISA
+      ISA = 'ISA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FILE_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/filter_not_relationships1_enum.rb

@@ -0,0 +1,35 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # filter[not_relationships]1.
+  class FilterNotRelationships1Enum
+    FILTER_NOT_RELATIONSHIPS1_ENUM = [
+      # TODO: Write general description for PAYMENT_SUBMISSIONS
+      PAYMENT_SUBMISSIONS = 'payment_submissions'.freeze,
+
+      # TODO: Write general description for PAYMENT_ADMISSIONS
+      PAYMENT_ADMISSIONS = 'payment_admissions'.freeze,
+
+      # TODO: Write general description for REVERSALS
+      REVERSALS = 'reversals'.freeze,
+
+      # TODO: Write general description for RECALLS
+      RECALLS = 'recalls'.freeze,
+
+      # TODO: Write general description for RETURNS
+      RETURNS = 'returns'.freeze,
+
+      # TODO: Write general description for PAYMENT_ADVICES
+      PAYMENT_ADVICES = 'payment_advices'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FILTER_NOT_RELATIONSHIPS1_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/filter_not_relationships_enum.rb

@@ -0,0 +1,35 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # filter[not_relationships].
+  class FilterNotRelationshipsEnum
+    FILTER_NOT_RELATIONSHIPS_ENUM = [
+      # TODO: Write general description for DIRECT_DEBIT_SUBMISSIONS
+      DIRECT_DEBIT_SUBMISSIONS = 'direct_debit_submissions'.freeze,
+
+      # TODO: Write general description for DIRECT_DEBIT_ADMISSIONS
+      DIRECT_DEBIT_ADMISSIONS = 'direct_debit_admissions'.freeze,
+
+      # TODO: Write general description for REVERSALS
+      REVERSALS = 'reversals'.freeze,
+
+      # TODO: Write general description for RECALLS
+      RECALLS = 'recalls'.freeze,
+
+      # TODO: Write general description for RETURNS
+      RETURNS = 'returns'.freeze,
+
+      # TODO: Write general description for DECISIONS
+      DECISIONS = 'decisions'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FILTER_NOT_RELATIONSHIPS_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/filter_relationships1_enum.rb

@@ -0,0 +1,35 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # filter[relationships]1.
+  class FilterRelationships1Enum
+    FILTER_RELATIONSHIPS1_ENUM = [
+      # TODO: Write general description for PAYMENT_SUBMISSIONS
+      PAYMENT_SUBMISSIONS = 'payment_submissions'.freeze,
+
+      # TODO: Write general description for PAYMENT_ADMISSIONS
+      PAYMENT_ADMISSIONS = 'payment_admissions'.freeze,
+
+      # TODO: Write general description for REVERSALS
+      REVERSALS = 'reversals'.freeze,
+
+      # TODO: Write general description for RECALLS
+      RECALLS = 'recalls'.freeze,
+
+      # TODO: Write general description for RETURNS
+      RETURNS = 'returns'.freeze,
+
+      # TODO: Write general description for PAYMENT_ADVICES
+      PAYMENT_ADVICES = 'payment_advices'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FILTER_RELATIONSHIPS1_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/filter_relationships_enum.rb

@@ -0,0 +1,35 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # filter[relationships].
+  class FilterRelationshipsEnum
+    FILTER_RELATIONSHIPS_ENUM = [
+      # TODO: Write general description for DIRECT_DEBIT_SUBMISSIONS
+      DIRECT_DEBIT_SUBMISSIONS = 'direct_debit_submissions'.freeze,
+
+      # TODO: Write general description for DIRECT_DEBIT_ADMISSIONS
+      DIRECT_DEBIT_ADMISSIONS = 'direct_debit_admissions'.freeze,
+
+      # TODO: Write general description for REVERSALS
+      REVERSALS = 'reversals'.freeze,
+
+      # TODO: Write general description for RECALLS
+      RECALLS = 'recalls'.freeze,
+
+      # TODO: Write general description for RETURNS
+      RETURNS = 'returns'.freeze,
+
+      # TODO: Write general description for DECISIONS
+      DECISIONS = 'decisions'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FILTER_RELATIONSHIPS_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/forwarded_payment.rb

@@ -0,0 +1,60 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # ForwardedPayment Model.
+  class ForwardedPayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of Inbound Payments that triggered the creation of this Forwarding
+    # Payment.
+    # @return [Array[RelationshipData]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = SKIP)
+      @data = data unless data == 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
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (RelationshipData.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('data')
+
+      # Create object from extracted values.
+      ForwardedPayment.new(data)
+    end
+  end
+end