dataleon 0.1.0.pre.alpha.1

data/rbi/dataleon/models/individual_update_params.rbi

@@ -0,0 +1,323 @@
+# typed: strong
+
+module Dataleon
+  module Models
+    class IndividualUpdateParams < Dataleon::Internal::Type::BaseModel
+      extend Dataleon::Internal::Type::RequestParameters::Converter
+      include Dataleon::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Dataleon::IndividualUpdateParams, Dataleon::Internal::AnyHash)
+        end
+
+      # Unique identifier of the workspace where the individual is being registered.
+      sig { returns(String) }
+      attr_accessor :workspace_id
+
+      # Personal information about the individual.
+      sig { returns(T.nilable(Dataleon::IndividualUpdateParams::Person)) }
+      attr_reader :person
+
+      sig do
+        params(person: Dataleon::IndividualUpdateParams::Person::OrHash).void
+      end
+      attr_writer :person
+
+      # Optional identifier for tracking the source system 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 related to the request or processing.
+      sig do
+        returns(T.nilable(Dataleon::IndividualUpdateParams::TechnicalData))
+      end
+      attr_reader :technical_data
+
+      sig do
+        params(
+          technical_data:
+            Dataleon::IndividualUpdateParams::TechnicalData::OrHash
+        ).void
+      end
+      attr_writer :technical_data
+
+      sig do
+        params(
+          workspace_id: String,
+          person: Dataleon::IndividualUpdateParams::Person::OrHash,
+          source_id: String,
+          technical_data:
+            Dataleon::IndividualUpdateParams::TechnicalData::OrHash,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier of the workspace where the individual is being registered.
+        workspace_id:,
+        # Personal information about the individual.
+        person: nil,
+        # Optional identifier for tracking the source system or integration from your
+        # system.
+        source_id: nil,
+        # Technical metadata related to the request or processing.
+        technical_data: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            workspace_id: String,
+            person: Dataleon::IndividualUpdateParams::Person,
+            source_id: String,
+            technical_data: Dataleon::IndividualUpdateParams::TechnicalData,
+            request_options: Dataleon::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Person < Dataleon::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dataleon::IndividualUpdateParams::Person,
+              Dataleon::Internal::AnyHash
+            )
+          end
+
+        # Date of birth in DD/MM/YYYY format.
+        sig { returns(T.nilable(String)) }
+        attr_reader :birthday
+
+        sig { params(birthday: String).void }
+        attr_writer :birthday
+
+        # Email address of the individual.
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
+        # First name of the individual.
+        sig { returns(T.nilable(String)) }
+        attr_reader :first_name
+
+        sig { params(first_name: String).void }
+        attr_writer :first_name
+
+        # Gender of the individual (M for male, F for female).
+        sig do
+          returns(
+            T.nilable(
+              Dataleon::IndividualUpdateParams::Person::Gender::OrSymbol
+            )
+          )
+        end
+        attr_reader :gender
+
+        sig do
+          params(
+            gender: Dataleon::IndividualUpdateParams::Person::Gender::OrSymbol
+          ).void
+        end
+        attr_writer :gender
+
+        # Last name (family name) of the individual.
+        sig { returns(T.nilable(String)) }
+        attr_reader :last_name
+
+        sig { params(last_name: String).void }
+        attr_writer :last_name
+
+        # Maiden name, if applicable.
+        sig { returns(T.nilable(String)) }
+        attr_reader :maiden_name
+
+        sig { params(maiden_name: String).void }
+        attr_writer :maiden_name
+
+        # Phone number of the individual.
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        # Personal information about the individual.
+        sig do
+          params(
+            birthday: String,
+            email: String,
+            first_name: String,
+            gender: Dataleon::IndividualUpdateParams::Person::Gender::OrSymbol,
+            last_name: String,
+            maiden_name: String,
+            phone_number: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Date of birth in DD/MM/YYYY format.
+          birthday: nil,
+          # Email address of the individual.
+          email: nil,
+          # First name of the individual.
+          first_name: nil,
+          # Gender of the individual (M for male, F for female).
+          gender: nil,
+          # Last name (family name) of the individual.
+          last_name: nil,
+          # Maiden name, if applicable.
+          maiden_name: nil,
+          # Phone number of the individual.
+          phone_number: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              birthday: String,
+              email: String,
+              first_name: String,
+              gender:
+                Dataleon::IndividualUpdateParams::Person::Gender::OrSymbol,
+              last_name: String,
+              maiden_name: String,
+              phone_number: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Gender of the individual (M for male, F for female).
+        module Gender
+          extend Dataleon::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Dataleon::IndividualUpdateParams::Person::Gender)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          M =
+            T.let(
+              :M,
+              Dataleon::IndividualUpdateParams::Person::Gender::TaggedSymbol
+            )
+          F =
+            T.let(
+              :F,
+              Dataleon::IndividualUpdateParams::Person::Gender::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dataleon::IndividualUpdateParams::Person::Gender::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class TechnicalData < Dataleon::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dataleon::IndividualUpdateParams::TechnicalData,
+              Dataleon::Internal::AnyHash
+            )
+          end
+
+        # Flag indicating whether there are active research AML (Anti-Money Laundering)
+        # suspicions for the individual 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 call back upon completion of processing.
+        sig { returns(T.nilable(String)) }
+        attr_reader :callback_url
+
+        sig { params(callback_url: String).void }
+        attr_writer :callback_url
+
+        # URL for receive notifications about the processing state or 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 communication (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 related to the request or processing.
+        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 individual when you apply for a new entry or get an existing
+          # one.
+          active_aml_suspicions: nil,
+          # URL to call back upon completion of processing.
+          callback_url: nil,
+          # URL for receive notifications about the processing state or status.
+          callback_url_notification: nil,
+          # Preferred language for communication (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/individuals/document_list_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Dataleon
+  module Models
+    module Individuals
+      class DocumentListParams < Dataleon::Internal::Type::BaseModel
+        extend Dataleon::Internal::Type::RequestParameters::Converter
+        include Dataleon::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dataleon::Individuals::DocumentListParams,
+              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
+end

data/rbi/dataleon/models/individuals/document_response.rbi

@@ -0,0 +1,190 @@
+# typed: strong
+
+module Dataleon
+  module Models
+    module Individuals
+      class DocumentResponse < Dataleon::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dataleon::Individuals::DocumentResponse,
+              Dataleon::Internal::AnyHash
+            )
+          end
+
+        # List of documents associated with the response.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Dataleon::Individuals::DocumentResponse::Document]
+            )
+          )
+        end
+        attr_reader :documents
+
+        sig do
+          params(
+            documents:
+              T::Array[
+                Dataleon::Individuals::DocumentResponse::Document::OrHash
+              ]
+          ).void
+        end
+        attr_writer :documents
+
+        # Total number of documents available in the response.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :total_document
+
+        sig { params(total_document: Integer).void }
+        attr_writer :total_document
+
+        sig do
+          params(
+            documents:
+              T::Array[
+                Dataleon::Individuals::DocumentResponse::Document::OrHash
+              ],
+            total_document: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # List of documents associated with the response.
+          documents: nil,
+          # Total number of documents available in the response.
+          total_document: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              documents:
+                T::Array[Dataleon::Individuals::DocumentResponse::Document],
+              total_document: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Document < Dataleon::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dataleon::Individuals::DocumentResponse::Document,
+                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
+
+          # Functional type of the document (e.g., identity document, invoice).
+          sig { returns(T.nilable(String)) }
+          attr_reader :document_type
+
+          sig { params(document_type: String).void }
+          attr_writer :document_type
+
+          # Original filename of the uploaded document.
+          sig { returns(T.nilable(String)) }
+          attr_reader :filename
+
+          sig { params(filename: String).void }
+          attr_writer :filename
+
+          # Human-readable name of the document.
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # Secure URL to access the document.
+          sig { returns(T.nilable(String)) }
+          attr_reader :signed_url
+
+          sig { params(signed_url: String).void }
+          attr_writer :signed_url
+
+          # Processing state of the document (e.g., WAITING, STARTED, RUNNING, PROCESSED).
+          sig { returns(T.nilable(String)) }
+          attr_reader :state
+
+          sig { params(state: String).void }
+          attr_writer :state
+
+          # Validation status of the document (e.g., need_review, approved, rejected).
+          sig { returns(T.nilable(String)) }
+          attr_reader :status
+
+          sig { params(status: String).void }
+          attr_writer :status
+
+          # Identifier of the workspace to which the document belongs.
+          sig { returns(T.nilable(String)) }
+          attr_reader :workspace_id
+
+          sig { params(workspace_id: String).void }
+          attr_writer :workspace_id
+
+          # Represents a document stored and processed by the system, such as an identity
+          # card or a PDF contract.
+          sig do
+            params(
+              id: String,
+              document_type: String,
+              filename: String,
+              name: String,
+              signed_url: String,
+              state: String,
+              status: String,
+              workspace_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Unique identifier of the document.
+            id: nil,
+            # Functional type of the document (e.g., identity document, invoice).
+            document_type: nil,
+            # Original filename of the uploaded document.
+            filename: nil,
+            # Human-readable name of the document.
+            name: nil,
+            # Secure URL to access the document.
+            signed_url: nil,
+            # Processing state of the document (e.g., WAITING, STARTED, RUNNING, PROCESSED).
+            state: nil,
+            # Validation status of the document (e.g., need_review, approved, rejected).
+            status: nil,
+            # Identifier of the workspace to which the document belongs.
+            workspace_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                document_type: String,
+                filename: String,
+                name: String,
+                signed_url: String,
+                state: String,
+                status: String,
+                workspace_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end