packageruby 1.1.1

data/lib/form3_public_api/models/direct_debit_admission_status_reason_enum.rb

@@ -0,0 +1,150 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # DirectDebitAdmissionStatusReason.
+  class DirectDebitAdmissionStatusReasonEnum
+    DIRECT_DEBIT_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 INVALID_TRANSACTION
+      INVALID_TRANSACTION = 'invalid_transaction'.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 PENDING_SETTLEMENT
+      PENDING_SETTLEMENT = 'pending_settlement'.freeze,
+
+      # TODO: Write general description for SETTLEMENT_FAILED
+      SETTLEMENT_FAILED = 'settlement_failed'.freeze,
+
+      # TODO: Write general description for DUPLICATION
+      DUPLICATION = 'duplication'.freeze,
+
+      # TODO: Write general description for NOT_ALLOWED_AMOUNT
+      NOT_ALLOWED_AMOUNT = 'not_allowed_amount'.freeze,
+
+      # TODO: Write general description for MANDATE_CANCELLED
+      MANDATE_CANCELLED = 'mandate_cancelled'.freeze,
+
+      # TODO: Write general description for NO_INSTRUCTION
+      NO_INSTRUCTION = 'no_instruction'.freeze,
+
+      # TODO: Write general description for ACCOUNT_TRANSFERRED_TO_NEW_PSP
+      ACCOUNT_TRANSFERRED_TO_NEW_PSP = 'account_transferred_to_new_psp'.freeze,
+
+      # TODO: Write general description for PAYING_BANK_CANCELLATION
+      PAYING_BANK_CANCELLATION = 'paying_bank_cancellation'.freeze,
+
+      # TODO: Write general description for CANCELLED_BY_PAYER
+      CANCELLED_BY_PAYER = 'cancelled_by_payer'.freeze,
+
+      # TODO: Write general description for PAYER_DECEASED
+      PAYER_DECEASED = 'payer_deceased'.freeze,
+
+      # TODO: Write general description for ACCOUNT_CLOSED
+      ACCOUNT_CLOSED = 'account_closed'.freeze,
+
+      # TODO: Write general description for SCHEME_STATUS_INVALID
+      SCHEME_STATUS_INVALID = 'scheme_status_invalid'.freeze,
+
+      # TODO: Write general description for PENDING_AUTHORISATION_BY_SPONSOR
+      PENDING_AUTHORISATION_BY_SPONSOR = 'pending_authorisation_by_sponsor'.freeze,
+
+      # TODO: Write general description for AUTHORISED_BY_SPONSOR
+      AUTHORISED_BY_SPONSOR = 'authorised_by_sponsor'.freeze,
+
+      # TODO: Write general description for AUTHORISATION_FAILED_BY_SPONSOR
+      AUTHORISATION_FAILED_BY_SPONSOR = 'authorisation_failed_by_sponsor'.freeze,
+
+      # TODO: Write general description for CLOSED_ACCOUNT
+      CLOSED_ACCOUNT = 'closed_account'.freeze,
+
+      # TODO: Write general description for BLOCKED_ACCOUNT
+      BLOCKED_ACCOUNT = 'blocked_account'.freeze,
+
+      # TODO: Write general description for INVALID_DEBTOR_ACCOUNT_TYPE
+      INVALID_DEBTOR_ACCOUNT_TYPE = 'invalid_debtor_account_type'.freeze,
+
+      # TODO: Write general description for TRANSACTION_FORBIDDEN
+      TRANSACTION_FORBIDDEN = 'transaction_forbidden'.freeze,
+
+      # TODO: Write general description for INVALID_BANK_OPERATION_CODE
+      INVALID_BANK_OPERATION_CODE = 'invalid_bank_operation_code'.freeze,
+
+      # TODO: Write general description for INSUFFICIENT_FUNDS
+      INSUFFICIENT_FUNDS = 'insufficient_funds'.freeze,
+
+      # TODO: Write general description for UNRECOGNISED_INITIATING_PARTY
+      UNRECOGNISED_INITIATING_PARTY = 'unrecognised_initiating_party'.freeze,
+
+      # TODO: Write general description for
+      # CREDITOR_BANK_NOT_REGISTERED_UNDER_BIC
+      CREDITOR_BANK_NOT_REGISTERED_UNDER_BIC = 'creditor_bank_not_registered_under_bic'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_DEBTOR_BANK_NOT_REGISTERED_UNDER_BIC
+      ENUM_DEBTOR_BANK_NOT_REGISTERED_UNDER_BIC = 'debtor_bank_not registered_under_bic'.freeze,
+
+      # TODO: Write general description for OPERATION_CODE_INCORRECT
+      OPERATION_CODE_INCORRECT = 'operation_code_incorrect'.freeze,
+
+      # TODO: Write general description for UNAUTHORISED_TRANSACTION
+      UNAUTHORISED_TRANSACTION = 'unauthorised_transaction'.freeze,
+
+      # TODO: Write general description for
+      # MISSING_MANDATORY_MANDATE_INFORMATION
+      MISSING_MANDATORY_MANDATE_INFORMATION = 'missing_mandatory_mandate_information'.freeze,
+
+      # TODO: Write general description for END_CUSTOMER_DECEASED
+      END_CUSTOMER_DECEASED = 'end_customer_deceased'.freeze,
+
+      # TODO: Write general description for NOT_SPECIFIED_REASON_CUSTOMER
+      NOT_SPECIFIED_REASON_CUSTOMER = 'not_specified_reason_customer'.freeze,
+
+      # TODO: Write general description for NOT_SPECIFIED_REASON_AGENT
+      NOT_SPECIFIED_REASON_AGENT = 'not_specified_reason_agent'.freeze,
+
+      # TODO: Write general description for BANK_IDENTIFIER_INCORRECT
+      BANK_IDENTIFIER_INCORRECT = 'bank_identifier_incorrect'.freeze,
+
+      # TODO: Write general description for MISSING_DEBTOR_ACCOUNT
+      MISSING_DEBTOR_ACCOUNT = 'missing_debtor_account'.freeze,
+
+      # TODO: Write general description for MISSING_DEBTOR_NAME_OR_ADDRESS
+      MISSING_DEBTOR_NAME_OR_ADDRESS = 'missing_debtor_name_or_address'.freeze,
+
+      # TODO: Write general description for MISSING_CREDITOR_NAME_OR_ADDRESS
+      MISSING_CREDITOR_NAME_OR_ADDRESS = 'missing_creditor_name_or_address'.freeze,
+
+      # TODO: Write general description for REGULATORY_REASON
+      REGULATORY_REASON = 'regulatory_reason'.freeze,
+
+      # TODO: Write general description for
+      # SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_BANK
+      SPECIFIC_SERVICE_OFFERED_BY_DEBTOR_BANK = 'specific_service_offered_by_debtor_bank'.freeze,
+
+      # TODO: Write general description for RECALLED_BY_ORIGINATOR
+      RECALLED_BY_ORIGINATOR = 'recalled_by_originator'.freeze,
+
+      # TODO: Write general description for UNKNOWN_STATUS_REASON
+      UNKNOWN_STATUS_REASON = 'unknown_status_reason'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DIRECT_DEBIT_ADMISSION_STATUS_REASON_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/direct_debit_creation.rb

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

data/lib/form3_public_api/models/direct_debit_creation_response.rb

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

data/lib/form3_public_api/models/direct_debit_decision.rb

@@ -0,0 +1,135 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # DirectDebitDecision Model.
+  class DirectDebitDecision < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Attributes25]
+    attr_accessor :attributes
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # Unique resource ID
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Unique resource ID
+    # @return [DateTime]
+    attr_accessor :modified_on
+
+    # Unique ID of the organisation this resource is created by
+    # @return [UUID | String]
+    attr_accessor :organisation_id
+
+    # Unique ID of the organisation this resource is created by
+    # @return [Relationships5]
+    attr_accessor :relationships
+
+    # Name of the resource type
+    # @return [String]
+    attr_accessor :type
+
+    # Version number
+    # @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[
+        created_on
+        modified_on
+        relationships
+        type
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(attributes = nil,
+                   id = nil,
+                   organisation_id = nil,
+                   created_on = SKIP,
+                   modified_on = SKIP,
+                   relationships = SKIP,
+                   type = SKIP,
+                   version = SKIP)
+      @attributes = attributes
+      @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.
+      attributes = Attributes25.from_hash(hash['attributes']) if hash['attributes']
+      id = hash.key?('id') ? hash['id'] : nil
+      organisation_id =
+        hash.key?('organisation_id') ? hash['organisation_id'] : nil
+      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 = Relationships5.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.
+      DirectDebitDecision.new(attributes,
+                              id,
+                              organisation_id,
+                              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/direct_debit_decision2.rb

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

data/lib/form3_public_api/models/direct_debit_decision_admission.rb

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

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

data/lib/form3_public_api/models/direct_debit_decision_admission_creation.rb

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