packageruby 1.1.1

data/lib/form3_public_api/models/claim_reversal_submission_relationships.rb

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

data/lib/form3_public_api/models/claim_submission.rb

@@ -0,0 +1,137 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # ClaimSubmission Model.
+  class ClaimSubmission < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Attributes22]
+    attr_accessor :attributes
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :modified_on
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :organisation_id
+
+    # TODO: Write general description for this method
+    # @return [ClaimSubmissionRelationships]
+    attr_accessor :relationships
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['attributes'] = 'attributes'
+      @_hash['created_on'] = 'created_on'
+      @_hash['id'] = 'id'
+      @_hash['modified_on'] = 'modified_on'
+      @_hash['organisation_id'] = 'organisation_id'
+      @_hash['relationships'] = 'relationships'
+      @_hash['type'] = 'type'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        attributes
+        created_on
+        modified_on
+        relationships
+        type
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   organisation_id = nil,
+                   attributes = SKIP,
+                   created_on = SKIP,
+                   modified_on = SKIP,
+                   relationships = SKIP,
+                   type = SKIP,
+                   version = SKIP)
+      @attributes = attributes unless attributes == SKIP
+      @created_on = created_on unless created_on == SKIP
+      @id = id
+      @modified_on = modified_on unless modified_on == SKIP
+      @organisation_id = organisation_id
+      @relationships = relationships unless relationships == SKIP
+      @type = type unless type == SKIP
+      @version = version unless version == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      organisation_id =
+        hash.key?('organisation_id') ? hash['organisation_id'] : nil
+      attributes = Attributes22.from_hash(hash['attributes']) if hash['attributes']
+      created_on = if hash.key?('created_on')
+                     (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
+                   else
+                     SKIP
+                   end
+      modified_on = if hash.key?('modified_on')
+                      (DateTimeHelper.from_rfc3339(hash['modified_on']) if hash['modified_on'])
+                    else
+                      SKIP
+                    end
+      relationships = ClaimSubmissionRelationships.from_hash(hash['relationships']) if
+        hash['relationships']
+      type = hash.key?('type') ? hash['type'] : SKIP
+      version = hash.key?('version') ? hash['version'] : SKIP
+
+      # Create object from extracted values.
+      ClaimSubmission.new(id,
+                          organisation_id,
+                          attributes,
+                          created_on,
+                          modified_on,
+                          relationships,
+                          type,
+                          version)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+
+    def to_custom_modified_on
+      DateTimeHelper.to_rfc3339(modified_on)
+    end
+  end
+end

data/lib/form3_public_api/models/claim_submission2.rb

@@ -0,0 +1,59 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # ClaimSubmission2 Model.
+  class ClaimSubmission2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ClaimSubmission]]
+    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 << (ClaimSubmission.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('data')
+
+      # Create object from extracted values.
+      ClaimSubmission2.new(data)
+    end
+  end
+end

data/lib/form3_public_api/models/claim_submission_creation.rb

@@ -0,0 +1,48 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # ClaimSubmissionCreation Model.
+  class ClaimSubmissionCreation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ClaimSubmission]
+    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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = nil)
+      @data = data
+    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 = ClaimSubmission.from_hash(hash['data']) if hash['data']
+
+      # Create object from extracted values.
+      ClaimSubmissionCreation.new(data)
+    end
+  end
+end

data/lib/form3_public_api/models/claim_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
+  # ClaimSubmissionDetailsResponse Model.
+  class ClaimSubmissionDetailsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ClaimSubmission]
+    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 = ClaimSubmission.from_hash(hash['data']) if hash['data']
+      links = Links.from_hash(hash['links']) if hash['links']
+
+      # Create object from extracted values.
+      ClaimSubmissionDetailsResponse.new(data,
+                                         links)
+    end
+  end
+end

data/lib/form3_public_api/models/claim_submission_relationships.rb

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

data/lib/form3_public_api/models/claim_submission_status_enum.rb

@@ -0,0 +1,41 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # ClaimSubmissionStatus.
+  class ClaimSubmissionStatusEnum
+    CLAIM_SUBMISSION_STATUS_ENUM = [
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'accepted'.freeze,
+
+      # TODO: Write general description for VALIDATION_FAILED
+      VALIDATION_FAILED = 'validation_failed'.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 RELEASED_TO_GATEWAY
+      RELEASED_TO_GATEWAY = 'released_to_gateway'.freeze,
+
+      # TODO: Write general description for QUEUED_FOR_DELIVERY
+      QUEUED_FOR_DELIVERY = 'queued_for_delivery'.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
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CLAIM_SUBMISSION_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/clearing_channel_enum.rb

@@ -0,0 +1,26 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Answer to the recall request. Can either be `MPNS`, `RTGS` or `RTNS`.
+  class ClearingChannelEnum
+    CLEARING_CHANNEL_ENUM = [
+      # TODO: Write general description for MPNS
+      MPNS = 'MPNS'.freeze,
+
+      # TODO: Write general description for RTGS
+      RTGS = 'RTGS'.freeze,
+
+      # TODO: Write general description for RTNS
+      RTNS = 'RTNS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CLEARING_CHANNEL_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/correction_transaction_information.rb

@@ -0,0 +1,144 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # References a transaction initiated to fix the case under investigation.
+  class CorrectionTransactionInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of money moved between the instructing agent and the instructed
+    # agent.
+    # @return [String]
+    attr_accessor :amount
+
+    # Currency of the transaction amount. Currency code as defined in [ISO
+    # 4217](https://www.iso.org/iso/home/standards/currency_codes.htm)
+    # @return [String]
+    attr_accessor :currency
+
+    # 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
+
+    # Unique identification, as assigned by an instructing party for an
+    # instructed party, to unambiguously identify the instruction.
+    # @return [String]
+    attr_accessor :instruction_id
+
+    # Date on which the amount of money ceases to be available to the agent that
+    # owes it and when the amount of money becomes available to the agent to
+    # which it is due.
+    # @return [Date]
+    attr_accessor :processing_date
+
+    # Reference for the corrective payment for this query 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
+
+    # The scheme-specific unique transaction ID to unambiguously identify the
+    # message. Populated by the scheme.
+    # @return [String]
+    attr_accessor :unique_scheme_id
+
+    # 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_to_end_reference'] = 'end_to_end_reference'
+      @_hash['instruction_id'] = 'instruction_id'
+      @_hash['processing_date'] = 'processing_date'
+      @_hash['references'] = 'references'
+      @_hash['scheme_transaction_id'] = 'scheme_transaction_id'
+      @_hash['unique_scheme_id'] = 'unique_scheme_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        currency
+        end_to_end_reference
+        instruction_id
+        processing_date
+        references
+        scheme_transaction_id
+        unique_scheme_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = SKIP,
+                   currency = SKIP,
+                   end_to_end_reference = SKIP,
+                   instruction_id = SKIP,
+                   processing_date = SKIP,
+                   references = SKIP,
+                   scheme_transaction_id = SKIP,
+                   unique_scheme_id = SKIP)
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == SKIP
+      @end_to_end_reference = end_to_end_reference unless end_to_end_reference == SKIP
+      @instruction_id = instruction_id unless instruction_id == SKIP
+      @processing_date = processing_date unless processing_date == SKIP
+      @references = references unless references == SKIP
+      @scheme_transaction_id = scheme_transaction_id unless scheme_transaction_id == SKIP
+      @unique_scheme_id = unique_scheme_id unless unique_scheme_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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      end_to_end_reference =
+        hash.key?('end_to_end_reference') ? hash['end_to_end_reference'] : SKIP
+      instruction_id =
+        hash.key?('instruction_id') ? hash['instruction_id'] : SKIP
+      processing_date =
+        hash.key?('processing_date') ? hash['processing_date'] : 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
+      unique_scheme_id =
+        hash.key?('unique_scheme_id') ? hash['unique_scheme_id'] : SKIP
+
+      # Create object from extracted values.
+      CorrectionTransactionInformation.new(amount,
+                                           currency,
+                                           end_to_end_reference,
+                                           instruction_id,
+                                           processing_date,
+                                           references,
+                                           scheme_transaction_id,
+                                           unique_scheme_id)
+    end
+  end
+end

data/lib/form3_public_api/models/credential.rb

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