packageruby 1.1.1

data/lib/form3_public_api/models/attributes25.rb

@@ -0,0 +1,72 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Attributes25 Model.
+  class Attributes25 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Answer to direct debit request. Only `rejected` can be used.
+    # @return [AnswerEnum]
+    attr_accessor :answer
+
+    # Free text reason in addition to `reason_code`. Maximum length 105
+    # characters for both inbound and outbound direct debit decisions.
+    # @return [String]
+    attr_accessor :reason
+
+    # Reason for a rejected decision. Required when answer is rejected, ignored
+    # otherwise. Has to be a valid SEPA direct debit decision reason code.
+    # @return [String]
+    attr_accessor :reason_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['answer'] = 'answer'
+      @_hash['reason'] = 'reason'
+      @_hash['reason_code'] = 'reason_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        answer
+        reason
+        reason_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(answer = SKIP,
+                   reason = SKIP,
+                   reason_code = SKIP)
+      @answer = answer unless answer == SKIP
+      @reason = reason unless reason == SKIP
+      @reason_code = reason_code unless reason_code == 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.
+      answer = hash.key?('answer') ? hash['answer'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      reason_code = hash.key?('reason_code') ? hash['reason_code'] : SKIP
+
+      # Create object from extracted values.
+      Attributes25.new(answer,
+                       reason,
+                       reason_code)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes26.rb

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

data/lib/form3_public_api/models/attributes27.rb

@@ -0,0 +1,101 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # Attributes27 Model.
+  class Attributes27 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates if the submission was created automatically by the system
+    # (`true`) or manually (`false`).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto
+
+    # Scheme-specific status (if submission has been submitted to a scheme)
+    # @return [String]
+    attr_accessor :scheme_status_code
+
+    # Scheme-specific status (if submission has been submitted to a scheme)
+    # @return [DirectDebitDecisionSubmissionStatusEnum]
+    attr_accessor :status
+
+    # Reason for submission failure if status is `delivery_failed`
+    # @return [String]
+    attr_accessor :status_reason
+
+    # Date and time of the submission
+    # @return [DateTime]
+    attr_accessor :submission_datetime
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto'] = 'auto'
+      @_hash['scheme_status_code'] = 'scheme_status_code'
+      @_hash['status'] = 'status'
+      @_hash['status_reason'] = 'status_reason'
+      @_hash['submission_datetime'] = 'submission_datetime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auto
+        scheme_status_code
+        status
+        status_reason
+        submission_datetime
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auto = false,
+                   scheme_status_code = SKIP,
+                   status = SKIP,
+                   status_reason = SKIP,
+                   submission_datetime = SKIP)
+      @auto = auto unless auto == SKIP
+      @scheme_status_code = scheme_status_code unless scheme_status_code == SKIP
+      @status = status unless status == SKIP
+      @status_reason = status_reason unless status_reason == SKIP
+      @submission_datetime = submission_datetime unless submission_datetime == 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.
+      auto = hash['auto'] ||= false
+      scheme_status_code =
+        hash.key?('scheme_status_code') ? hash['scheme_status_code'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_reason = hash.key?('status_reason') ? hash['status_reason'] : SKIP
+      submission_datetime = if hash.key?('submission_datetime')
+                              (DateTimeHelper.from_rfc3339(hash['submission_datetime']) if hash['submission_datetime'])
+                            else
+                              SKIP
+                            end
+
+      # Create object from extracted values.
+      Attributes27.new(auto,
+                       scheme_status_code,
+                       status,
+                       status_reason,
+                       submission_datetime)
+    end
+
+    def to_custom_submission_datetime
+      DateTimeHelper.to_rfc3339(submission_datetime)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes29.rb

@@ -0,0 +1,91 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # Attributes29 Model.
+  class Attributes29 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date and time the recall admission was created
+    # @return [DateTime]
+    attr_accessor :admission_datetime
+
+    # Date and time the recall admission was created
+    # @return [String]
+    attr_accessor :source_gateway
+
+    # [Status](http://draft-api-docs.form3.tech/api.html#enumerations-payment-ad
+    # mission-status) of the recall admission
+    # @return [DirectDebitRecallAdmissionStatusEnum]
+    attr_accessor :status
+
+    # Human-readable reason for failure if admission status is failed
+    # @return [String]
+    attr_accessor :status_reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['admission_datetime'] = 'admission_datetime'
+      @_hash['source_gateway'] = 'source_gateway'
+      @_hash['status'] = 'status'
+      @_hash['status_reason'] = 'status_reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        admission_datetime
+        source_gateway
+        status
+        status_reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(admission_datetime = SKIP,
+                   source_gateway = SKIP,
+                   status = SKIP,
+                   status_reason = SKIP)
+      @admission_datetime = admission_datetime unless admission_datetime == SKIP
+      @source_gateway = source_gateway unless source_gateway == SKIP
+      @status = status unless status == SKIP
+      @status_reason = status_reason unless status_reason == 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.
+      admission_datetime = if hash.key?('admission_datetime')
+                             (DateTimeHelper.from_rfc3339(hash['admission_datetime']) if hash['admission_datetime'])
+                           else
+                             SKIP
+                           end
+      source_gateway =
+        hash.key?('source_gateway') ? hash['source_gateway'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_reason = hash.key?('status_reason') ? hash['status_reason'] : SKIP
+
+      # Create object from extracted values.
+      Attributes29.new(admission_datetime,
+                       source_gateway,
+                       status,
+                       status_reason)
+    end
+
+    def to_custom_admission_datetime
+      DateTimeHelper.to_rfc3339(admission_datetime)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes3.rb

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

data/lib/form3_public_api/models/attributes30.rb

@@ -0,0 +1,101 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # Attributes30 Model.
+  class Attributes30 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :destination_gateway
+
+    # Scheme-specific status (if submission has been submitted to a scheme)
+    # @return [String]
+    attr_accessor :scheme_status_code
+
+    # Scheme-specific status (if submission has been submitted to a scheme)
+    # @return [DirectDebitRecallSubmissionStatusEnum]
+    attr_accessor :status
+
+    # Reason for submission failure if status is `delivery_failed`
+    # @return [String]
+    attr_accessor :status_reason
+
+    # Date and time of the submission
+    # @return [DateTime]
+    attr_accessor :submission_datetime
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['destination_gateway'] = 'destination_gateway'
+      @_hash['scheme_status_code'] = 'scheme_status_code'
+      @_hash['status'] = 'status'
+      @_hash['status_reason'] = 'status_reason'
+      @_hash['submission_datetime'] = 'submission_datetime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        destination_gateway
+        scheme_status_code
+        status
+        status_reason
+        submission_datetime
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(destination_gateway = SKIP,
+                   scheme_status_code = SKIP,
+                   status = SKIP,
+                   status_reason = SKIP,
+                   submission_datetime = SKIP)
+      @destination_gateway = destination_gateway unless destination_gateway == SKIP
+      @scheme_status_code = scheme_status_code unless scheme_status_code == SKIP
+      @status = status unless status == SKIP
+      @status_reason = status_reason unless status_reason == SKIP
+      @submission_datetime = submission_datetime unless submission_datetime == 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.
+      destination_gateway =
+        hash.key?('destination_gateway') ? hash['destination_gateway'] : SKIP
+      scheme_status_code =
+        hash.key?('scheme_status_code') ? hash['scheme_status_code'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_reason = hash.key?('status_reason') ? hash['status_reason'] : SKIP
+      submission_datetime = if hash.key?('submission_datetime')
+                              (DateTimeHelper.from_rfc3339(hash['submission_datetime']) if hash['submission_datetime'])
+                            else
+                              SKIP
+                            end
+
+      # Create object from extracted values.
+      Attributes30.new(destination_gateway,
+                       scheme_status_code,
+                       status,
+                       status_reason,
+                       submission_datetime)
+    end
+
+    def to_custom_submission_datetime
+      DateTimeHelper.to_rfc3339(submission_datetime)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes31.rb

@@ -0,0 +1,155 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Attributes31 Model.
+  class Attributes31 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CurrencyAndAmount]
+    attr_accessor :charges_amount
+
+    # Unique identifier for organisations collecting payments
+    # @return [String]
+    attr_accessor :clearing_id
+
+    # Unique identifier for organisations collecting payments
+    # @return [CurrencyAndAmount]
+    attr_accessor :compensation_amount
+
+    # Date on which the operation is to be debited from the debtor account.
+    # Formatted according to ISO 8601 format: YYYY-MM-DD.
+    # @return [Date]
+    attr_accessor :processing_date
+
+    # Date on which the operation is to be debited from the debtor account.
+    # Formatted according to ISO 8601 format: YYYY-MM-DD.
+    # @return [CurrencyAndAmount]
+    attr_accessor :return_amount
+
+    # Date on which the operation is to be debited from the debtor account.
+    # Formatted according to ISO 8601 format: YYYY-MM-DD.
+    # @return [String]
+    attr_accessor :return_code
+
+    # Date on which the operation is to be debited from the debtor account.
+    # Formatted according to ISO 8601 format: YYYY-MM-DD.
+    # @return [ReturnInitiatorEnum]
+    attr_accessor :return_initiator
+
+    # Date on which the operation is processed by the scheme. Formatted
+    # according to ISO 8601 format: YYYY-MM-DD. Only used if different from
+    # `processing_date`.
+    # @return [Date]
+    attr_accessor :scheme_processing_date
+
+    # Date on which the operation is processed by the scheme. Formatted
+    # according to ISO 8601 format: YYYY-MM-DD. Only used if different from
+    # `processing_date`.
+    # @return [String]
+    attr_accessor :scheme_transaction_id
+
+    # Specifies the details on how the settlement of the transaction between the
+    # instructing agent and the instructed agent is completed
+    # @return [Settlement]
+    attr_accessor :settlement
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['charges_amount'] = 'charges_amount'
+      @_hash['clearing_id'] = 'clearing_id'
+      @_hash['compensation_amount'] = 'compensation_amount'
+      @_hash['processing_date'] = 'processing_date'
+      @_hash['return_amount'] = 'return_amount'
+      @_hash['return_code'] = 'return_code'
+      @_hash['return_initiator'] = 'return_initiator'
+      @_hash['scheme_processing_date'] = 'scheme_processing_date'
+      @_hash['scheme_transaction_id'] = 'scheme_transaction_id'
+      @_hash['settlement'] = 'settlement'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        charges_amount
+        clearing_id
+        compensation_amount
+        processing_date
+        return_amount
+        return_code
+        return_initiator
+        scheme_processing_date
+        scheme_transaction_id
+        settlement
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(charges_amount = SKIP,
+                   clearing_id = SKIP,
+                   compensation_amount = SKIP,
+                   processing_date = SKIP,
+                   return_amount = SKIP,
+                   return_code = SKIP,
+                   return_initiator = SKIP,
+                   scheme_processing_date = SKIP,
+                   scheme_transaction_id = SKIP,
+                   settlement = SKIP)
+      @charges_amount = charges_amount unless charges_amount == SKIP
+      @clearing_id = clearing_id unless clearing_id == SKIP
+      @compensation_amount = compensation_amount unless compensation_amount == SKIP
+      @processing_date = processing_date unless processing_date == SKIP
+      @return_amount = return_amount unless return_amount == SKIP
+      @return_code = return_code unless return_code == SKIP
+      @return_initiator = return_initiator unless return_initiator == SKIP
+      @scheme_processing_date = scheme_processing_date unless scheme_processing_date == SKIP
+      @scheme_transaction_id = scheme_transaction_id unless scheme_transaction_id == SKIP
+      @settlement = settlement unless settlement == 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.
+      charges_amount = CurrencyAndAmount.from_hash(hash['charges_amount']) if
+        hash['charges_amount']
+      clearing_id = hash.key?('clearing_id') ? hash['clearing_id'] : SKIP
+      compensation_amount = CurrencyAndAmount.from_hash(hash['compensation_amount']) if
+        hash['compensation_amount']
+      processing_date =
+        hash.key?('processing_date') ? hash['processing_date'] : SKIP
+      return_amount = CurrencyAndAmount.from_hash(hash['return_amount']) if hash['return_amount']
+      return_code = hash.key?('return_code') ? hash['return_code'] : SKIP
+      return_initiator =
+        hash.key?('return_initiator') ? hash['return_initiator'] : SKIP
+      scheme_processing_date =
+        hash.key?('scheme_processing_date') ? hash['scheme_processing_date'] : SKIP
+      scheme_transaction_id =
+        hash.key?('scheme_transaction_id') ? hash['scheme_transaction_id'] : SKIP
+      settlement = Settlement.from_hash(hash['settlement']) if hash['settlement']
+
+      # Create object from extracted values.
+      Attributes31.new(charges_amount,
+                       clearing_id,
+                       compensation_amount,
+                       processing_date,
+                       return_amount,
+                       return_code,
+                       return_initiator,
+                       scheme_processing_date,
+                       scheme_transaction_id,
+                       settlement)
+    end
+  end
+end