dataleon 0.1.0.pre.alpha.1

data/lib/dataleon/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Internal
+    extend Dataleon::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Dataleon::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Dataleon::FilePart) }
+    end
+  end
+end

data/lib/dataleon/models/check.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    class Check < Dataleon::Internal::Type::BaseModel
+      # @!attribute masked
+      #   Indicates whether the result or data is masked/hidden.
+      #
+      #   @return [Boolean, nil]
+      optional :masked, Dataleon::Internal::Type::Boolean
+
+      # @!attribute message
+      #   Additional message or explanation about the check result.
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute name
+      #   Name or type of the check performed.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute validate
+      #   Result of the check, true if passed.
+      #
+      #   @return [Boolean, nil]
+      optional :validate, Dataleon::Internal::Type::Boolean
+
+      # @!attribute weight
+      #   Importance or weight of the check, often used in scoring.
+      #
+      #   @return [Integer, nil]
+      optional :weight, Integer
+
+      # @!method initialize(masked: nil, message: nil, name: nil, validate: nil, weight: nil)
+      #   Represents a verification check result.
+      #
+      #   @param masked [Boolean] Indicates whether the result or data is masked/hidden.
+      #
+      #   @param message [String] Additional message or explanation about the check result.
+      #
+      #   @param name [String] Name or type of the check performed.
+      #
+      #   @param validate [Boolean] Result of the check, true if passed.
+      #
+      #   @param weight [Integer] Importance or weight of the check, often used in scoring.
+    end
+  end
+end

data/lib/dataleon/models/companies/document_list_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    module Companies
+      # @see Dataleon::Resources::Companies::Documents#list
+      class DocumentListParams < Dataleon::Internal::Type::BaseModel
+        extend Dataleon::Internal::Type::RequestParameters::Converter
+        include Dataleon::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dataleon/models/companies/document_upload_params.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    module Companies
+      # @see Dataleon::Resources::Companies::Documents#upload
+      class DocumentUploadParams < Dataleon::Internal::Type::BaseModel
+        extend Dataleon::Internal::Type::RequestParameters::Converter
+        include Dataleon::Internal::Type::RequestParameters
+
+        # @!attribute document_type
+        #   Filter by document type for upload (must be one of the allowed values)
+        #
+        #   @return [Symbol, Dataleon::Models::Companies::DocumentUploadParams::DocumentType]
+        required :document_type, enum: -> { Dataleon::Companies::DocumentUploadParams::DocumentType }
+
+        # @!attribute file
+        #   File to upload (required)
+        #
+        #   @return [Pathname, StringIO, IO, String, Dataleon::FilePart, nil]
+        optional :file, Dataleon::Internal::Type::FileInput
+
+        # @!attribute url
+        #   URL of the file to upload (either `file` or `url` is required)
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!method initialize(document_type:, file: nil, url: nil, request_options: {})
+        #   @param document_type [Symbol, Dataleon::Models::Companies::DocumentUploadParams::DocumentType] Filter by document type for upload (must be one of the allowed values)
+        #
+        #   @param file [Pathname, StringIO, IO, String, Dataleon::FilePart] File to upload (required)
+        #
+        #   @param url [String] URL of the file to upload (either `file` or `url` is required)
+        #
+        #   @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}]
+
+        # Filter by document type for upload (must be one of the allowed values)
+        module DocumentType
+          extend Dataleon::Internal::Type::Enum
+
+          LIASSE_FISCALE = :liasse_fiscale
+          AMORTISED_LOAN_SCHEDULE = :amortised_loan_schedule
+          INVOICE = :invoice
+          RECEIPT = :receipt
+          COMPANY_STATUTS = :company_statuts
+          REGISTRATION_COMPANY_CERTIFICATE = :registration_company_certificate
+          KBIS = :kbis
+          RIB = :rib
+          LIVRET_FAMILLE = :livret_famille
+          BIRTH_CERTIFICATE = :birth_certificate
+          PAYSLIP = :payslip
+          SOCIAL_SECURITY_CARD = :social_security_card
+          VEHICLE_REGISTRATION_CERTIFICATE = :vehicle_registration_certificate
+          CARTE_GRISE = :carte_grise
+          CRIMINAL_RECORD_EXTRACT = :criminal_record_extract
+          PROOF_OF_ADDRESS = :proof_of_address
+          IDENTITY_CARD_FRONT = :identity_card_front
+          IDENTITY_CARD_BACK = :identity_card_back
+          DRIVER_LICENSE_FRONT = :driver_license_front
+          DRIVER_LICENSE_BACK = :driver_license_back
+          IDENTITY_DOCUMENT = :identity_document
+          DRIVER_LICENSE = :driver_license
+          PASSPORT = :passport
+          TAX = :tax
+          CERTIFICATE_OF_INCORPORATION = :certificate_of_incorporation
+          CERTIFICATE_OF_GOOD_STANDING = :certificate_of_good_standing
+          LCB_FT_LAB_AML_POLICIES = :lcb_ft_lab_aml_policies
+          NIU_ENTREPRISE = :niu_entreprise
+          FINANCIAL_STATEMENTS = :financial_statements
+          RCCM = :rccm
+          PROOF_OF_SOURCE_FUNDS = :proof_of_source_funds
+          ORGANIZATIONAL_CHART = :organizational_chart
+          RISK_POLICIES = :risk_policies
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/dataleon/models/company_create_params.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    # @see Dataleon::Resources::Companies#create
+    class CompanyCreateParams < Dataleon::Internal::Type::BaseModel
+      extend Dataleon::Internal::Type::RequestParameters::Converter
+      include Dataleon::Internal::Type::RequestParameters
+
+      # @!attribute company
+      #   Main information about the company being registered.
+      #
+      #   @return [Dataleon::Models::CompanyCreateParams::Company]
+      required :company, -> { Dataleon::CompanyCreateParams::Company }
+
+      # @!attribute workspace_id
+      #   Unique identifier of the workspace in which the company is being created.
+      #
+      #   @return [String]
+      required :workspace_id, String
+
+      # @!attribute source_id
+      #   Optional identifier to track the origin of the request or integration from your
+      #   system.
+      #
+      #   @return [String, nil]
+      optional :source_id, String
+
+      # @!attribute technical_data
+      #   Technical metadata and callback configuration.
+      #
+      #   @return [Dataleon::Models::CompanyCreateParams::TechnicalData, nil]
+      optional :technical_data, -> { Dataleon::CompanyCreateParams::TechnicalData }
+
+      # @!method initialize(company:, workspace_id:, source_id: nil, technical_data: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dataleon::Models::CompanyCreateParams} for more details.
+      #
+      #   @param company [Dataleon::Models::CompanyCreateParams::Company] Main information about the company being registered.
+      #
+      #   @param workspace_id [String] Unique identifier of the workspace in which the company is being created.
+      #
+      #   @param source_id [String] Optional identifier to track the origin of the request or integration from your
+      #
+      #   @param technical_data [Dataleon::Models::CompanyCreateParams::TechnicalData] Technical metadata and callback configuration.
+      #
+      #   @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}]
+
+      class Company < Dataleon::Internal::Type::BaseModel
+        # @!attribute name
+        #   Legal name of the company.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute address
+        #   Registered address of the company.
+        #
+        #   @return [String, nil]
+        optional :address, String
+
+        # @!attribute commercial_name
+        #   Commercial or trade name of the company, if different from the legal name.
+        #
+        #   @return [String, nil]
+        optional :commercial_name, String
+
+        # @!attribute country
+        #   ISO 3166-1 alpha-2 country code of company registration (e.g., "FR" for France).
+        #
+        #   @return [String, nil]
+        optional :country, String
+
+        # @!attribute email
+        #   Contact email address for the company.
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute employer_identification_number
+        #   Employer Identification Number (EIN) or equivalent.
+        #
+        #   @return [String, nil]
+        optional :employer_identification_number, String
+
+        # @!attribute legal_form
+        #   Legal structure of the company (e.g., SARL, SAS).
+        #
+        #   @return [String, nil]
+        optional :legal_form, String
+
+        # @!attribute phone_number
+        #   Contact phone number for the company.
+        #
+        #   @return [String, nil]
+        optional :phone_number, String
+
+        # @!attribute registration_date
+        #   Date of official company registration in YYYY-MM-DD format.
+        #
+        #   @return [String, nil]
+        optional :registration_date, String
+
+        # @!attribute registration_id
+        #   Official company registration identifier.
+        #
+        #   @return [String, nil]
+        optional :registration_id, String
+
+        # @!attribute share_capital
+        #   Declared share capital of the company, usually in euros.
+        #
+        #   @return [String, nil]
+        optional :share_capital, String
+
+        # @!attribute status
+        #   Current status of the company (e.g., active, inactive).
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute tax_identification_number
+        #   National tax identifier (e.g., VAT or TIN).
+        #
+        #   @return [String, nil]
+        optional :tax_identification_number, String
+
+        # @!attribute type
+        #   Type of company, such as "main" or "affiliated".
+        #
+        #   @return [String, nil]
+        optional :type, String
+
+        # @!attribute website_url
+        #   Company’s official website URL.
+        #
+        #   @return [String, nil]
+        optional :website_url, String
+
+        # @!method initialize(name:, address: nil, commercial_name: nil, country: nil, email: nil, employer_identification_number: nil, legal_form: nil, phone_number: nil, registration_date: nil, registration_id: nil, share_capital: nil, status: nil, tax_identification_number: nil, type: nil, website_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dataleon::Models::CompanyCreateParams::Company} for more details.
+        #
+        #   Main information about the company being registered.
+        #
+        #   @param name [String] Legal name of the company.
+        #
+        #   @param address [String] Registered address of the company.
+        #
+        #   @param commercial_name [String] Commercial or trade name of the company, if different from the legal name.
+        #
+        #   @param country [String] ISO 3166-1 alpha-2 country code of company registration (e.g., "FR" for France).
+        #
+        #   @param email [String] Contact email address for the company.
+        #
+        #   @param employer_identification_number [String] Employer Identification Number (EIN) or equivalent.
+        #
+        #   @param legal_form [String] Legal structure of the company (e.g., SARL, SAS).
+        #
+        #   @param phone_number [String] Contact phone number for the company.
+        #
+        #   @param registration_date [String] Date of official company registration in YYYY-MM-DD format.
+        #
+        #   @param registration_id [String] Official company registration identifier.
+        #
+        #   @param share_capital [String] Declared share capital of the company, usually in euros.
+        #
+        #   @param status [String] Current status of the company (e.g., active, inactive).
+        #
+        #   @param tax_identification_number [String] National tax identifier (e.g., VAT or TIN).
+        #
+        #   @param type [String] Type of company, such as "main" or "affiliated".
+        #
+        #   @param website_url [String] Company’s official website URL.
+      end
+
+      class TechnicalData < Dataleon::Internal::Type::BaseModel
+        # @!attribute active_aml_suspicions
+        #   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.
+        #
+        #   @return [Boolean, nil]
+        optional :active_aml_suspicions, Dataleon::Internal::Type::Boolean
+
+        # @!attribute callback_url
+        #   URL to receive a callback once the company is processed.
+        #
+        #   @return [String, nil]
+        optional :callback_url, String
+
+        # @!attribute callback_url_notification
+        #   URL to receive notifications about the processing state and status.
+        #
+        #   @return [String, nil]
+        optional :callback_url_notification, String
+
+        # @!attribute language
+        #   Preferred language for responses or notifications (e.g., "eng", "fra").
+        #
+        #   @return [String, nil]
+        optional :language, String
+
+        # @!attribute raw_data
+        #   Flag indicating whether to include raw data in the response.
+        #
+        #   @return [Boolean, nil]
+        optional :raw_data, Dataleon::Internal::Type::Boolean
+
+        # @!method initialize(active_aml_suspicions: nil, callback_url: nil, callback_url_notification: nil, language: nil, raw_data: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Dataleon::Models::CompanyCreateParams::TechnicalData} for more details.
+        #
+        #   Technical metadata and callback configuration.
+        #
+        #   @param active_aml_suspicions [Boolean] Flag indicating whether there are active research AML (Anti-Money Laundering) su
+        #
+        #   @param callback_url [String] URL to receive a callback once the company is processed.
+        #
+        #   @param callback_url_notification [String] URL to receive notifications about the processing state and status.
+        #
+        #   @param language [String] Preferred language for responses or notifications (e.g., "eng", "fra").
+        #
+        #   @param raw_data [Boolean] Flag indicating whether to include raw data in the response.
+      end
+    end
+  end
+end

data/lib/dataleon/models/company_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    # @see Dataleon::Resources::Companies#delete
+    class CompanyDeleteParams < Dataleon::Internal::Type::BaseModel
+      extend Dataleon::Internal::Type::RequestParameters::Converter
+      include Dataleon::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dataleon/models/company_list_params.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    # @see Dataleon::Resources::Companies#list
+    class CompanyListParams < Dataleon::Internal::Type::BaseModel
+      extend Dataleon::Internal::Type::RequestParameters::Converter
+      include Dataleon::Internal::Type::RequestParameters
+
+      # @!attribute end_date
+      #   Filter companies created before this date (format YYYY-MM-DD)
+      #
+      #   @return [Date, nil]
+      optional :end_date, Date
+
+      # @!attribute limit
+      #   Number of results to return (between 1 and 100)
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute offset
+      #   Number of results to skip (must be ≥ 0)
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!attribute source_id
+      #   Filter by source ID
+      #
+      #   @return [String, nil]
+      optional :source_id, String
+
+      # @!attribute start_date
+      #   Filter companies created after this date (format YYYY-MM-DD)
+      #
+      #   @return [Date, nil]
+      optional :start_date, Date
+
+      # @!attribute state
+      #   Filter by company state (must be one of the allowed values)
+      #
+      #   @return [Symbol, Dataleon::Models::CompanyListParams::State, nil]
+      optional :state, enum: -> { Dataleon::CompanyListParams::State }
+
+      # @!attribute status
+      #   Filter by individual status (must be one of the allowed values)
+      #
+      #   @return [Symbol, Dataleon::Models::CompanyListParams::Status, nil]
+      optional :status, enum: -> { Dataleon::CompanyListParams::Status }
+
+      # @!attribute workspace_id
+      #   Filter by workspace ID
+      #
+      #   @return [String, nil]
+      optional :workspace_id, String
+
+      # @!method initialize(end_date: nil, limit: nil, offset: nil, source_id: nil, start_date: nil, state: nil, status: nil, workspace_id: nil, request_options: {})
+      #   @param end_date [Date] Filter companies created before this date (format YYYY-MM-DD)
+      #
+      #   @param limit [Integer] Number of results to return (between 1 and 100)
+      #
+      #   @param offset [Integer] Number of results to skip (must be ≥ 0)
+      #
+      #   @param source_id [String] Filter by source ID
+      #
+      #   @param start_date [Date] Filter companies created after this date (format YYYY-MM-DD)
+      #
+      #   @param state [Symbol, Dataleon::Models::CompanyListParams::State] Filter by company state (must be one of the allowed values)
+      #
+      #   @param status [Symbol, Dataleon::Models::CompanyListParams::Status] Filter by individual status (must be one of the allowed values)
+      #
+      #   @param workspace_id [String] Filter by workspace ID
+      #
+      #   @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}]
+
+      # Filter by company state (must be one of the allowed values)
+      module State
+        extend Dataleon::Internal::Type::Enum
+
+        VOID = :VOID
+        WAITING = :WAITING
+        STARTED = :STARTED
+        RUNNING = :RUNNING
+        PROCESSED = :PROCESSED
+        FAILED = :FAILED
+        ABORTED = :ABORTED
+        EXPIRED = :EXPIRED
+        DELETED = :DELETED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Filter by individual status (must be one of the allowed values)
+      module Status
+        extend Dataleon::Internal::Type::Enum
+
+        REJECTED = :rejected
+        NEED_REVIEW = :need_review
+        APPROVED = :approved
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/dataleon/models/company_list_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    # @type [Dataleon::Internal::Type::Converter]
+    CompanyListResponse = Dataleon::Internal::Type::ArrayOf[-> { Dataleon::CompanyRegistration }]
+  end
+end