dataleon 0.1.0.pre.alpha.1

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    module Individuals
+      # @see Dataleon::Resources::Individuals::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::Individuals::DocumentUploadParams::DocumentType]
+        required :document_type, enum: -> { Dataleon::Individuals::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::Individuals::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/individuals/generic_document.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    module Individuals
+      # @see Dataleon::Resources::Individuals::Documents#upload
+      class GenericDocument < Dataleon::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier of the document.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute checks
+        #   List of verification checks performed on the document.
+        #
+        #   @return [Array<Dataleon::Models::Check>, nil]
+        optional :checks, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Check] }
+
+        # @!attribute created_at
+        #   Timestamp when the document was created or uploaded.
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute document_type
+        #   Type/category of the document.
+        #
+        #   @return [String, nil]
+        optional :document_type, String
+
+        # @!attribute name
+        #   Name or label for the document.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute signed_url
+        #   Signed URL for accessing the document file.
+        #
+        #   @return [String, nil]
+        optional :signed_url, String
+
+        # @!attribute state
+        #   Current processing state of the document (e.g., WAITING, PROCESSED).
+        #
+        #   @return [String, nil]
+        optional :state, String
+
+        # @!attribute status
+        #   Status of the document reception or approval.
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute tables
+        #   List of tables extracted from the document, each containing operations.
+        #
+        #   @return [Array<Dataleon::Models::Individuals::GenericDocument::Table>, nil]
+        optional :tables, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Individuals::GenericDocument::Table] }
+
+        # @!attribute values
+        #   Extracted key-value pairs from the document, including confidence scores.
+        #
+        #   @return [Array<Dataleon::Models::Individuals::GenericDocument::Value>, nil]
+        optional :values, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Individuals::GenericDocument::Value] }
+
+        # @!method initialize(id: nil, checks: nil, created_at: nil, document_type: nil, name: nil, signed_url: nil, state: nil, status: nil, tables: nil, values: nil)
+        #   Represents a general document with metadata, verification checks, and extracted
+        #   data.
+        #
+        #   @param id [String] Unique identifier of the document.
+        #
+        #   @param checks [Array<Dataleon::Models::Check>] List of verification checks performed on the document.
+        #
+        #   @param created_at [Time] Timestamp when the document was created or uploaded.
+        #
+        #   @param document_type [String] Type/category of the document.
+        #
+        #   @param name [String] Name or label for the document.
+        #
+        #   @param signed_url [String] Signed URL for accessing the document file.
+        #
+        #   @param state [String] Current processing state of the document (e.g., WAITING, PROCESSED).
+        #
+        #   @param status [String] Status of the document reception or approval.
+        #
+        #   @param tables [Array<Dataleon::Models::Individuals::GenericDocument::Table>] List of tables extracted from the document, each containing operations.
+        #
+        #   @param values [Array<Dataleon::Models::Individuals::GenericDocument::Value>] Extracted key-value pairs from the document, including confidence scores.
+
+        class Table < Dataleon::Internal::Type::BaseModel
+          # @!attribute operation
+          #   List of operations or actions associated with the table.
+          #
+          #   @return [Array<Object>, nil]
+          optional :operation, Dataleon::Internal::Type::ArrayOf[Dataleon::Internal::Type::Unknown]
+
+          # @!method initialize(operation: nil)
+          #   @param operation [Array<Object>] List of operations or actions associated with the table.
+        end
+
+        class Value < Dataleon::Internal::Type::BaseModel
+          # @!attribute confidence
+          #   Confidence score (between 0 and 1) for the extracted value.
+          #
+          #   @return [Float, nil]
+          optional :confidence, Float
+
+          # @!attribute name
+          #   Name or label of the extracted field.
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute value
+          #   List of integer values related to the field (e.g., bounding box coordinates).
+          #
+          #   @return [Array<Integer>, nil]
+          optional :value, Dataleon::Internal::Type::ArrayOf[Integer]
+
+          # @!method initialize(confidence: nil, name: nil, value: nil)
+          #   @param confidence [Float] Confidence score (between 0 and 1) for the extracted value.
+          #
+          #   @param name [String] Name or label of the extracted field.
+          #
+          #   @param value [Array<Integer>] List of integer values related to the field (e.g., bounding box coordinates).
+        end
+      end
+    end
+  end
+end

data/lib/dataleon/models/individuals/kbis.rb

@@ -0,0 +1,326 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    module Individuals
+      class Kbis < Dataleon::Internal::Type::BaseModel
+        # @!attribute activities
+        #   Declared business activities.
+        #
+        #   @return [String, nil]
+        optional :activities, String
+
+        # @!attribute address
+        #   Official address of the company.
+        #
+        #   @return [String, nil]
+        optional :address, String
+
+        # @!attribute capital_social
+        #   Registered social capital of the company.
+        #
+        #   @return [String, nil]
+        optional :capital_social, String
+
+        # @!attribute closure_date
+        #   Date of closure, if applicable.
+        #
+        #   @return [Date, nil]
+        optional :closure_date, Date
+
+        # @!attribute company_name
+        #   Official name of the company.
+        #
+        #   @return [String, nil]
+        optional :company_name, String
+
+        # @!attribute document_date
+        #   Date when the document was issued.
+        #
+        #   @return [Date, nil]
+        optional :document_date, Date
+
+        # @!attribute document_type
+        #   Fixed identifier for the document type.
+        #
+        #   @return [String, nil]
+        optional :document_type, String
+
+        # @!attribute first_closure_date
+        #   Date of the first fiscal closure.
+        #
+        #   @return [Date, nil]
+        optional :first_closure_date, Date
+
+        # @!attribute from_greffe
+        #   Registry office that issued the document.
+        #
+        #   @return [String, nil]
+        optional :from_greffe, String
+
+        # @!attribute legal_form
+        #   Legal form of the company (e.g., SAS, SARL).
+        #
+        #   @return [String, nil]
+        optional :legal_form, String
+
+        # @!attribute members
+        #   List of people or entities associated with the company.
+        #
+        #   @return [Array<Dataleon::Models::Individuals::Kbis::Member>, nil]
+        optional :members, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Individuals::Kbis::Member] }
+
+        # @!attribute ngestion
+        #   Business registry number or NGestion.
+        #
+        #   @return [String, nil]
+        optional :ngestion, String
+
+        # @!attribute rcs_number
+        #   RCS (Company Registration Number).
+        #
+        #   @return [String, nil]
+        optional :rcs_number, String
+
+        # @!attribute registration_date
+        #   Date of registration with the registry.
+        #
+        #   @return [Date, nil]
+        optional :registration_date, Date
+
+        # @!attribute siren_info
+        #   SIREN number of the company.
+        #
+        #   @return [String, nil]
+        optional :siren_info, String
+
+        # @!method initialize(activities: nil, address: nil, capital_social: nil, closure_date: nil, company_name: nil, document_date: nil, document_type: nil, first_closure_date: nil, from_greffe: nil, legal_form: nil, members: nil, ngestion: nil, rcs_number: nil, registration_date: nil, siren_info: nil)
+        #   A document representing official registration data from the KBIS (France).
+        #
+        #   @param activities [String] Declared business activities.
+        #
+        #   @param address [String] Official address of the company.
+        #
+        #   @param capital_social [String] Registered social capital of the company.
+        #
+        #   @param closure_date [Date] Date of closure, if applicable.
+        #
+        #   @param company_name [String] Official name of the company.
+        #
+        #   @param document_date [Date] Date when the document was issued.
+        #
+        #   @param document_type [String] Fixed identifier for the document type.
+        #
+        #   @param first_closure_date [Date] Date of the first fiscal closure.
+        #
+        #   @param from_greffe [String] Registry office that issued the document.
+        #
+        #   @param legal_form [String] Legal form of the company (e.g., SAS, SARL).
+        #
+        #   @param members [Array<Dataleon::Models::Individuals::Kbis::Member>] List of people or entities associated with the company.
+        #
+        #   @param ngestion [String] Business registry number or NGestion.
+        #
+        #   @param rcs_number [String] RCS (Company Registration Number).
+        #
+        #   @param registration_date [Date] Date of registration with the registry.
+        #
+        #   @param siren_info [String] SIREN number of the company.
+
+        class Member < Dataleon::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique identifier for the member.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute address
+          #   Address of the member.
+          #
+          #   @return [String, nil]
+          optional :address, String
+
+          # @!attribute birthday
+          #   Birth date of the person (only if type = person).
+          #
+          #   @return [Time, nil]
+          optional :birthday, Time
+
+          # @!attribute birthplace
+          #   Place of birth (only if type = person).
+          #
+          #   @return [String, nil]
+          optional :birthplace, String
+
+          # @!attribute country
+          #   Country of residence or registration.
+          #
+          #   @return [String, nil]
+          optional :country, String
+
+          # @!attribute email
+          #   Email address of the member.
+          #
+          #   @return [String, nil]
+          optional :email, String
+
+          # @!attribute first_name
+          #   First name of the person (only if type = person).
+          #
+          #   @return [String, nil]
+          optional :first_name, String
+
+          # @!attribute is_beneficial_owner
+          #   Indicates if this member is a beneficial owner.
+          #
+          #   @return [Boolean, nil]
+          optional :is_beneficial_owner, Dataleon::Internal::Type::Boolean
+
+          # @!attribute is_delegator
+          #   Indicates if this member is a delegator.
+          #
+          #   @return [Boolean, nil]
+          optional :is_delegator, Dataleon::Internal::Type::Boolean
+
+          # @!attribute last_name
+          #   Last name of the person (only if type = person).
+          #
+          #   @return [String, nil]
+          optional :last_name, String
+
+          # @!attribute liveness_verification
+          #   Indicates if the member passed liveness verification.
+          #
+          #   @return [Boolean, nil]
+          optional :liveness_verification, Dataleon::Internal::Type::Boolean
+
+          # @!attribute name
+          #   Name of the company (only if type = company).
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute ownership_percentage
+          #   Ownership percentage held by the member.
+          #
+          #   @return [Integer, nil]
+          optional :ownership_percentage, Integer
+
+          # @!attribute phone_number
+          #   Phone number of the member.
+          #
+          #   @return [String, nil]
+          optional :phone_number, String
+
+          # @!attribute postal_code
+          #   Postal code of the member's address.
+          #
+          #   @return [String, nil]
+          optional :postal_code, String
+
+          # @!attribute registration_id
+          #   Company registration number (if type = company).
+          #
+          #   @return [String, nil]
+          optional :registration_id, String
+
+          # @!attribute relation
+          #   Type of relation (e.g., shareholder, director).
+          #
+          #   @return [String, nil]
+          optional :relation, String
+
+          # @!attribute roles
+          #   Roles held by the member (e.g., legal_representative or shareholder).
+          #
+          #   @return [String, nil]
+          optional :roles, String
+
+          # @!attribute source
+          #   Source of the data (e.g., gouv, user, company).
+          #
+          #   @return [String, nil]
+          optional :source, String
+
+          # @!attribute status
+          #   Current status of the member.
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!attribute type
+          #   Type of entity (company or person).
+          #
+          #   @return [Symbol, Dataleon::Models::Individuals::Kbis::Member::Type, nil]
+          optional :type, enum: -> { Dataleon::Individuals::Kbis::Member::Type }
+
+          # @!attribute workspace_id
+          #   Workspace identifier for internal tracking.
+          #
+          #   @return [String, nil]
+          optional :workspace_id, String
+
+          # @!method initialize(id: nil, address: nil, birthday: nil, birthplace: nil, country: nil, email: nil, first_name: nil, is_beneficial_owner: nil, is_delegator: nil, last_name: nil, liveness_verification: nil, name: nil, ownership_percentage: nil, phone_number: nil, postal_code: nil, registration_id: nil, relation: nil, roles: nil, source: nil, status: nil, type: nil, workspace_id: nil)
+          #   A member (person or entity) associated with the company from a KBIS document.
+          #
+          #   @param id [String] Unique identifier for the member.
+          #
+          #   @param address [String] Address of the member.
+          #
+          #   @param birthday [Time] Birth date of the person (only if type = person).
+          #
+          #   @param birthplace [String] Place of birth (only if type = person).
+          #
+          #   @param country [String] Country of residence or registration.
+          #
+          #   @param email [String] Email address of the member.
+          #
+          #   @param first_name [String] First name of the person (only if type = person).
+          #
+          #   @param is_beneficial_owner [Boolean] Indicates if this member is a beneficial owner.
+          #
+          #   @param is_delegator [Boolean] Indicates if this member is a delegator.
+          #
+          #   @param last_name [String] Last name of the person (only if type = person).
+          #
+          #   @param liveness_verification [Boolean] Indicates if the member passed liveness verification.
+          #
+          #   @param name [String] Name of the company (only if type = company).
+          #
+          #   @param ownership_percentage [Integer] Ownership percentage held by the member.
+          #
+          #   @param phone_number [String] Phone number of the member.
+          #
+          #   @param postal_code [String] Postal code of the member's address.
+          #
+          #   @param registration_id [String] Company registration number (if type = company).
+          #
+          #   @param relation [String] Type of relation (e.g., shareholder, director).
+          #
+          #   @param roles [String] Roles held by the member (e.g., legal_representative or shareholder).
+          #
+          #   @param source [String] Source of the data (e.g., gouv, user, company).
+          #
+          #   @param status [String] Current status of the member.
+          #
+          #   @param type [Symbol, Dataleon::Models::Individuals::Kbis::Member::Type] Type of entity (company or person).
+          #
+          #   @param workspace_id [String] Workspace identifier for internal tracking.
+
+          # Type of entity (company or person).
+          #
+          # @see Dataleon::Models::Individuals::Kbis::Member#type
+          module Type
+            extend Dataleon::Internal::Type::Enum
+
+            COMPANY = :company
+            PERSON = :person
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dataleon/models.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Dataleon
+  [Dataleon::Internal::Type::BaseModel, *Dataleon::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Dataleon::Internal::AnyHash) } }
+  end
+
+  Dataleon::Internal::Util.walk_namespaces(Dataleon::Models).each do |mod|
+    case mod
+    in Dataleon::Internal::Type::Enum | Dataleon::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  Dataleon::Internal::Util.walk_namespaces(Dataleon::Models)
+                          .lazy
+                          .grep(Dataleon::Internal::Type::Union)
+                          .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  Check = Dataleon::Models::Check
+
+  Companies = Dataleon::Models::Companies
+
+  CompanyCreateParams = Dataleon::Models::CompanyCreateParams
+
+  CompanyDeleteParams = Dataleon::Models::CompanyDeleteParams
+
+  CompanyListParams = Dataleon::Models::CompanyListParams
+
+  CompanyRegistration = Dataleon::Models::CompanyRegistration
+
+  CompanyRetrieveParams = Dataleon::Models::CompanyRetrieveParams
+
+  CompanyUpdateParams = Dataleon::Models::CompanyUpdateParams
+
+  Individual = Dataleon::Models::Individual
+
+  IndividualCreateParams = Dataleon::Models::IndividualCreateParams
+
+  IndividualDeleteParams = Dataleon::Models::IndividualDeleteParams
+
+  IndividualListParams = Dataleon::Models::IndividualListParams
+
+  IndividualRetrieveParams = Dataleon::Models::IndividualRetrieveParams
+
+  Individuals = Dataleon::Models::Individuals
+
+  IndividualUpdateParams = Dataleon::Models::IndividualUpdateParams
+end

data/lib/dataleon/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Dataleon
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Dataleon::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [Dataleon::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Dataleon::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, Dataleon::Internal::Type::HashOf[Dataleon::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, Dataleon::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, Dataleon::Internal::Type::HashOf[Dataleon::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(Dataleon::RequestOptions, Dataleon::Internal::AnyHash) }
+    end
+  end
+end