packageruby 1.1.1

data/lib/form3_public_api/models/beneficiary_debtor_account_holding_entity.rb

@@ -0,0 +1,111 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # BeneficiaryDebtorAccountHoldingEntity Model.
+  class BeneficiaryDebtorAccountHoldingEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Financial institution address
+    # @return [Array[String]]
+    attr_accessor :bank_address
+
+    # Financial institution identification
+    # @return [String]
+    attr_accessor :bank_id
+
+    # The type of identification provided at `bank_id` attribute. Must be ISO
+    # code as listed in the [External Code Sets
+    # spreadsheet](https://www.iso20022.org/external_code_list.page)
+    # @return [String]
+    attr_accessor :bank_id_code
+
+    # Array for additional ID(s) for agent
+    # @return [Array[AccountWithBankId]]
+    attr_accessor :bank_ids
+
+    # Financial institution name
+    # @return [String]
+    attr_accessor :bank_name
+
+    # Identifier of the financial institution which services the account
+    # @return [String]
+    attr_accessor :bank_party_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bank_address'] = 'bank_address'
+      @_hash['bank_id'] = 'bank_id'
+      @_hash['bank_id_code'] = 'bank_id_code'
+      @_hash['bank_ids'] = 'bank_ids'
+      @_hash['bank_name'] = 'bank_name'
+      @_hash['bank_party_id'] = 'bank_party_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bank_address
+        bank_id
+        bank_id_code
+        bank_ids
+        bank_name
+        bank_party_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bank_address = SKIP,
+                   bank_id = SKIP,
+                   bank_id_code = SKIP,
+                   bank_ids = SKIP,
+                   bank_name = SKIP,
+                   bank_party_id = SKIP)
+      @bank_address = bank_address unless bank_address == SKIP
+      @bank_id = bank_id unless bank_id == SKIP
+      @bank_id_code = bank_id_code unless bank_id_code == SKIP
+      @bank_ids = bank_ids unless bank_ids == SKIP
+      @bank_name = bank_name unless bank_name == SKIP
+      @bank_party_id = bank_party_id unless bank_party_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.
+      bank_address = hash.key?('bank_address') ? hash['bank_address'] : SKIP
+      bank_id = hash.key?('bank_id') ? hash['bank_id'] : SKIP
+      bank_id_code = hash.key?('bank_id_code') ? hash['bank_id_code'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      bank_ids = nil
+      unless hash['bank_ids'].nil?
+        bank_ids = []
+        hash['bank_ids'].each do |structure|
+          bank_ids << (AccountWithBankId.from_hash(structure) if structure)
+        end
+      end
+
+      bank_ids = SKIP unless hash.key?('bank_ids')
+      bank_name = hash.key?('bank_name') ? hash['bank_name'] : SKIP
+      bank_party_id = hash.key?('bank_party_id') ? hash['bank_party_id'] : SKIP
+
+      # Create object from extracted values.
+      BeneficiaryDebtorAccountHoldingEntity.new(bank_address,
+                                                bank_id,
+                                                bank_id_code,
+                                                bank_ids,
+                                                bank_name,
+                                                bank_party_id)
+    end
+  end
+end

data/lib/form3_public_api/models/beneficiary_debtor_account_proxy.rb

@@ -0,0 +1,73 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # BeneficiaryDebtorAccountProxy Model.
+  class BeneficiaryDebtorAccountProxy < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the identification scheme, in a free text form. When used
+    # proxy_id_code must not be present
+    # @return [String]
+    attr_accessor :proxy
+
+    # Identification used to indicate the account identification under another
+    # specified name
+    # @return [String]
+    attr_accessor :proxy_id
+
+    # Name of the identification scheme, in a coded form as published in an
+    # external list. When used proxy field must not be present
+    # @return [String]
+    attr_accessor :proxy_id_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['proxy'] = 'proxy'
+      @_hash['proxy_id'] = 'proxy_id'
+      @_hash['proxy_id_code'] = 'proxy_id_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        proxy
+        proxy_id
+        proxy_id_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(proxy = SKIP,
+                   proxy_id = SKIP,
+                   proxy_id_code = SKIP)
+      @proxy = proxy unless proxy == SKIP
+      @proxy_id = proxy_id unless proxy_id == SKIP
+      @proxy_id_code = proxy_id_code unless proxy_id_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.
+      proxy = hash.key?('proxy') ? hash['proxy'] : SKIP
+      proxy_id = hash.key?('proxy_id') ? hash['proxy_id'] : SKIP
+      proxy_id_code = hash.key?('proxy_id_code') ? hash['proxy_id_code'] : SKIP
+
+      # Create object from extracted values.
+      BeneficiaryDebtorAccountProxy.new(proxy,
+                                        proxy_id,
+                                        proxy_id_code)
+    end
+  end
+end

data/lib/form3_public_api/models/beneficiary_debtor_organisation_identification.rb

@@ -0,0 +1,84 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # BeneficiaryDebtorOrganisationIdentification Model.
+  class BeneficiaryDebtorOrganisationIdentification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Another ID of the organisation
+    # @return [String]
+    attr_accessor :identification
+
+    # Code for the type of other ID of organisation
+    # @return [String]
+    attr_accessor :identification_code
+
+    # Issuer of the other ID of organisation
+    # @return [String]
+    attr_accessor :identification_issuer
+
+    # Custom internal code for the type of other ID of organisation
+    # @return [String]
+    attr_accessor :identification_scheme
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['identification'] = 'identification'
+      @_hash['identification_code'] = 'identification_code'
+      @_hash['identification_issuer'] = 'identification_issuer'
+      @_hash['identification_scheme'] = 'identification_scheme'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        identification
+        identification_code
+        identification_issuer
+        identification_scheme
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(identification = SKIP,
+                   identification_code = SKIP,
+                   identification_issuer = SKIP,
+                   identification_scheme = SKIP)
+      @identification = identification unless identification == SKIP
+      @identification_code = identification_code unless identification_code == SKIP
+      @identification_issuer = identification_issuer unless identification_issuer == SKIP
+      @identification_scheme = identification_scheme unless identification_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.
+      identification =
+        hash.key?('identification') ? hash['identification'] : SKIP
+      identification_code =
+        hash.key?('identification_code') ? hash['identification_code'] : SKIP
+      identification_issuer =
+        hash.key?('identification_issuer') ? hash['identification_issuer'] : SKIP
+      identification_scheme =
+        hash.key?('identification_scheme') ? hash['identification_scheme'] : SKIP
+
+      # Create object from extracted values.
+      BeneficiaryDebtorOrganisationIdentification.new(identification,
+                                                      identification_code,
+                                                      identification_issuer,
+                                                      identification_scheme)
+    end
+  end
+end

data/lib/form3_public_api/models/beneficiary_party.rb

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

data/lib/form3_public_api/models/beneficiary_party1.rb

@@ -0,0 +1,357 @@
+# form3_public_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Form3PublicApi
+  # BeneficiaryParty1 Model.
+  class BeneficiaryParty1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of beneficiary as given with account
+    # @return [String]
+    attr_accessor :account_name
+
+    # Beneficiary account number
+    # @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 [BeneficiaryDebtorAccountProxy]
+    attr_accessor :account_proxy
+
+    # The type of the account given with `beneficiary_party.account_number`.
+    # Single digit number. Only required if requested by the beneficiary party.
+    # Defaults to 0.
+    # @return [Integer]
+    attr_accessor :account_type
+
+    # The type of the account given with `beneficiary_party.account_number`.
+    # Single digit number. Only required if requested by the beneficiary party.
+    # Defaults to 0.
+    # @return [BeneficiaryDebtorAccountHoldingEntity]
+    attr_accessor :account_with
+
+    # Additional address line of the beneficiary address
+    # @return [String]
+    attr_accessor :additional_address_line
+
+    # Beneficiary address
+    # @return [Array[String]]
+    attr_accessor :address
+
+    # Beneficiary birth city
+    # @return [String]
+    attr_accessor :birth_city
+
+    # Beneficiary birth country, ISO 3166 format country code
+    # @return [String]
+    attr_accessor :birth_country
+
+    # Beneficiary birth date. Formatted according to ISO 8601 format: YYYY-MM-DD
+    # @return [Date]
+    attr_accessor :birth_date
+
+    # Beneficiary birth province
+    # @return [String]
+    attr_accessor :birth_province
+
+    # Building number of the beneficiary address
+    # @return [String]
+    attr_accessor :building_number
+
+    # City/Town of the Beneficiary address
+    # @return [String]
+    attr_accessor :city
+
+    # Country of the beneficiary address, ISO 3166 format country code
+    # @return [String]
+    attr_accessor :country
+
+    # Country of residence of the beneficiary party, ISO 3166 format country
+    # code
+    # @return [String]
+    attr_accessor :country_of_residence
+
+    # Beneficiary name
+    # @return [String]
+    attr_accessor :name
+
+    # Organisation identification of a beneficiary, used in the case that the
+    # 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 beneficiary organisation
+    # @return [Array[BeneficiaryDebtorOrganisationIdentification]]
+    attr_accessor :organisation_identifications
+
+    # Post code of the beneficiary address
+    # @return [String]
+    attr_accessor :post_code
+
+    # Post code of the beneficiary address
+    # @return [PrivateIdentification]
+    attr_accessor :private_identification
+
+    # Province of the beneficiary address
+    # @return [String]
+    attr_accessor :province
+
+    # Street name of the beneficiary address
+    # @return [String]
+    attr_accessor :street_name
+
+    # Beneficiary phone number
+    # @return [String]
+    attr_accessor :telephone_number
+
+    # 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_proxy'] = 'account_proxy'
+      @_hash['account_type'] = 'account_type'
+      @_hash['account_with'] = 'account_with'
+      @_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['telephone_number'] = 'telephone_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        account_number
+        account_number_code
+        account_proxy
+        account_type
+        account_with
+        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
+        telephone_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   account_number = SKIP,
+                   account_number_code = SKIP,
+                   account_proxy = SKIP,
+                   account_type = SKIP,
+                   account_with = SKIP,
+                   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,
+                   telephone_number = 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_proxy = account_proxy unless account_proxy == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @account_with = account_with unless account_with == 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
+      @telephone_number = telephone_number unless telephone_number == 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_proxy = BeneficiaryDebtorAccountProxy.from_hash(hash['account_proxy']) if
+        hash['account_proxy']
+      account_type = hash.key?('account_type') ? hash['account_type'] : SKIP
+      account_with = BeneficiaryDebtorAccountHoldingEntity.from_hash(hash['account_with']) if
+        hash['account_with']
+      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
+      telephone_number =
+        hash.key?('telephone_number') ? hash['telephone_number'] : SKIP
+
+      # Create object from extracted values.
+      BeneficiaryParty1.new(account_name,
+                            account_number,
+                            account_number_code,
+                            account_proxy,
+                            account_type,
+                            account_with,
+                            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,
+                            telephone_number)
+    end
+  end
+end