packageruby 1.1.1

data/lib/form3_public_api/models/ultimate_entity.rb

@@ -0,0 +1,282 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # UltimateEntity Model.
+  class UltimateEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Additional address line of the debtor/beneficiary address
+    # @return [String]
+    attr_accessor :additional_address_line
+
+    # Ultimate debtor/beneficiary address
+    # @return [Array[String]]
+    attr_accessor :address
+
+    # Ultimate debtor/beneficiary birth city
+    # @return [String]
+    attr_accessor :birth_city
+
+    # Ultimate debtor/beneficiary birth country. ISO 3166 format country code
+    # @return [String]
+    attr_accessor :birth_country
+
+    # Ultimate debtor/beneficiary birth date. Formatted ISO 8601 format
+    # YYYY-MM-DD
+    # @return [Date]
+    attr_accessor :birth_date
+
+    # Ultimate debtor/beneficiary birth province
+    # @return [String]
+    attr_accessor :birth_province
+
+    # Building number of the debtor/beneficiary address
+    # @return [String]
+    attr_accessor :building_number
+
+    # City/Town of the Beneficiary address
+    # @return [String]
+    attr_accessor :city
+
+    # Country of ultimate debtor/beneficiary address. ISO 3166 format country
+    # code
+    # @return [String]
+    attr_accessor :country
+
+    # Country of residence of the ultimate beneficiary, ISO 3166 format country
+    # code
+    # @return [String]
+    attr_accessor :country_of_residence
+
+    # Country of residence of the ultimate beneficiary, ISO 3166 format country
+    # code
+    # @return [String]
+    attr_accessor :name
+
+    # Organisation identification of an ultimate debtor/beneficiary, in the case
+    # that the ultimate debtor/beneficiary is an organisation and not a private
+    # person.
+    # @return [String]
+    attr_accessor :organisation_identification
+
+    # The code that specifies the type of `organisation_identification`
+    # @return [String]
+    attr_accessor :organisation_identification_code
+
+    # Issuer of the `organisation_identification`
+    # @return [String]
+    attr_accessor :organisation_identification_issuer
+
+    # The code that specifies the scheme of `organisation_identification`
+    # @return [String]
+    attr_accessor :organisation_identification_scheme
+
+    # Array for additional ID(s) of ultimate organisation
+    # @return [Array[BeneficiaryDebtorOrganisationIdentification]]
+    attr_accessor :organisation_identifications
+
+    # Post code of the debtor/beneficiary address
+    # @return [String]
+    attr_accessor :post_code
+
+    # Post code of the debtor/beneficiary address
+    # @return [PrivateIdentification]
+    attr_accessor :private_identification
+
+    # Province of the debtor/beneficiary address
+    # @return [String]
+    attr_accessor :province
+
+    # Street name of the debtor/beneficiary address
+    # @return [String]
+    attr_accessor :street_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['additional_address_line'] = 'additional_address_line'
+      @_hash['address'] = 'address'
+      @_hash['birth_city'] = 'birth_city'
+      @_hash['birth_country'] = 'birth_country'
+      @_hash['birth_date'] = 'birth_date'
+      @_hash['birth_province'] = 'birth_province'
+      @_hash['building_number'] = 'building_number'
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['country_of_residence'] = 'country_of_residence'
+      @_hash['name'] = 'name'
+      @_hash['organisation_identification'] = 'organisation_identification'
+      @_hash['organisation_identification_code'] =
+        'organisation_identification_code'
+      @_hash['organisation_identification_issuer'] =
+        'organisation_identification_issuer'
+      @_hash['organisation_identification_scheme'] =
+        'organisation_identification_scheme'
+      @_hash['organisation_identifications'] = 'organisation_identifications'
+      @_hash['post_code'] = 'post_code'
+      @_hash['private_identification'] = 'private_identification'
+      @_hash['province'] = 'province'
+      @_hash['street_name'] = 'street_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        additional_address_line
+        address
+        birth_city
+        birth_country
+        birth_date
+        birth_province
+        building_number
+        city
+        country
+        country_of_residence
+        name
+        organisation_identification
+        organisation_identification_code
+        organisation_identification_issuer
+        organisation_identification_scheme
+        organisation_identifications
+        post_code
+        private_identification
+        province
+        street_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(additional_address_line = SKIP,
+                   address = SKIP,
+                   birth_city = SKIP,
+                   birth_country = SKIP,
+                   birth_date = SKIP,
+                   birth_province = SKIP,
+                   building_number = SKIP,
+                   city = SKIP,
+                   country = SKIP,
+                   country_of_residence = SKIP,
+                   name = SKIP,
+                   organisation_identification = SKIP,
+                   organisation_identification_code = SKIP,
+                   organisation_identification_issuer = SKIP,
+                   organisation_identification_scheme = SKIP,
+                   organisation_identifications = SKIP,
+                   post_code = SKIP,
+                   private_identification = SKIP,
+                   province = SKIP,
+                   street_name = SKIP)
+      @additional_address_line = additional_address_line unless additional_address_line == SKIP
+      @address = address unless address == SKIP
+      @birth_city = birth_city unless birth_city == SKIP
+      @birth_country = birth_country unless birth_country == SKIP
+      @birth_date = birth_date unless birth_date == SKIP
+      @birth_province = birth_province unless birth_province == SKIP
+      @building_number = building_number unless building_number == SKIP
+      @city = city unless city == SKIP
+      @country = country unless country == SKIP
+      @country_of_residence = country_of_residence unless country_of_residence == SKIP
+      @name = name unless name == SKIP
+      unless organisation_identification == SKIP
+        @organisation_identification =
+          organisation_identification
+      end
+      unless organisation_identification_code == SKIP
+        @organisation_identification_code =
+          organisation_identification_code
+      end
+      unless organisation_identification_issuer == SKIP
+        @organisation_identification_issuer =
+          organisation_identification_issuer
+      end
+      unless organisation_identification_scheme == SKIP
+        @organisation_identification_scheme =
+          organisation_identification_scheme
+      end
+      unless organisation_identifications == SKIP
+        @organisation_identifications =
+          organisation_identifications
+      end
+      @post_code = post_code unless post_code == SKIP
+      @private_identification = private_identification unless private_identification == SKIP
+      @province = province unless province == SKIP
+      @street_name = street_name unless street_name == 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.
+      additional_address_line =
+        hash.key?('additional_address_line') ? hash['additional_address_line'] : SKIP
+      address = hash.key?('address') ? hash['address'] : SKIP
+      birth_city = hash.key?('birth_city') ? hash['birth_city'] : SKIP
+      birth_country = hash.key?('birth_country') ? hash['birth_country'] : SKIP
+      birth_date = hash.key?('birth_date') ? hash['birth_date'] : SKIP
+      birth_province =
+        hash.key?('birth_province') ? hash['birth_province'] : SKIP
+      building_number =
+        hash.key?('building_number') ? hash['building_number'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      country_of_residence =
+        hash.key?('country_of_residence') ? hash['country_of_residence'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      organisation_identification =
+        hash.key?('organisation_identification') ? hash['organisation_identification'] : SKIP
+      organisation_identification_code =
+        hash.key?('organisation_identification_code') ? hash['organisation_identification_code'] : SKIP
+      organisation_identification_issuer =
+        hash.key?('organisation_identification_issuer') ? hash['organisation_identification_issuer'] : SKIP
+      organisation_identification_scheme =
+        hash.key?('organisation_identification_scheme') ? hash['organisation_identification_scheme'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      organisation_identifications = nil
+      unless hash['organisation_identifications'].nil?
+        organisation_identifications = []
+        hash['organisation_identifications'].each do |structure|
+          organisation_identifications << (BeneficiaryDebtorOrganisationIdentification.from_hash(structure) if structure)
+        end
+      end
+
+      organisation_identifications = SKIP unless hash.key?('organisation_identifications')
+      post_code = hash.key?('post_code') ? hash['post_code'] : SKIP
+      private_identification = PrivateIdentification.from_hash(hash['private_identification']) if
+        hash['private_identification']
+      province = hash.key?('province') ? hash['province'] : SKIP
+      street_name = hash.key?('street_name') ? hash['street_name'] : SKIP
+
+      # Create object from extracted values.
+      UltimateEntity.new(additional_address_line,
+                         address,
+                         birth_city,
+                         birth_country,
+                         birth_date,
+                         birth_province,
+                         building_number,
+                         city,
+                         country,
+                         country_of_residence,
+                         name,
+                         organisation_identification,
+                         organisation_identification_code,
+                         organisation_identification_issuer,
+                         organisation_identification_scheme,
+                         organisation_identifications,
+                         post_code,
+                         private_identification,
+                         province,
+                         street_name)
+    end
+  end
+end

data/lib/form3_public_api/models/user.rb

@@ -0,0 +1,91 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # User Model.
+  class User < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Attributes70]
+    attr_accessor :attributes
+
+    # Unique resource ID
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # Unique ID of the organisation this resource is created by
+    # @return [UUID | String]
+    attr_accessor :organisation_id
+
+    # 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['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 = Attributes70.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.
+      User.new(attributes,
+               id,
+               organisation_id,
+               type,
+               version)
+    end
+  end
+end

data/lib/form3_public_api/models/user_creation.rb

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

data/lib/form3_public_api/models/user_creation_response.rb

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

data/lib/form3_public_api/models/user_credential_list_response.rb

@@ -0,0 +1,68 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # UserCredentialListResponse Model.
+  class UserCredentialListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Credential]]
+    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[
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = nil,
+                   links = SKIP)
+      @data = data
+      @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 << (Credential.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+      links = Links.from_hash(hash['links']) if hash['links']
+
+      # Create object from extracted values.
+      UserCredentialListResponse.new(data,
+                                     links)
+    end
+  end
+end

data/lib/form3_public_api/models/user_defined_data.rb

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

data/lib/form3_public_api/models/user_details_list_response.rb

@@ -0,0 +1,68 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # UserDetailsListResponse Model.
+  class UserDetailsListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[User]]
+    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[
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = nil,
+                   links = SKIP)
+      @data = data
+      @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 << (User.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+      links = Links.from_hash(hash['links']) if hash['links']
+
+      # Create object from extracted values.
+      UserDetailsListResponse.new(data,
+                                  links)
+    end
+  end
+end