packageruby 1.1.1

data/lib/form3_public_api/models/attributes49.rb

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

data/lib/form3_public_api/models/attributes5.rb

@@ -0,0 +1,154 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # Attributes5 Model.
+  class Attributes5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date and time the payment admission was created
+    # @return [DateTime]
+    attr_accessor :admission_datetime
+
+    # Clearing infrastructure through which the payment instruction was
+    # processed
+    # @return [String]
+    attr_accessor :clearing_system
+
+    # Route taken for an outbound payment
+    # @return [RouteEnum]
+    attr_accessor :route
+
+    # Refers to individual scheme where applicable
+    # @return [String]
+    attr_accessor :scheme_status_code
+
+    # [Description](http://api-docs.form3.tech/api.html#enumerations-scheme-stat
+    # us-codes-for-bacs) of `scheme_status_code`
+    # @return [String]
+    attr_accessor :scheme_status_code_description
+
+    # Cycle in which the payment will be settled
+    # @return [Integer]
+    attr_accessor :settlement_cycle
+
+    # Date on which the payment will be settled
+    # @return [Date]
+    attr_accessor :settlement_date
+
+    # [Status of the
+    # admission](https://api-docs.form3.tech/api.html#enumerations-payment-statu
+    # s-codes-admission-status)
+    # @return [PaymentAdmissionStatusEnum]
+    attr_accessor :status
+
+    # [Payment admission status
+    # reason](https://api-docs.form3.tech/api.html#enumerations-payment-status-c
+    # odes-payment-admission-status-reasons)
+    # @return [PaymentAdmissionStatusReasonEnum]
+    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['clearing_system'] = 'clearing_system'
+      @_hash['route'] = 'route'
+      @_hash['scheme_status_code'] = 'scheme_status_code'
+      @_hash['scheme_status_code_description'] =
+        'scheme_status_code_description'
+      @_hash['settlement_cycle'] = 'settlement_cycle'
+      @_hash['settlement_date'] = 'settlement_date'
+      @_hash['status'] = 'status'
+      @_hash['status_reason'] = 'status_reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        admission_datetime
+        clearing_system
+        route
+        scheme_status_code
+        scheme_status_code_description
+        settlement_cycle
+        settlement_date
+        status
+        status_reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(admission_datetime = SKIP,
+                   clearing_system = SKIP,
+                   route = SKIP,
+                   scheme_status_code = SKIP,
+                   scheme_status_code_description = SKIP,
+                   settlement_cycle = SKIP,
+                   settlement_date = SKIP,
+                   status = SKIP,
+                   status_reason = SKIP)
+      @admission_datetime = admission_datetime unless admission_datetime == SKIP
+      @clearing_system = clearing_system unless clearing_system == SKIP
+      @route = route unless route == SKIP
+      @scheme_status_code = scheme_status_code unless scheme_status_code == SKIP
+      unless scheme_status_code_description == SKIP
+        @scheme_status_code_description =
+          scheme_status_code_description
+      end
+      @settlement_cycle = settlement_cycle unless settlement_cycle == SKIP
+      @settlement_date = settlement_date unless settlement_date == 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
+      clearing_system =
+        hash.key?('clearing_system') ? hash['clearing_system'] : SKIP
+      route = hash.key?('route') ? hash['route'] : SKIP
+      scheme_status_code =
+        hash.key?('scheme_status_code') ? hash['scheme_status_code'] : SKIP
+      scheme_status_code_description =
+        hash.key?('scheme_status_code_description') ? hash['scheme_status_code_description'] : SKIP
+      settlement_cycle =
+        hash.key?('settlement_cycle') ? hash['settlement_cycle'] : SKIP
+      settlement_date =
+        hash.key?('settlement_date') ? hash['settlement_date'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_reason = hash.key?('status_reason') ? hash['status_reason'] : SKIP
+
+      # Create object from extracted values.
+      Attributes5.new(admission_datetime,
+                      clearing_system,
+                      route,
+                      scheme_status_code,
+                      scheme_status_code_description,
+                      settlement_cycle,
+                      settlement_date,
+                      status,
+                      status_reason)
+    end
+
+    def to_custom_admission_datetime
+      DateTimeHelper.to_rfc3339(admission_datetime)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes50.rb

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

data/lib/form3_public_api/models/attributes51.rb

@@ -0,0 +1,63 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Attributes51 Model.
+  class Attributes51 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Further explanation of the reason given in reason_code. Only evaluated for
+    # certain reason codes.
+    # @return [String]
+    attr_accessor :reason
+
+    # The reason for the recall. Has to be a valid [recall reason
+    # code](http://api-docs.form3.tech/api.html#enumerations-recall-reason-codes
+    # ).
+    # @return [String]
+    attr_accessor :reason_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash['reason_code'] = 'reason_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+        reason_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason = SKIP,
+                   reason_code = 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.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      reason_code = hash.key?('reason_code') ? hash['reason_code'] : SKIP
+
+      # Create object from extracted values.
+      Attributes51.new(reason,
+                       reason_code)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes52.rb

@@ -0,0 +1,111 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Attributes52 Model.
+  class Attributes52 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The format of the file that will be submitted/admitted to Form3
+    # @return [FileFormatEnum]
+    attr_accessor :file_format
+
+    # Hashed content of the file
+    # @return [String]
+    attr_accessor :file_hash
+
+    # The size of the file to be uploaded - number of bytes. Max size is 1.4
+    # Gigabyte
+    # @return [Integer]
+    attr_accessor :file_size
+
+    # The algorithm used to generate the signature
+    # @return [String]
+    attr_reader :hashing_algorithm
+
+    # The count of chunks to be uploaded to the resource
+    # @return [Integer]
+    attr_accessor :number_of_parts
+
+    # Scheme/gateway that the file is to be processed by
+    # @return [String]
+    attr_reader :payment_scheme
+
+    # The count of transactions that will be submitted in the file
+    # @return [Integer]
+    attr_accessor :transaction_count
+
+    # The sum value of the transactions will be submitted in the file
+    # @return [String]
+    attr_accessor :transaction_sum
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['file_format'] = 'file_format'
+      @_hash['file_hash'] = 'file_hash'
+      @_hash['file_size'] = 'file_size'
+      @_hash['hashing_algorithm'] = 'hashing_algorithm'
+      @_hash['number_of_parts'] = 'number_of_parts'
+      @_hash['payment_scheme'] = 'payment_scheme'
+      @_hash['transaction_count'] = 'transaction_count'
+      @_hash['transaction_sum'] = 'transaction_sum'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_sum
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(file_format = FileFormatEnum::NDJSON,
+                   file_hash = nil,
+                   file_size = nil,
+                   number_of_parts = nil,
+                   transaction_count = nil,
+                   transaction_sum = SKIP)
+      @file_format = file_format
+      @file_hash = file_hash
+      @file_size = file_size
+      @hashing_algorithm = 'SHA256'
+      @number_of_parts = number_of_parts
+      @payment_scheme = 'BACS'
+      @transaction_count = transaction_count
+      @transaction_sum = transaction_sum unless transaction_sum == 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.
+      file_format = hash['file_format'] ||= FileFormatEnum::NDJSON
+      file_hash = hash.key?('file_hash') ? hash['file_hash'] : nil
+      file_size = hash.key?('file_size') ? hash['file_size'] : nil
+      number_of_parts =
+        hash.key?('number_of_parts') ? hash['number_of_parts'] : nil
+      transaction_count =
+        hash.key?('transaction_count') ? hash['transaction_count'] : nil
+      transaction_sum =
+        hash.key?('transaction_sum') ? hash['transaction_sum'] : SKIP
+
+      # Create object from extracted values.
+      Attributes52.new(file_format,
+                       file_hash,
+                       file_size,
+                       number_of_parts,
+                       transaction_count,
+                       transaction_sum)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes53.rb

@@ -0,0 +1,60 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Attributes53 Model.
+  class Attributes53 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Key Value map that contains the Task result.
+    # @return [Object]
+    attr_accessor :output
+
+    # status of the task
+    # @return [PaymentAdmissionTaskStatusEnum]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['output'] = 'output'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        output
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(output = SKIP,
+                   status = SKIP)
+      @output = output unless output == SKIP
+      @status = status unless status == 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.
+      output = hash.key?('output') ? hash['output'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      Attributes53.new(output,
+                       status)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes54.rb

@@ -0,0 +1,60 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Attributes54 Model.
+  class Attributes54 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Key Value map that contains the Task result.
+    # @return [Hash[String, Object]]
+    attr_accessor :output
+
+    # status of the submission task
+    # @return [PaymentSubmissionTaskStatusEnum]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['output'] = 'output'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        output
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(output = SKIP,
+                   status = SKIP)
+      @output = output unless output == SKIP
+      @status = status unless status == 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.
+      output = hash.key?('output') ? hash['output'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      Attributes54.new(output,
+                       status)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes55.rb

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