packageruby 1.1.1

data/lib/form3_public_api/models/payment_admission_status_reason_enum.rb

@@ -0,0 +1,152 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # [Payment admission status
+  # reason](https://api-docs.form3.tech/api.html#enumerations-payment-status-cod
+  # es-payment-admission-status-reasons)
+  class PaymentAdmissionStatusReasonEnum
+    PAYMENT_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 CUSTOMER_CHECK_FAILED
+      CUSTOMER_CHECK_FAILED = 'customer_check_failed'.freeze,
+
+      # TODO: Write general description for SCHEME_TIMEOUT
+      SCHEME_TIMEOUT = 'scheme_timeout'.freeze,
+
+      # TODO: Write general description for INCORRECT_REFERENCE_VALIDATION_TYPE
+      INCORRECT_REFERENCE_VALIDATION_TYPE = 'incorrect_reference_validation_type'.freeze,
+
+      # TODO: Write general description for
+      # INCORRECT_REFERENCE_SECONDARY_IDENTIFICATION
+      INCORRECT_REFERENCE_SECONDARY_IDENTIFICATION = 'incorrect_reference_secondary_identification'.freeze,
+
+      # TODO: Write general description for INCORRECT_REFERENCE_REFERENCE_MASK
+      INCORRECT_REFERENCE_REFERENCE_MASK = 'incorrect_reference_reference_mask'.freeze,
+
+      # TODO: Write general description for ACCOUNT_CLOSED
+      ACCOUNT_CLOSED = 'account_closed'.freeze,
+
+      # TODO: Write general description for ACCOUNT_CLOSED_BUSINESS_REASONS
+      ACCOUNT_CLOSED_BUSINESS_REASONS = 'account_closed_business_reasons'.freeze,
+
+      # TODO: Write general description for ACCOUNT_CLOSED_STOPPED
+      ACCOUNT_CLOSED_STOPPED = 'account_closed_stopped'.freeze,
+
+      # TODO: Write general description for ACCOUNT_CLOSED_CURRENCY
+      ACCOUNT_CLOSED_CURRENCY = 'account_closed_currency'.freeze,
+
+      # TODO: Write general description for ACCOUNT_CLOSED_TRANSFERRED
+      ACCOUNT_CLOSED_TRANSFERRED = 'account_closed_transferred'.freeze,
+
+      # TODO: Write general description for ACCOUNT_CLOSED_BENEFICIARY_DECEASED
+      ACCOUNT_CLOSED_BENEFICIARY_DECEASED = 'account_closed_beneficiary_deceased'.freeze,
+
+      # TODO: Write general description for
+      # ACCOUNT_CLOSED_BENEFICIARY_SENSITIVITIES
+      ACCOUNT_CLOSED_BENEFICIARY_SENSITIVITIES = 'account_closed_beneficiary_sensitivities'.freeze,
+
+      # TODO: Write general description for ACCOUNT_CLOSED_TERMS_AND_CONDITIONS
+      ACCOUNT_CLOSED_TERMS_AND_CONDITIONS = 'account_closed_terms_and_conditions'.freeze,
+
+      # TODO: Write general description for
+      # BENEFICIARY_AGENT_CLEARING_PROCESS_TIMEOUT
+      BENEFICIARY_AGENT_CLEARING_PROCESS_TIMEOUT = 'beneficiary_agent_clearing_process_timeout'.freeze,
+
+      # TODO: Write general description for AGENT_CLEARING_PROCESS_TIMEOUT
+      AGENT_CLEARING_PROCESS_TIMEOUT = 'agent_clearing_process_timeout'.freeze,
+
+      # TODO: Write general description for AGENT_UNAVAILABLE
+      AGENT_UNAVAILABLE = 'agent_unavailable'.freeze,
+
+      # TODO: Write general description for BENEFICIARY_AGENT_UNAVAILABLE
+      BENEFICIARY_AGENT_UNAVAILABLE = 'beneficiary_agent_unavailable'.freeze,
+
+      # TODO: Write general description for
+      # BENEFICIARY_AGENT_CLEARING_PROCESS_ERROR
+      BENEFICIARY_AGENT_CLEARING_PROCESS_ERROR = 'beneficiary_agent_clearing_process_error'.freeze,
+
+      # TODO: Write general description for AGENT_CLEARING_PROCESS_ERROR
+      AGENT_CLEARING_PROCESS_ERROR = 'agent_clearing_process_error'.freeze,
+
+      # TODO: Write general description for BLOCKED_ACCOUNT
+      BLOCKED_ACCOUNT = 'blocked_account'.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 ORIGINAL_PAYMENT_NOT_RECEIVED
+      ORIGINAL_PAYMENT_NOT_RECEIVED = 'original_payment_not_received'.freeze,
+
+      # TODO: Write general description for AGENT_SUSPENDED
+      AGENT_SUSPENDED = 'agent_suspended'.freeze,
+
+      # TODO: Write general description for BENEFICIARY_AGENT_SUSPENDED
+      BENEFICIARY_AGENT_SUSPENDED = 'beneficiary_agent_suspended'.freeze,
+
+      # TODO: Write general description for AMOUNT_NOT_ALLOWED
+      AMOUNT_NOT_ALLOWED = 'amount_not_allowed'.freeze,
+
+      # TODO: Write general description for DUPLICATE_PAYMENT
+      DUPLICATE_PAYMENT = 'duplicate_payment'.freeze,
+
+      # TODO: Write general description for AMOUNT_EXCEEDS_SETTLEMENT_LIMIT
+      AMOUNT_EXCEEDS_SETTLEMENT_LIMIT = 'amount_exceeds_settlement_limit'.freeze,
+
+      # TODO: Write general description for INVALID_BENEFICIARY_ADDRESS
+      INVALID_BENEFICIARY_ADDRESS = 'invalid_beneficiary_address'.freeze,
+
+      # TODO: Write general description for INVALID_BENEFICIARY_AGENT_BIC
+      INVALID_BENEFICIARY_AGENT_BIC = 'invalid_beneficiary_agent_BIC'.freeze,
+
+      # TODO: Write general description for INVALID_DEBTOR_AGENT_BIC
+      INVALID_DEBTOR_AGENT_BIC = 'invalid_debtor_agent_BIC'.freeze,
+
+      # TODO: Write general description for CUSTOMER_REASON_UNKNOWN
+      CUSTOMER_REASON_UNKNOWN = 'customer_reason_unknown'.freeze,
+
+      # TODO: Write general description for AGENT_REASON_UNKNOWN
+      AGENT_REASON_UNKNOWN = 'agent_reason_unknown'.freeze,
+
+      # TODO: Write general description for INVALID_BANK_ID
+      INVALID_BANK_ID = 'invalid_bank_ID'.freeze,
+
+      # TODO: Write general description for INVALID_DEBTOR_DETAILS
+      INVALID_DEBTOR_DETAILS = 'invalid_debtor_details'.freeze,
+
+      # TODO: Write general description for REGULATORY_REASON
+      REGULATORY_REASON = 'regulatory_reason'.freeze,
+
+      # TODO: Write general description for AMOUNT_INVALID_OR_MISSING
+      AMOUNT_INVALID_OR_MISSING = 'amount_invalid_or_missing'.freeze,
+
+      # TODO: Write general description for END_TO_END_ID_MISSING_OR_INVALID
+      END_TO_END_ID_MISSING_OR_INVALID = 'end_to_end_id_missing_or_invalid'.freeze,
+
+      # TODO: Write general description for TRANSACTION_TYPE_NOT_SUPPORTED
+      TRANSACTION_TYPE_NOT_SUPPORTED = 'transaction_type_not_supported'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_ADMISSION_STATUS_REASON_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/payment_admission_task.rb

@@ -0,0 +1,139 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # PaymentAdmissionTask Model.
+  class PaymentAdmissionTask < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Attributes7]
+    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
+
+    # 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 [PaymentAdmissionTaskRelationships]
+    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[
+        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 = Attributes7.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 = PaymentAdmissionTaskRelationships.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.
+      PaymentAdmissionTask.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/payment_admission_task_amendment.rb

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

data/lib/form3_public_api/models/payment_admission_task_assignee_enum.rb

@@ -0,0 +1,23 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Helps to identify the owner of the task
+  class PaymentAdmissionTaskAssigneeEnum
+    PAYMENT_ADMISSION_TASK_ASSIGNEE_ENUM = [
+      # TODO: Write general description for CUSTOMER
+      CUSTOMER = 'customer'.freeze,
+
+      # TODO: Write general description for FORM3
+      FORM3 = 'form3'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_ADMISSION_TASK_ASSIGNEE_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/payment_admission_task_details_response.rb

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

data/lib/form3_public_api/models/payment_admission_task_list_response.rb

@@ -0,0 +1,69 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # PaymentAdmissionTaskListResponse Model.
+  class PaymentAdmissionTaskListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[PaymentAdmissionTask]]
+    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.
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (PaymentAdmissionTask.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('data')
+      links = Links.from_hash(hash['links']) if hash['links']
+
+      # Create object from extracted values.
+      PaymentAdmissionTaskListResponse.new(data,
+                                           links)
+    end
+  end
+end

data/lib/form3_public_api/models/payment_admission_task_relationships.rb

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

data/lib/form3_public_api/models/payment_admission_task_status_enum.rb

@@ -0,0 +1,29 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # status of the task
+  class PaymentAdmissionTaskStatusEnum
+    PAYMENT_ADMISSION_TASK_STATUS_ENUM = [
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for ON_HOLD
+      ON_HOLD = 'on_hold'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PAYMENT_ADMISSION_TASK_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/payment_admission_task_update.rb

@@ -0,0 +1,91 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # PaymentAdmissionTaskUpdate Model.
+  class PaymentAdmissionTaskUpdate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Attributes53]
+    attr_accessor :attributes
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # 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 [Type9Enum]
+    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['id'] = 'id'
+      @_hash['organisation_id'] = 'organisation_id'
+      @_hash['type'] = 'type'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        attributes
+        id
+        organisation_id
+        type
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(attributes = SKIP,
+                   id = SKIP,
+                   organisation_id = SKIP,
+                   type = SKIP,
+                   version = SKIP)
+      @attributes = attributes unless attributes == SKIP
+      @id = id unless id == SKIP
+      @organisation_id = organisation_id unless organisation_id == 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 = Attributes53.from_hash(hash['attributes']) if hash['attributes']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      organisation_id =
+        hash.key?('organisation_id') ? hash['organisation_id'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      version = hash.key?('version') ? hash['version'] : SKIP
+
+      # Create object from extracted values.
+      PaymentAdmissionTaskUpdate.new(attributes,
+                                     id,
+                                     organisation_id,
+                                     type,
+                                     version)
+    end
+  end
+end