dataleon 0.1.0.pre.alpha.1

data/rbi/dataleon/models/companies/document_upload_params.rbi

@@ -0,0 +1,266 @@
+# typed: strong
+
+module Dataleon
+  module Models
+    module Companies
+      class DocumentUploadParams < Dataleon::Internal::Type::BaseModel
+        extend Dataleon::Internal::Type::RequestParameters::Converter
+        include Dataleon::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dataleon::Companies::DocumentUploadParams,
+              Dataleon::Internal::AnyHash
+            )
+          end
+
+        # Filter by document type for upload (must be one of the allowed values)
+        sig do
+          returns(
+            Dataleon::Companies::DocumentUploadParams::DocumentType::OrSymbol
+          )
+        end
+        attr_accessor :document_type
+
+        # File to upload (required)
+        sig { returns(T.nilable(Dataleon::Internal::FileInput)) }
+        attr_reader :file
+
+        sig { params(file: Dataleon::Internal::FileInput).void }
+        attr_writer :file
+
+        # URL of the file to upload (either `file` or `url` is required)
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        sig do
+          params(
+            document_type:
+              Dataleon::Companies::DocumentUploadParams::DocumentType::OrSymbol,
+            file: Dataleon::Internal::FileInput,
+            url: String,
+            request_options: Dataleon::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter by document type for upload (must be one of the allowed values)
+          document_type:,
+          # File to upload (required)
+          file: nil,
+          # URL of the file to upload (either `file` or `url` is required)
+          url: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              document_type:
+                Dataleon::Companies::DocumentUploadParams::DocumentType::OrSymbol,
+              file: Dataleon::Internal::FileInput,
+              url: String,
+              request_options: Dataleon::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Filter by document type for upload (must be one of the allowed values)
+        module DocumentType
+          extend Dataleon::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dataleon::Companies::DocumentUploadParams::DocumentType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LIASSE_FISCALE =
+            T.let(
+              :liasse_fiscale,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          AMORTISED_LOAN_SCHEDULE =
+            T.let(
+              :amortised_loan_schedule,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          INVOICE =
+            T.let(
+              :invoice,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          RECEIPT =
+            T.let(
+              :receipt,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          COMPANY_STATUTS =
+            T.let(
+              :company_statuts,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          REGISTRATION_COMPANY_CERTIFICATE =
+            T.let(
+              :registration_company_certificate,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          KBIS =
+            T.let(
+              :kbis,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          RIB =
+            T.let(
+              :rib,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          LIVRET_FAMILLE =
+            T.let(
+              :livret_famille,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          BIRTH_CERTIFICATE =
+            T.let(
+              :birth_certificate,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          PAYSLIP =
+            T.let(
+              :payslip,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          SOCIAL_SECURITY_CARD =
+            T.let(
+              :social_security_card,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          VEHICLE_REGISTRATION_CERTIFICATE =
+            T.let(
+              :vehicle_registration_certificate,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          CARTE_GRISE =
+            T.let(
+              :carte_grise,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          CRIMINAL_RECORD_EXTRACT =
+            T.let(
+              :criminal_record_extract,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          PROOF_OF_ADDRESS =
+            T.let(
+              :proof_of_address,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          IDENTITY_CARD_FRONT =
+            T.let(
+              :identity_card_front,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          IDENTITY_CARD_BACK =
+            T.let(
+              :identity_card_back,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          DRIVER_LICENSE_FRONT =
+            T.let(
+              :driver_license_front,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          DRIVER_LICENSE_BACK =
+            T.let(
+              :driver_license_back,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          IDENTITY_DOCUMENT =
+            T.let(
+              :identity_document,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          DRIVER_LICENSE =
+            T.let(
+              :driver_license,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          PASSPORT =
+            T.let(
+              :passport,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          TAX =
+            T.let(
+              :tax,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          CERTIFICATE_OF_INCORPORATION =
+            T.let(
+              :certificate_of_incorporation,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          CERTIFICATE_OF_GOOD_STANDING =
+            T.let(
+              :certificate_of_good_standing,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          LCB_FT_LAB_AML_POLICIES =
+            T.let(
+              :lcb_ft_lab_aml_policies,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          NIU_ENTREPRISE =
+            T.let(
+              :niu_entreprise,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          FINANCIAL_STATEMENTS =
+            T.let(
+              :financial_statements,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          RCCM =
+            T.let(
+              :rccm,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          PROOF_OF_SOURCE_FUNDS =
+            T.let(
+              :proof_of_source_funds,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          ORGANIZATIONAL_CHART =
+            T.let(
+              :organizational_chart,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          RISK_POLICIES =
+            T.let(
+              :risk_policies,
+              Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dataleon::Companies::DocumentUploadParams::DocumentType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dataleon/models/company_create_params.rbi

@@ -0,0 +1,361 @@
+# typed: strong
+
+module Dataleon
+  module Models
+    class CompanyCreateParams < Dataleon::Internal::Type::BaseModel
+      extend Dataleon::Internal::Type::RequestParameters::Converter
+      include Dataleon::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Dataleon::CompanyCreateParams, Dataleon::Internal::AnyHash)
+        end
+
+      # Main information about the company being registered.
+      sig { returns(Dataleon::CompanyCreateParams::Company) }
+      attr_reader :company
+
+      sig do
+        params(company: Dataleon::CompanyCreateParams::Company::OrHash).void
+      end
+      attr_writer :company
+
+      # Unique identifier of the workspace in which the company is being created.
+      sig { returns(String) }
+      attr_accessor :workspace_id
+
+      # Optional identifier to track the origin of the request or integration from your
+      # system.
+      sig { returns(T.nilable(String)) }
+      attr_reader :source_id
+
+      sig { params(source_id: String).void }
+      attr_writer :source_id
+
+      # Technical metadata and callback configuration.
+      sig { returns(T.nilable(Dataleon::CompanyCreateParams::TechnicalData)) }
+      attr_reader :technical_data
+
+      sig do
+        params(
+          technical_data: Dataleon::CompanyCreateParams::TechnicalData::OrHash
+        ).void
+      end
+      attr_writer :technical_data
+
+      sig do
+        params(
+          company: Dataleon::CompanyCreateParams::Company::OrHash,
+          workspace_id: String,
+          source_id: String,
+          technical_data: Dataleon::CompanyCreateParams::TechnicalData::OrHash,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Main information about the company being registered.
+        company:,
+        # Unique identifier of the workspace in which the company is being created.
+        workspace_id:,
+        # Optional identifier to track the origin of the request or integration from your
+        # system.
+        source_id: nil,
+        # Technical metadata and callback configuration.
+        technical_data: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            company: Dataleon::CompanyCreateParams::Company,
+            workspace_id: String,
+            source_id: String,
+            technical_data: Dataleon::CompanyCreateParams::TechnicalData,
+            request_options: Dataleon::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Company < Dataleon::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dataleon::CompanyCreateParams::Company,
+              Dataleon::Internal::AnyHash
+            )
+          end
+
+        # Legal name of the company.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Registered address of the company.
+        sig { returns(T.nilable(String)) }
+        attr_reader :address
+
+        sig { params(address: String).void }
+        attr_writer :address
+
+        # Commercial or trade name of the company, if different from the legal name.
+        sig { returns(T.nilable(String)) }
+        attr_reader :commercial_name
+
+        sig { params(commercial_name: String).void }
+        attr_writer :commercial_name
+
+        # ISO 3166-1 alpha-2 country code of company registration (e.g., "FR" for France).
+        sig { returns(T.nilable(String)) }
+        attr_reader :country
+
+        sig { params(country: String).void }
+        attr_writer :country
+
+        # Contact email address for the company.
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
+        # Employer Identification Number (EIN) or equivalent.
+        sig { returns(T.nilable(String)) }
+        attr_reader :employer_identification_number
+
+        sig { params(employer_identification_number: String).void }
+        attr_writer :employer_identification_number
+
+        # Legal structure of the company (e.g., SARL, SAS).
+        sig { returns(T.nilable(String)) }
+        attr_reader :legal_form
+
+        sig { params(legal_form: String).void }
+        attr_writer :legal_form
+
+        # Contact phone number for the company.
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        # Date of official company registration in YYYY-MM-DD format.
+        sig { returns(T.nilable(String)) }
+        attr_reader :registration_date
+
+        sig { params(registration_date: String).void }
+        attr_writer :registration_date
+
+        # Official company registration identifier.
+        sig { returns(T.nilable(String)) }
+        attr_reader :registration_id
+
+        sig { params(registration_id: String).void }
+        attr_writer :registration_id
+
+        # Declared share capital of the company, usually in euros.
+        sig { returns(T.nilable(String)) }
+        attr_reader :share_capital
+
+        sig { params(share_capital: String).void }
+        attr_writer :share_capital
+
+        # Current status of the company (e.g., active, inactive).
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        # National tax identifier (e.g., VAT or TIN).
+        sig { returns(T.nilable(String)) }
+        attr_reader :tax_identification_number
+
+        sig { params(tax_identification_number: String).void }
+        attr_writer :tax_identification_number
+
+        # Type of company, such as "main" or "affiliated".
+        sig { returns(T.nilable(String)) }
+        attr_reader :type
+
+        sig { params(type: String).void }
+        attr_writer :type
+
+        # Company’s official website URL.
+        sig { returns(T.nilable(String)) }
+        attr_reader :website_url
+
+        sig { params(website_url: String).void }
+        attr_writer :website_url
+
+        # Main information about the company being registered.
+        sig do
+          params(
+            name: String,
+            address: String,
+            commercial_name: String,
+            country: String,
+            email: String,
+            employer_identification_number: String,
+            legal_form: String,
+            phone_number: String,
+            registration_date: String,
+            registration_id: String,
+            share_capital: String,
+            status: String,
+            tax_identification_number: String,
+            type: String,
+            website_url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Legal name of the company.
+          name:,
+          # Registered address of the company.
+          address: nil,
+          # Commercial or trade name of the company, if different from the legal name.
+          commercial_name: nil,
+          # ISO 3166-1 alpha-2 country code of company registration (e.g., "FR" for France).
+          country: nil,
+          # Contact email address for the company.
+          email: nil,
+          # Employer Identification Number (EIN) or equivalent.
+          employer_identification_number: nil,
+          # Legal structure of the company (e.g., SARL, SAS).
+          legal_form: nil,
+          # Contact phone number for the company.
+          phone_number: nil,
+          # Date of official company registration in YYYY-MM-DD format.
+          registration_date: nil,
+          # Official company registration identifier.
+          registration_id: nil,
+          # Declared share capital of the company, usually in euros.
+          share_capital: nil,
+          # Current status of the company (e.g., active, inactive).
+          status: nil,
+          # National tax identifier (e.g., VAT or TIN).
+          tax_identification_number: nil,
+          # Type of company, such as "main" or "affiliated".
+          type: nil,
+          # Company’s official website URL.
+          website_url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              name: String,
+              address: String,
+              commercial_name: String,
+              country: String,
+              email: String,
+              employer_identification_number: String,
+              legal_form: String,
+              phone_number: String,
+              registration_date: String,
+              registration_id: String,
+              share_capital: String,
+              status: String,
+              tax_identification_number: String,
+              type: String,
+              website_url: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class TechnicalData < Dataleon::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dataleon::CompanyCreateParams::TechnicalData,
+              Dataleon::Internal::AnyHash
+            )
+          end
+
+        # Flag indicating whether there are active research AML (Anti-Money Laundering)
+        # suspicions for the company when you apply for a new entry or get an existing
+        # one.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :active_aml_suspicions
+
+        sig { params(active_aml_suspicions: T::Boolean).void }
+        attr_writer :active_aml_suspicions
+
+        # URL to receive a callback once the company is processed.
+        sig { returns(T.nilable(String)) }
+        attr_reader :callback_url
+
+        sig { params(callback_url: String).void }
+        attr_writer :callback_url
+
+        # URL to receive notifications about the processing state and status.
+        sig { returns(T.nilable(String)) }
+        attr_reader :callback_url_notification
+
+        sig { params(callback_url_notification: String).void }
+        attr_writer :callback_url_notification
+
+        # Preferred language for responses or notifications (e.g., "eng", "fra").
+        sig { returns(T.nilable(String)) }
+        attr_reader :language
+
+        sig { params(language: String).void }
+        attr_writer :language
+
+        # Flag indicating whether to include raw data in the response.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :raw_data
+
+        sig { params(raw_data: T::Boolean).void }
+        attr_writer :raw_data
+
+        # Technical metadata and callback configuration.
+        sig do
+          params(
+            active_aml_suspicions: T::Boolean,
+            callback_url: String,
+            callback_url_notification: String,
+            language: String,
+            raw_data: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Flag indicating whether there are active research AML (Anti-Money Laundering)
+          # suspicions for the company when you apply for a new entry or get an existing
+          # one.
+          active_aml_suspicions: nil,
+          # URL to receive a callback once the company is processed.
+          callback_url: nil,
+          # URL to receive notifications about the processing state and status.
+          callback_url_notification: nil,
+          # Preferred language for responses or notifications (e.g., "eng", "fra").
+          language: nil,
+          # Flag indicating whether to include raw data in the response.
+          raw_data: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              active_aml_suspicions: T::Boolean,
+              callback_url: String,
+              callback_url_notification: String,
+              language: String,
+              raw_data: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/dataleon/models/company_delete_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Dataleon
+  module Models
+    class CompanyDeleteParams < Dataleon::Internal::Type::BaseModel
+      extend Dataleon::Internal::Type::RequestParameters::Converter
+      include Dataleon::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Dataleon::CompanyDeleteParams, Dataleon::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Dataleon::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Dataleon::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end