packageruby 1.1.1

data/lib/form3_public_api/models/attributes16.rb

@@ -0,0 +1,262 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # Attributes16 Model.
+  class Attributes16 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Clearing infrastructure through which the payment instruction was
+    # processed
+    # @return [String]
+    attr_accessor :clearing_system
+
+    # Identification code of the file sent to scheme.
+    # @return [String]
+    attr_accessor :file_identifier
+
+    # Number of the file sent to scheme.
+    # @return [String]
+    attr_accessor :file_number
+
+    # Time a payment was released from being held due to a limit breach
+    # @return [DateTime]
+    attr_accessor :limit_breach_end_datetime
+
+    # Start time a payment was held due to a limit breach
+    # @return [DateTime]
+    attr_accessor :limit_breach_start_datetime
+
+    # Details of the account to which funds are redirected (if applicable)
+    # @return [String]
+    attr_accessor :redirected_account_number
+
+    # Details of the bank to which funds are redirected (if applicable)
+    # @return [String]
+    attr_accessor :redirected_bank_id
+
+    # Route taken for an outbound payment
+    # @return [RouteEnum]
+    attr_accessor :route
+
+    # Scheme-specific status (if submission has been submitted to a scheme)
+    # @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 that the payment will be settled
+    # @return [Date]
+    attr_accessor :settlement_date
+
+    # [Status of the
+    # submission](https://api-docs.form3.tech/api.html#enumerations-payment-stat
+    # us-codes-submission-status)
+    # @return [PaymentSubmissionStatusEnum]
+    attr_accessor :status
+
+    # Description of the submission status
+    # @return [String]
+    attr_accessor :status_reason
+
+    # Date of the submission
+    # @return [DateTime]
+    attr_accessor :submission_datetime
+
+    # Time the request was received by Form3. Used to compute the total
+    # transaction time of a payment.
+    # @return [DateTime]
+    attr_accessor :transaction_start_datetime
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['clearing_system'] = 'clearing_system'
+      @_hash['file_identifier'] = 'file_identifier'
+      @_hash['file_number'] = 'file_number'
+      @_hash['limit_breach_end_datetime'] = 'limit_breach_end_datetime'
+      @_hash['limit_breach_start_datetime'] = 'limit_breach_start_datetime'
+      @_hash['redirected_account_number'] = 'redirected_account_number'
+      @_hash['redirected_bank_id'] = 'redirected_bank_id'
+      @_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['submission_datetime'] = 'submission_datetime'
+      @_hash['transaction_start_datetime'] = 'transaction_start_datetime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        clearing_system
+        file_identifier
+        file_number
+        limit_breach_end_datetime
+        limit_breach_start_datetime
+        redirected_account_number
+        redirected_bank_id
+        route
+        scheme_status_code
+        scheme_status_code_description
+        settlement_cycle
+        settlement_date
+        status
+        status_reason
+        submission_datetime
+        transaction_start_datetime
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(clearing_system = SKIP,
+                   file_identifier = SKIP,
+                   file_number = SKIP,
+                   limit_breach_end_datetime = SKIP,
+                   limit_breach_start_datetime = SKIP,
+                   redirected_account_number = SKIP,
+                   redirected_bank_id = SKIP,
+                   route = SKIP,
+                   scheme_status_code = SKIP,
+                   scheme_status_code_description = SKIP,
+                   settlement_cycle = SKIP,
+                   settlement_date = SKIP,
+                   status = SKIP,
+                   status_reason = SKIP,
+                   submission_datetime = SKIP,
+                   transaction_start_datetime = SKIP)
+      @clearing_system = clearing_system unless clearing_system == SKIP
+      @file_identifier = file_identifier unless file_identifier == SKIP
+      @file_number = file_number unless file_number == SKIP
+      unless limit_breach_end_datetime == SKIP
+        @limit_breach_end_datetime =
+          limit_breach_end_datetime
+      end
+      unless limit_breach_start_datetime == SKIP
+        @limit_breach_start_datetime =
+          limit_breach_start_datetime
+      end
+      unless redirected_account_number == SKIP
+        @redirected_account_number =
+          redirected_account_number
+      end
+      @redirected_bank_id = redirected_bank_id unless redirected_bank_id == 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
+      @submission_datetime = submission_datetime unless submission_datetime == SKIP
+      unless transaction_start_datetime == SKIP
+        @transaction_start_datetime =
+          transaction_start_datetime
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      clearing_system =
+        hash.key?('clearing_system') ? hash['clearing_system'] : SKIP
+      file_identifier =
+        hash.key?('file_identifier') ? hash['file_identifier'] : SKIP
+      file_number = hash.key?('file_number') ? hash['file_number'] : SKIP
+      limit_breach_end_datetime = if hash.key?('limit_breach_end_datetime')
+                                    (DateTimeHelper.from_rfc3339(hash['limit_breach_end_datetime']) if hash['limit_breach_end_datetime'])
+                                  else
+                                    SKIP
+                                  end
+      limit_breach_start_datetime = if hash.key?('limit_breach_start_datetime')
+                                      (DateTimeHelper.from_rfc3339(hash['limit_breach_start_datetime']) if hash['limit_breach_start_datetime'])
+                                    else
+                                      SKIP
+                                    end
+      redirected_account_number =
+        hash.key?('redirected_account_number') ? hash['redirected_account_number'] : SKIP
+      redirected_bank_id =
+        hash.key?('redirected_bank_id') ? hash['redirected_bank_id'] : 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
+      submission_datetime = if hash.key?('submission_datetime')
+                              (DateTimeHelper.from_rfc3339(hash['submission_datetime']) if hash['submission_datetime'])
+                            else
+                              SKIP
+                            end
+      transaction_start_datetime = if hash.key?('transaction_start_datetime')
+                                     (DateTimeHelper.from_rfc3339(hash['transaction_start_datetime']) if hash['transaction_start_datetime'])
+                                   else
+                                     SKIP
+                                   end
+
+      # Create object from extracted values.
+      Attributes16.new(clearing_system,
+                       file_identifier,
+                       file_number,
+                       limit_breach_end_datetime,
+                       limit_breach_start_datetime,
+                       redirected_account_number,
+                       redirected_bank_id,
+                       route,
+                       scheme_status_code,
+                       scheme_status_code_description,
+                       settlement_cycle,
+                       settlement_date,
+                       status,
+                       status_reason,
+                       submission_datetime,
+                       transaction_start_datetime)
+    end
+
+    def to_custom_limit_breach_end_datetime
+      DateTimeHelper.to_rfc3339(limit_breach_end_datetime)
+    end
+
+    def to_custom_limit_breach_start_datetime
+      DateTimeHelper.to_rfc3339(limit_breach_start_datetime)
+    end
+
+    def to_custom_submission_datetime
+      DateTimeHelper.to_rfc3339(submission_datetime)
+    end
+
+    def to_custom_transaction_start_datetime
+      DateTimeHelper.to_rfc3339(transaction_start_datetime)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes17.rb

@@ -0,0 +1,80 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Attributes17 Model.
+  class Attributes17 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Helps to identify the owner of the task
+    # @return [PaymentSubmissionTaskAssigneeEnum]
+    attr_accessor :assignee
+
+    # Identifies the payment submission task to be executed
+    # @return [String]
+    attr_accessor :name
+
+    # 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['assignee'] = 'assignee'
+      @_hash['name'] = 'name'
+      @_hash['output'] = 'output'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        assignee
+        name
+        output
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(assignee = SKIP,
+                   name = SKIP,
+                   output = SKIP,
+                   status = SKIP)
+      @assignee = assignee unless assignee == SKIP
+      @name = name unless name == 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.
+      assignee = hash.key?('assignee') ? hash['assignee'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      output = hash.key?('output') ? hash['output'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      Attributes17.new(assignee,
+                       name,
+                       output,
+                       status)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes18.rb

@@ -0,0 +1,121 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Form3PublicApi
+  # Attributes18 Model.
+  class Attributes18 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Timestamp when the change was requested
+    # @return [DateTime]
+    attr_accessor :action_time
+
+    # User ID of the user who requested the change
+    # @return [UUID | String]
+    attr_accessor :actioned_by
+
+    # Snapshot of what the data would be after the change (empty if the request
+    # was to DELETE a record)
+    # @return [Object]
+    attr_accessor :after_data
+
+    # Snapshot of the data before the change (empty if the request was to CREATE
+    # a new record)
+    # @return [Object]
+    attr_accessor :before_data
+
+    # Textual description of the change being made
+    # @return [String]
+    attr_accessor :description
+
+    # ID of the resource that is being changed
+    # @return [UUID | String]
+    attr_accessor :record_id
+
+    # Type of the resource that is being changed
+    # @return [String]
+    attr_accessor :record_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action_time'] = 'action_time'
+      @_hash['actioned_by'] = 'actioned_by'
+      @_hash['after_data'] = 'after_data'
+      @_hash['before_data'] = 'before_data'
+      @_hash['description'] = 'description'
+      @_hash['record_id'] = 'record_id'
+      @_hash['record_type'] = 'record_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action_time
+        actioned_by
+        after_data
+        before_data
+        description
+        record_id
+        record_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(action_time = SKIP,
+                   actioned_by = SKIP,
+                   after_data = SKIP,
+                   before_data = SKIP,
+                   description = SKIP,
+                   record_id = SKIP,
+                   record_type = SKIP)
+      @action_time = action_time unless action_time == SKIP
+      @actioned_by = actioned_by unless actioned_by == SKIP
+      @after_data = after_data unless after_data == SKIP
+      @before_data = before_data unless before_data == SKIP
+      @description = description unless description == SKIP
+      @record_id = record_id unless record_id == SKIP
+      @record_type = record_type unless record_type == 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.
+      action_time = if hash.key?('action_time')
+                      (DateTimeHelper.from_rfc3339(hash['action_time']) if hash['action_time'])
+                    else
+                      SKIP
+                    end
+      actioned_by = hash.key?('actioned_by') ? hash['actioned_by'] : SKIP
+      after_data = hash.key?('after_data') ? hash['after_data'] : SKIP
+      before_data = hash.key?('before_data') ? hash['before_data'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      record_id = hash.key?('record_id') ? hash['record_id'] : SKIP
+      record_type = hash.key?('record_type') ? hash['record_type'] : SKIP
+
+      # Create object from extracted values.
+      Attributes18.new(action_time,
+                       actioned_by,
+                       after_data,
+                       before_data,
+                       description,
+                       record_id,
+                       record_type)
+    end
+
+    def to_custom_action_time
+      DateTimeHelper.to_rfc3339(action_time)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes19.rb

@@ -0,0 +1,93 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Attributes19 Model.
+  class Attributes19 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # All accepted payments will receive the matching qualifier code
+    # @return [AcceptanceQualifierEnum]
+    attr_accessor :acceptance_qualifier
+
+    # Account number of the account. A unique number will automatically be
+    # generated if not provided.
+    # @return [String]
+    attr_accessor :reference_mask
+
+    # All purpose list of key-value pairs to store specific data.
+    # @return [Array[UserDefinedData]]
+    attr_accessor :user_defined_data
+
+    # optional validation to apply to the branch
+    # @return [BranchValidationTypeEnum]
+    attr_accessor :validation_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['acceptance_qualifier'] = 'acceptance_qualifier'
+      @_hash['reference_mask'] = 'reference_mask'
+      @_hash['user_defined_data'] = 'user_defined_data'
+      @_hash['validation_type'] = 'validation_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        acceptance_qualifier
+        reference_mask
+        user_defined_data
+        validation_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(acceptance_qualifier = SKIP,
+                   reference_mask = SKIP,
+                   user_defined_data = SKIP,
+                   validation_type = SKIP)
+      @acceptance_qualifier = acceptance_qualifier unless acceptance_qualifier == SKIP
+      @reference_mask = reference_mask unless reference_mask == SKIP
+      @user_defined_data = user_defined_data unless user_defined_data == SKIP
+      @validation_type = validation_type unless validation_type == 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.
+      acceptance_qualifier =
+        hash.key?('acceptance_qualifier') ? hash['acceptance_qualifier'] : SKIP
+      reference_mask =
+        hash.key?('reference_mask') ? hash['reference_mask'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      user_defined_data = nil
+      unless hash['user_defined_data'].nil?
+        user_defined_data = []
+        hash['user_defined_data'].each do |structure|
+          user_defined_data << (UserDefinedData.from_hash(structure) if structure)
+        end
+      end
+
+      user_defined_data = SKIP unless hash.key?('user_defined_data')
+      validation_type =
+        hash.key?('validation_type') ? hash['validation_type'] : SKIP
+
+      # Create object from extracted values.
+      Attributes19.new(acceptance_qualifier,
+                       reference_mask,
+                       user_defined_data,
+                       validation_type)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes2.rb

@@ -0,0 +1,80 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Attributes2 Model.
+  class Attributes2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Action that this ACE controls
+    # @return [String]
+    attr_accessor :action
+
+    # Action that this ACE controls
+    # @return [String]
+    attr_accessor :filter
+
+    # Type of record that this ACE gives access to
+    # @return [String]
+    attr_accessor :record_type
+
+    # Role ID of the role that this ACE belongs to
+    # @return [UUID | String]
+    attr_accessor :role_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action'] = 'action'
+      @_hash['filter'] = 'filter'
+      @_hash['record_type'] = 'record_type'
+      @_hash['role_id'] = 'role_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action
+        filter
+        record_type
+        role_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(action = SKIP,
+                   filter = SKIP,
+                   record_type = SKIP,
+                   role_id = SKIP)
+      @action = action unless action == SKIP
+      @filter = filter unless filter == SKIP
+      @record_type = record_type unless record_type == SKIP
+      @role_id = role_id unless role_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.
+      action = hash.key?('action') ? hash['action'] : SKIP
+      filter = hash.key?('filter') ? hash['filter'] : SKIP
+      record_type = hash.key?('record_type') ? hash['record_type'] : SKIP
+      role_id = hash.key?('role_id') ? hash['role_id'] : SKIP
+
+      # Create object from extracted values.
+      Attributes2.new(action,
+                      filter,
+                      record_type,
+                      role_id)
+    end
+  end
+end

data/lib/form3_public_api/models/attributes20.rb

@@ -0,0 +1,49 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # Attributes20 Model.
+  class Attributes20 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :original_instruction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['original_instruction_id'] = 'original_instruction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(original_instruction_id = nil)
+      @original_instruction_id = original_instruction_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      original_instruction_id =
+        hash.key?('original_instruction_id') ? hash['original_instruction_id'] : nil
+
+      # Create object from extracted values.
+      Attributes20.new(original_instruction_id)
+    end
+  end
+end