dataleon 0.1.0.pre.alpha.1

data/rbi/dataleon/models/individuals/document_upload_params.rbi

@@ -0,0 +1,266 @@
+# typed: strong
+
+module Dataleon
+  module Models
+    module Individuals
+      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::Individuals::DocumentUploadParams,
+              Dataleon::Internal::AnyHash
+            )
+          end
+
+        # Filter by document type for upload (must be one of the allowed values)
+        sig do
+          returns(
+            Dataleon::Individuals::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::Individuals::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::Individuals::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::Individuals::DocumentUploadParams::DocumentType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LIASSE_FISCALE =
+            T.let(
+              :liasse_fiscale,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          AMORTISED_LOAN_SCHEDULE =
+            T.let(
+              :amortised_loan_schedule,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          INVOICE =
+            T.let(
+              :invoice,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          RECEIPT =
+            T.let(
+              :receipt,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          COMPANY_STATUTS =
+            T.let(
+              :company_statuts,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          REGISTRATION_COMPANY_CERTIFICATE =
+            T.let(
+              :registration_company_certificate,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          KBIS =
+            T.let(
+              :kbis,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          RIB =
+            T.let(
+              :rib,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          LIVRET_FAMILLE =
+            T.let(
+              :livret_famille,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          BIRTH_CERTIFICATE =
+            T.let(
+              :birth_certificate,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          PAYSLIP =
+            T.let(
+              :payslip,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          SOCIAL_SECURITY_CARD =
+            T.let(
+              :social_security_card,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          VEHICLE_REGISTRATION_CERTIFICATE =
+            T.let(
+              :vehicle_registration_certificate,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          CARTE_GRISE =
+            T.let(
+              :carte_grise,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          CRIMINAL_RECORD_EXTRACT =
+            T.let(
+              :criminal_record_extract,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          PROOF_OF_ADDRESS =
+            T.let(
+              :proof_of_address,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          IDENTITY_CARD_FRONT =
+            T.let(
+              :identity_card_front,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          IDENTITY_CARD_BACK =
+            T.let(
+              :identity_card_back,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          DRIVER_LICENSE_FRONT =
+            T.let(
+              :driver_license_front,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          DRIVER_LICENSE_BACK =
+            T.let(
+              :driver_license_back,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          IDENTITY_DOCUMENT =
+            T.let(
+              :identity_document,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          DRIVER_LICENSE =
+            T.let(
+              :driver_license,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          PASSPORT =
+            T.let(
+              :passport,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          TAX =
+            T.let(
+              :tax,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          CERTIFICATE_OF_INCORPORATION =
+            T.let(
+              :certificate_of_incorporation,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          CERTIFICATE_OF_GOOD_STANDING =
+            T.let(
+              :certificate_of_good_standing,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          LCB_FT_LAB_AML_POLICIES =
+            T.let(
+              :lcb_ft_lab_aml_policies,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          NIU_ENTREPRISE =
+            T.let(
+              :niu_entreprise,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          FINANCIAL_STATEMENTS =
+            T.let(
+              :financial_statements,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          RCCM =
+            T.let(
+              :rccm,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          PROOF_OF_SOURCE_FUNDS =
+            T.let(
+              :proof_of_source_funds,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          ORGANIZATIONAL_CHART =
+            T.let(
+              :organizational_chart,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+          RISK_POLICIES =
+            T.let(
+              :risk_policies,
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dataleon::Individuals::DocumentUploadParams::DocumentType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dataleon/models/individuals/generic_document.rbi

@@ -0,0 +1,252 @@
+# typed: strong
+
+module Dataleon
+  module Models
+    module Individuals
+      class GenericDocument < Dataleon::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dataleon::Individuals::GenericDocument,
+              Dataleon::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier of the document.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # List of verification checks performed on the document.
+        sig { returns(T.nilable(T::Array[Dataleon::Check])) }
+        attr_reader :checks
+
+        sig { params(checks: T::Array[Dataleon::Check::OrHash]).void }
+        attr_writer :checks
+
+        # Timestamp when the document was created or uploaded.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # Type/category of the document.
+        sig { returns(T.nilable(String)) }
+        attr_reader :document_type
+
+        sig { params(document_type: String).void }
+        attr_writer :document_type
+
+        # Name or label for the document.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Signed URL for accessing the document file.
+        sig { returns(T.nilable(String)) }
+        attr_reader :signed_url
+
+        sig { params(signed_url: String).void }
+        attr_writer :signed_url
+
+        # Current processing state of the document (e.g., WAITING, PROCESSED).
+        sig { returns(T.nilable(String)) }
+        attr_reader :state
+
+        sig { params(state: String).void }
+        attr_writer :state
+
+        # Status of the document reception or approval.
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        # List of tables extracted from the document, each containing operations.
+        sig do
+          returns(
+            T.nilable(T::Array[Dataleon::Individuals::GenericDocument::Table])
+          )
+        end
+        attr_reader :tables
+
+        sig do
+          params(
+            tables:
+              T::Array[Dataleon::Individuals::GenericDocument::Table::OrHash]
+          ).void
+        end
+        attr_writer :tables
+
+        # Extracted key-value pairs from the document, including confidence scores.
+        sig do
+          returns(
+            T.nilable(T::Array[Dataleon::Individuals::GenericDocument::Value])
+          )
+        end
+        attr_reader :values
+
+        sig do
+          params(
+            values:
+              T::Array[Dataleon::Individuals::GenericDocument::Value::OrHash]
+          ).void
+        end
+        attr_writer :values
+
+        # Represents a general document with metadata, verification checks, and extracted
+        # data.
+        sig do
+          params(
+            id: String,
+            checks: T::Array[Dataleon::Check::OrHash],
+            created_at: Time,
+            document_type: String,
+            name: String,
+            signed_url: String,
+            state: String,
+            status: String,
+            tables:
+              T::Array[Dataleon::Individuals::GenericDocument::Table::OrHash],
+            values:
+              T::Array[Dataleon::Individuals::GenericDocument::Value::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier of the document.
+          id: nil,
+          # List of verification checks performed on the document.
+          checks: nil,
+          # Timestamp when the document was created or uploaded.
+          created_at: nil,
+          # Type/category of the document.
+          document_type: nil,
+          # Name or label for the document.
+          name: nil,
+          # Signed URL for accessing the document file.
+          signed_url: nil,
+          # Current processing state of the document (e.g., WAITING, PROCESSED).
+          state: nil,
+          # Status of the document reception or approval.
+          status: nil,
+          # List of tables extracted from the document, each containing operations.
+          tables: nil,
+          # Extracted key-value pairs from the document, including confidence scores.
+          values: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              checks: T::Array[Dataleon::Check],
+              created_at: Time,
+              document_type: String,
+              name: String,
+              signed_url: String,
+              state: String,
+              status: String,
+              tables: T::Array[Dataleon::Individuals::GenericDocument::Table],
+              values: T::Array[Dataleon::Individuals::GenericDocument::Value]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Table < Dataleon::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dataleon::Individuals::GenericDocument::Table,
+                Dataleon::Internal::AnyHash
+              )
+            end
+
+          # List of operations or actions associated with the table.
+          sig { returns(T.nilable(T::Array[T.anything])) }
+          attr_reader :operation
+
+          sig { params(operation: T::Array[T.anything]).void }
+          attr_writer :operation
+
+          sig do
+            params(operation: T::Array[T.anything]).returns(T.attached_class)
+          end
+          def self.new(
+            # List of operations or actions associated with the table.
+            operation: nil
+          )
+          end
+
+          sig { override.returns({ operation: T::Array[T.anything] }) }
+          def to_hash
+          end
+        end
+
+        class Value < Dataleon::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dataleon::Individuals::GenericDocument::Value,
+                Dataleon::Internal::AnyHash
+              )
+            end
+
+          # Confidence score (between 0 and 1) for the extracted value.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :confidence
+
+          sig { params(confidence: Float).void }
+          attr_writer :confidence
+
+          # Name or label of the extracted field.
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # List of integer values related to the field (e.g., bounding box coordinates).
+          sig { returns(T.nilable(T::Array[Integer])) }
+          attr_reader :value
+
+          sig { params(value: T::Array[Integer]).void }
+          attr_writer :value
+
+          sig do
+            params(
+              confidence: Float,
+              name: String,
+              value: T::Array[Integer]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Confidence score (between 0 and 1) for the extracted value.
+            confidence: nil,
+            # Name or label of the extracted field.
+            name: nil,
+            # List of integer values related to the field (e.g., bounding box coordinates).
+            value: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { confidence: Float, name: String, value: T::Array[Integer] }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end