packageruby 1.1.1

data/lib/form3_public_api/models/mandate_attributes_beneficiary_party.rb

@@ -0,0 +1,123 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # MandateAttributesBeneficiaryParty Model.
+  class MandateAttributesBeneficiaryParty < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_number
+
+    # The type of identification given at `account_number` attribute
+    # @return [AccountNumberCodeEnum]
+    attr_accessor :account_number_code
+
+    # The type of identification given at `account_number` attribute
+    # @return [Integer]
+    attr_accessor :account_type
+
+    # Information about the financial institution servicing the account.
+    # @return [AccountHoldingEntity]
+    attr_accessor :account_with
+
+    # Information about the financial institution servicing the account.
+    # @return [Array[String]]
+    attr_accessor :address
+
+    # Information about the financial institution servicing the account.
+    # @return [String]
+    attr_accessor :country
+
+    # Information about the financial institution servicing the account.
+    # @return [PrivateIdentification]
+    attr_accessor :private_identification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'account_name'
+      @_hash['account_number'] = 'account_number'
+      @_hash['account_number_code'] = 'account_number_code'
+      @_hash['account_type'] = 'account_type'
+      @_hash['account_with'] = 'account_with'
+      @_hash['address'] = 'address'
+      @_hash['country'] = 'country'
+      @_hash['private_identification'] = 'private_identification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        account_number
+        account_number_code
+        account_type
+        account_with
+        address
+        country
+        private_identification
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   account_number = SKIP,
+                   account_number_code = SKIP,
+                   account_type = SKIP,
+                   account_with = SKIP,
+                   address = SKIP,
+                   country = SKIP,
+                   private_identification = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_number_code = account_number_code unless account_number_code == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @account_with = account_with unless account_with == SKIP
+      @address = address unless address == SKIP
+      @country = country unless country == SKIP
+      @private_identification = private_identification unless private_identification == 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.
+      account_name = hash.key?('account_name') ? hash['account_name'] : SKIP
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      account_number_code =
+        hash.key?('account_number_code') ? hash['account_number_code'] : SKIP
+      account_type = hash.key?('account_type') ? hash['account_type'] : SKIP
+      account_with = AccountHoldingEntity.from_hash(hash['account_with']) if hash['account_with']
+      address = hash.key?('address') ? hash['address'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      private_identification = PrivateIdentification.from_hash(hash['private_identification']) if
+        hash['private_identification']
+
+      # Create object from extracted values.
+      MandateAttributesBeneficiaryParty.new(account_name,
+                                            account_number,
+                                            account_number_code,
+                                            account_type,
+                                            account_with,
+                                            address,
+                                            country,
+                                            private_identification)
+    end
+  end
+end

data/lib/form3_public_api/models/mandate_attributes_debtor_party.rb

@@ -0,0 +1,102 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # MandateAttributesDebtorParty Model.
+  class MandateAttributesDebtorParty < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_number
+
+    # The type of identification given at `account_number` attribute
+    # @return [AccountNumberCodeEnum]
+    attr_accessor :account_number_code
+
+    # Information about the financial institution servicing the account.
+    # @return [AccountHoldingEntity]
+    attr_accessor :account_with
+
+    # Information about the financial institution servicing the account.
+    # @return [Array[String]]
+    attr_accessor :address
+
+    # Information about the financial institution servicing the account.
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'account_name'
+      @_hash['account_number'] = 'account_number'
+      @_hash['account_number_code'] = 'account_number_code'
+      @_hash['account_with'] = 'account_with'
+      @_hash['address'] = 'address'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        account_number
+        account_number_code
+        account_with
+        address
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   account_number = SKIP,
+                   account_number_code = SKIP,
+                   account_with = SKIP,
+                   address = SKIP,
+                   country = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_number_code = account_number_code unless account_number_code == SKIP
+      @account_with = account_with unless account_with == SKIP
+      @address = address unless address == SKIP
+      @country = country unless country == 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.
+      account_name = hash.key?('account_name') ? hash['account_name'] : SKIP
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      account_number_code =
+        hash.key?('account_number_code') ? hash['account_number_code'] : SKIP
+      account_with = AccountHoldingEntity.from_hash(hash['account_with']) if hash['account_with']
+      address = hash.key?('address') ? hash['address'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+
+      # Create object from extracted values.
+      MandateAttributesDebtorParty.new(account_name,
+                                       account_number,
+                                       account_number_code,
+                                       account_with,
+                                       address,
+                                       country)
+    end
+  end
+end

data/lib/form3_public_api/models/mandate_creation.rb

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

data/lib/form3_public_api/models/mandate_creation_response.rb

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

data/lib/form3_public_api/models/mandate_details_list_response.rb

@@ -0,0 +1,69 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # MandateDetailsListResponse Model.
+  class MandateDetailsListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Mandate]]
+    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 << (Mandate.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.
+      MandateDetailsListResponse.new(data,
+                                     links)
+    end
+  end
+end

data/lib/form3_public_api/models/mandate_details_response.rb

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

data/lib/form3_public_api/models/mandate_frequency_enum.rb

@@ -0,0 +1,38 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # MandateFrequency.
+  class MandateFrequencyEnum
+    MANDATE_FREQUENCY_ENUM = [
+      # TODO: Write general description for DAILY
+      DAILY = 'daily'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'weekly'.freeze,
+
+      # TODO: Write general description for FORTNIGHTLY
+      FORTNIGHTLY = 'fortnightly'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'monthly'.freeze,
+
+      # TODO: Write general description for BIMONTHLY
+      BIMONTHLY = 'bimonthly'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'quarterly'.freeze,
+
+      # TODO: Write general description for YEARLY
+      YEARLY = 'yearly'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MANDATE_FREQUENCY_ENUM.include?(value)
+    end
+  end
+end

data/lib/form3_public_api/models/mandate_relationships.rb

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

data/lib/form3_public_api/models/mandate_resource_type_enum.rb

@@ -0,0 +1,48 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # MandateResourceType.
+  class MandateResourceTypeEnum
+    MANDATE_RESOURCE_TYPE_ENUM = [
+      # TODO: Write general description for MANDATES
+      MANDATES = 'mandates'.freeze,
+
+      # TODO: Write general description for MANDATE_ADMISSIONS
+      MANDATE_ADMISSIONS = 'mandate_admissions'.freeze,
+
+      # TODO: Write general description for MANDATE_RETURNS
+      MANDATE_RETURNS = 'mandate_returns'.freeze,
+
+      # TODO: Write general description for MANDATE_RETURN_SUBMISSIONS
+      MANDATE_RETURN_SUBMISSIONS = 'mandate_return_submissions'.freeze,
+
+      # TODO: Write general description for
+      # MANDATE_RETURN_SUBMISSION_VALIDATIONS
+      MANDATE_RETURN_SUBMISSION_VALIDATIONS = 'mandate_return_submission_validations'.freeze,
+
+      # TODO: Write general description for MANDATE_SUBMISSIONS
+      MANDATE_SUBMISSIONS = 'mandate_submissions'.freeze,
+
+      # TODO: Write general description for MANDATE_SUBMISSION_VALIDATIONS
+      MANDATE_SUBMISSION_VALIDATIONS = 'mandate_submission_validations'.freeze,
+
+      # TODO: Write general description for MANDATE_AUTOMATIC_RETURNS
+      MANDATE_AUTOMATIC_RETURNS = 'mandate_automatic_returns'.freeze,
+
+      # TODO: Write general description for MANDATE_MANAGEMENTS
+      MANDATE_MANAGEMENTS = 'mandate_managements'.freeze,
+
+      # TODO: Write general description for MANDATE_SUBMISSIONS_WITH_FINAL_STATE
+      MANDATE_SUBMISSIONS_WITH_FINAL_STATE = 'mandate_submissions_with_final_state'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MANDATE_RESOURCE_TYPE_ENUM.include?(value)
+    end
+  end
+end