packageruby 1.1.1

data/lib/form3_public_api/models/mandate_admission.rb

@@ -0,0 +1,139 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # MandateAdmission Model.
+  class MandateAdmission < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Attributes45]
+    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 [MandateAdmissionRelationships]
+    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
+        id
+        modified_on
+        organisation_id
+        relationships
+        type
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(attributes = SKIP,
+                   created_on = SKIP,
+                   id = SKIP,
+                   modified_on = SKIP,
+                   organisation_id = SKIP,
+                   relationships = SKIP,
+                   type = SKIP,
+                   version = SKIP)
+      @attributes = attributes unless attributes == SKIP
+      @created_on = created_on unless created_on == SKIP
+      @id = id unless id == SKIP
+      @modified_on = modified_on unless modified_on == SKIP
+      @organisation_id = organisation_id unless organisation_id == SKIP
+      @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.
+      attributes = Attributes45.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
+      id = hash.key?('id') ? hash['id'] : SKIP
+      modified_on = if hash.key?('modified_on')
+                      (DateTimeHelper.from_rfc3339(hash['modified_on']) if hash['modified_on'])
+                    else
+                      SKIP
+                    end
+      organisation_id =
+        hash.key?('organisation_id') ? hash['organisation_id'] : SKIP
+      relationships = MandateAdmissionRelationships.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.
+      MandateAdmission.new(attributes,
+                           created_on,
+                           id,
+                           modified_on,
+                           organisation_id,
+                           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/mandate_admission2.rb

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

data/lib/form3_public_api/models/mandate_admission_details_response.rb

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

data/lib/form3_public_api/models/mandate_admission_relationships.rb

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

data/lib/form3_public_api/models/mandate_admission_status_enum.rb

@@ -0,0 +1,23 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # MandateAdmissionStatus.
+  class MandateAdmissionStatusEnum
+    MANDATE_ADMISSION_STATUS_ENUM = [
+      # TODO: Write general description for CONFIRMED
+      CONFIRMED = 'confirmed'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MANDATE_ADMISSION_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/mandate_admission_status_reason_enum.rb

@@ -0,0 +1,51 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # MandateAdmissionStatusReason.
+  class MandateAdmissionStatusReasonEnum
+    MANDATE_ADMISSION_STATUS_REASON_ENUM = [
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'accepted'.freeze,
+
+      # TODO: Write general description for INVALID_BENEFICIARY_DETAILS
+      INVALID_BENEFICIARY_DETAILS = 'invalid_beneficiary_details'.freeze,
+
+      # TODO: Write general description for BANKID_NOT_PROVISIONED
+      BANKID_NOT_PROVISIONED = 'bankid_not_provisioned'.freeze,
+
+      # TODO: Write general description for UNKNOWN_ACCOUNTNUMBER
+      UNKNOWN_ACCOUNTNUMBER = 'unknown_accountnumber'.freeze,
+
+      # TODO: Write general description for MANDATE_CANCELLED
+      MANDATE_CANCELLED = 'mandate_cancelled'.freeze,
+
+      # TODO: Write general description for MANDATE_EXPIRED
+      MANDATE_EXPIRED = 'mandate_expired'.freeze,
+
+      # TODO: Write general description for MANDATE_FAILED
+      MANDATE_FAILED = 'mandate_failed'.freeze,
+
+      # TODO: Write general description for UNKNOWN_INSTRUCTION
+      UNKNOWN_INSTRUCTION = 'unknown_instruction'.freeze,
+
+      # TODO: Write general description for PAYER_REFERENCE_NOT_UNIQUE
+      PAYER_REFERENCE_NOT_UNIQUE = 'payer_reference_not_unique'.freeze,
+
+      # TODO: Write general description for INVALID_REFERENCE
+      INVALID_REFERENCE = 'invalid_reference'.freeze,
+
+      # TODO: Write general description for
+      # NOT_ELIGIBLE_FOR_REINSTATEMENT_BY_ORIGINATOR
+      NOT_ELIGIBLE_FOR_REINSTATEMENT_BY_ORIGINATOR = 'not_eligible_for_reinstatement_by_originator'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MANDATE_ADMISSION_STATUS_REASON_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/mandate_amendment.rb

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

data/lib/form3_public_api/models/mandate_attributes.rb

@@ -0,0 +1,208 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # MandateAttributes Model.
+  class MandateAttributes < 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 [MandateAttributesBeneficiaryParty]
+    attr_accessor :beneficiary_party
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :clearing_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :currency
+
+    # TODO: Write general description for this method
+    # @return [MandateAttributesDebtorParty]
+    attr_accessor :debtor_party
+
+    # TODO: Write general description for this method
+    # @return [MandateFrequencyEnum]
+    attr_accessor :frequency
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :numeric_reference
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payment_scheme
+
+    # TODO: Write general description for this method
+    # @return [Date]
+    attr_accessor :processing_date
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reference
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :scheme_payment_type
+
+    # TODO: Write general description for this method
+    # @return [Date]
+    attr_accessor :scheme_processing_date
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :source
+
+    # TODO: Write general description for this method
+    # @return [MandateStatusEnum]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status_reason
+
+    # TODO: Write general description for this method
+    # @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['beneficiary_party'] = 'beneficiary_party'
+      @_hash['clearing_id'] = 'clearing_id'
+      @_hash['currency'] = 'currency'
+      @_hash['debtor_party'] = 'debtor_party'
+      @_hash['frequency'] = 'frequency'
+      @_hash['numeric_reference'] = 'numeric_reference'
+      @_hash['payment_scheme'] = 'payment_scheme'
+      @_hash['processing_date'] = 'processing_date'
+      @_hash['reference'] = 'reference'
+      @_hash['scheme_payment_type'] = 'scheme_payment_type'
+      @_hash['scheme_processing_date'] = 'scheme_processing_date'
+      @_hash['source'] = 'source'
+      @_hash['status'] = 'status'
+      @_hash['status_reason'] = 'status_reason'
+      @_hash['unique_scheme_id'] = 'unique_scheme_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        beneficiary_party
+        clearing_id
+        currency
+        debtor_party
+        frequency
+        numeric_reference
+        payment_scheme
+        processing_date
+        reference
+        scheme_payment_type
+        scheme_processing_date
+        source
+        status
+        status_reason
+        unique_scheme_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = SKIP,
+                   beneficiary_party = SKIP,
+                   clearing_id = SKIP,
+                   currency = SKIP,
+                   debtor_party = SKIP,
+                   frequency = SKIP,
+                   numeric_reference = SKIP,
+                   payment_scheme = SKIP,
+                   processing_date = SKIP,
+                   reference = SKIP,
+                   scheme_payment_type = SKIP,
+                   scheme_processing_date = SKIP,
+                   source = SKIP,
+                   status = SKIP,
+                   status_reason = SKIP,
+                   unique_scheme_id = SKIP)
+      @amount = amount unless amount == SKIP
+      @beneficiary_party = beneficiary_party unless beneficiary_party == SKIP
+      @clearing_id = clearing_id unless clearing_id == SKIP
+      @currency = currency unless currency == SKIP
+      @debtor_party = debtor_party unless debtor_party == SKIP
+      @frequency = frequency unless frequency == SKIP
+      @numeric_reference = numeric_reference unless numeric_reference == SKIP
+      @payment_scheme = payment_scheme unless payment_scheme == SKIP
+      @processing_date = processing_date unless processing_date == SKIP
+      @reference = reference unless reference == SKIP
+      @scheme_payment_type = scheme_payment_type unless scheme_payment_type == SKIP
+      @scheme_processing_date = scheme_processing_date unless scheme_processing_date == SKIP
+      @source = source unless source == SKIP
+      @status = status unless status == SKIP
+      @status_reason = status_reason unless status_reason == 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
+      beneficiary_party = MandateAttributesBeneficiaryParty.from_hash(hash['beneficiary_party']) if
+        hash['beneficiary_party']
+      clearing_id = hash.key?('clearing_id') ? hash['clearing_id'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      debtor_party = MandateAttributesDebtorParty.from_hash(hash['debtor_party']) if
+        hash['debtor_party']
+      frequency = hash.key?('frequency') ? hash['frequency'] : SKIP
+      numeric_reference =
+        hash.key?('numeric_reference') ? hash['numeric_reference'] : SKIP
+      payment_scheme =
+        hash.key?('payment_scheme') ? hash['payment_scheme'] : SKIP
+      processing_date =
+        hash.key?('processing_date') ? hash['processing_date'] : SKIP
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      scheme_payment_type =
+        hash.key?('scheme_payment_type') ? hash['scheme_payment_type'] : SKIP
+      scheme_processing_date =
+        hash.key?('scheme_processing_date') ? hash['scheme_processing_date'] : SKIP
+      source = hash.key?('source') ? hash['source'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_reason = hash.key?('status_reason') ? hash['status_reason'] : SKIP
+      unique_scheme_id =
+        hash.key?('unique_scheme_id') ? hash['unique_scheme_id'] : SKIP
+
+      # Create object from extracted values.
+      MandateAttributes.new(amount,
+                            beneficiary_party,
+                            clearing_id,
+                            currency,
+                            debtor_party,
+                            frequency,
+                            numeric_reference,
+                            payment_scheme,
+                            processing_date,
+                            reference,
+                            scheme_payment_type,
+                            scheme_processing_date,
+                            source,
+                            status,
+                            status_reason,
+                            unique_scheme_id)
+    end
+  end
+end