dataleon 0.1.0.pre.alpha.1

data/lib/dataleon/models/individual_create_params.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    # @see Dataleon::Resources::Individuals#create
+    class IndividualCreateParams < Dataleon::Internal::Type::BaseModel
+      extend Dataleon::Internal::Type::RequestParameters::Converter
+      include Dataleon::Internal::Type::RequestParameters
+
+      # @!attribute workspace_id
+      #   Unique identifier of the workspace where the individual is being registered.
+      #
+      #   @return [String]
+      required :workspace_id, String
+
+      # @!attribute person
+      #   Personal information about the individual.
+      #
+      #   @return [Dataleon::Models::IndividualCreateParams::Person, nil]
+      optional :person, -> { Dataleon::IndividualCreateParams::Person }
+
+      # @!attribute source_id
+      #   Optional identifier for tracking the source system or integration from your
+      #   system.
+      #
+      #   @return [String, nil]
+      optional :source_id, String
+
+      # @!attribute technical_data
+      #   Technical metadata related to the request or processing.
+      #
+      #   @return [Dataleon::Models::IndividualCreateParams::TechnicalData, nil]
+      optional :technical_data, -> { Dataleon::IndividualCreateParams::TechnicalData }
+
+      # @!method initialize(workspace_id:, person: nil, source_id: nil, technical_data: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dataleon::Models::IndividualCreateParams} for more details.
+      #
+      #   @param workspace_id [String] Unique identifier of the workspace where the individual is being registered.
+      #
+      #   @param person [Dataleon::Models::IndividualCreateParams::Person] Personal information about the individual.
+      #
+      #   @param source_id [String] Optional identifier for tracking the source system or integration from your syst
+      #
+      #   @param technical_data [Dataleon::Models::IndividualCreateParams::TechnicalData] Technical metadata related to the request or processing.
+      #
+      #   @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}]
+
+      class Person < Dataleon::Internal::Type::BaseModel
+        # @!attribute birthday
+        #   Date of birth in DD/MM/YYYY format.
+        #
+        #   @return [String, nil]
+        optional :birthday, String
+
+        # @!attribute email
+        #   Email address of the individual.
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute first_name
+        #   First name of the individual.
+        #
+        #   @return [String, nil]
+        optional :first_name, String
+
+        # @!attribute gender
+        #   Gender of the individual (M for male, F for female).
+        #
+        #   @return [Symbol, Dataleon::Models::IndividualCreateParams::Person::Gender, nil]
+        optional :gender, enum: -> { Dataleon::IndividualCreateParams::Person::Gender }
+
+        # @!attribute last_name
+        #   Last name (family name) of the individual.
+        #
+        #   @return [String, nil]
+        optional :last_name, String
+
+        # @!attribute maiden_name
+        #   Maiden name, if applicable.
+        #
+        #   @return [String, nil]
+        optional :maiden_name, String
+
+        # @!attribute phone_number
+        #   Phone number of the individual.
+        #
+        #   @return [String, nil]
+        optional :phone_number, String
+
+        # @!method initialize(birthday: nil, email: nil, first_name: nil, gender: nil, last_name: nil, maiden_name: nil, phone_number: nil)
+        #   Personal information about the individual.
+        #
+        #   @param birthday [String] Date of birth in DD/MM/YYYY format.
+        #
+        #   @param email [String] Email address of the individual.
+        #
+        #   @param first_name [String] First name of the individual.
+        #
+        #   @param gender [Symbol, Dataleon::Models::IndividualCreateParams::Person::Gender] Gender of the individual (M for male, F for female).
+        #
+        #   @param last_name [String] Last name (family name) of the individual.
+        #
+        #   @param maiden_name [String] Maiden name, if applicable.
+        #
+        #   @param phone_number [String] Phone number of the individual.
+
+        # Gender of the individual (M for male, F for female).
+        #
+        # @see Dataleon::Models::IndividualCreateParams::Person#gender
+        module Gender
+          extend Dataleon::Internal::Type::Enum
+
+          M = :M
+          F = :F
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      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 individual 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 call back upon completion of processing.
+        #
+        #   @return [String, nil]
+        optional :callback_url, String
+
+        # @!attribute callback_url_notification
+        #   URL for receive notifications about the processing state or status.
+        #
+        #   @return [String, nil]
+        optional :callback_url_notification, String
+
+        # @!attribute language
+        #   Preferred language for communication (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::IndividualCreateParams::TechnicalData} for more details.
+        #
+        #   Technical metadata related to the request or processing.
+        #
+        #   @param active_aml_suspicions [Boolean] Flag indicating whether there are active research AML (Anti-Money Laundering) su
+        #
+        #   @param callback_url [String] URL to call back upon completion of processing.
+        #
+        #   @param callback_url_notification [String] URL for receive notifications about the processing state or status.
+        #
+        #   @param language [String] Preferred language for communication (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/individual_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    # @see Dataleon::Resources::Individuals#delete
+    class IndividualDeleteParams < 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/individual_list_params.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    # @see Dataleon::Resources::Individuals#list
+    class IndividualListParams < Dataleon::Internal::Type::BaseModel
+      extend Dataleon::Internal::Type::RequestParameters::Converter
+      include Dataleon::Internal::Type::RequestParameters
+
+      # @!attribute end_date
+      #   Filter individuals 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 offset (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 individuals created after this date (format YYYY-MM-DD)
+      #
+      #   @return [Date, nil]
+      optional :start_date, Date
+
+      # @!attribute state
+      #   Filter by individual status (must be one of the allowed values)
+      #
+      #   @return [Symbol, Dataleon::Models::IndividualListParams::State, nil]
+      optional :state, enum: -> { Dataleon::IndividualListParams::State }
+
+      # @!attribute status
+      #   Filter by individual status (must be one of the allowed values)
+      #
+      #   @return [Symbol, Dataleon::Models::IndividualListParams::Status, nil]
+      optional :status, enum: -> { Dataleon::IndividualListParams::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 individuals 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 offset (must be ≥ 0)
+      #
+      #   @param source_id [String] Filter by source ID
+      #
+      #   @param start_date [Date] Filter individuals created after this date (format YYYY-MM-DD)
+      #
+      #   @param state [Symbol, Dataleon::Models::IndividualListParams::State] Filter by individual status (must be one of the allowed values)
+      #
+      #   @param status [Symbol, Dataleon::Models::IndividualListParams::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 individual status (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/individual_list_response.rb

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

data/lib/dataleon/models/individual_retrieve_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    # @see Dataleon::Resources::Individuals#retrieve
+    class IndividualRetrieveParams < Dataleon::Internal::Type::BaseModel
+      extend Dataleon::Internal::Type::RequestParameters::Converter
+      include Dataleon::Internal::Type::RequestParameters
+
+      # @!attribute document
+      #   Include document information
+      #
+      #   @return [Boolean, nil]
+      optional :document, Dataleon::Internal::Type::Boolean
+
+      # @!attribute scope
+      #   Scope filter (id or scope)
+      #
+      #   @return [String, nil]
+      optional :scope, String
+
+      # @!method initialize(document: nil, scope: nil, request_options: {})
+      #   @param document [Boolean] Include document information
+      #
+      #   @param scope [String] Scope filter (id or scope)
+      #
+      #   @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dataleon/models/individual_update_params.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    # @see Dataleon::Resources::Individuals#update
+    class IndividualUpdateParams < Dataleon::Internal::Type::BaseModel
+      extend Dataleon::Internal::Type::RequestParameters::Converter
+      include Dataleon::Internal::Type::RequestParameters
+
+      # @!attribute workspace_id
+      #   Unique identifier of the workspace where the individual is being registered.
+      #
+      #   @return [String]
+      required :workspace_id, String
+
+      # @!attribute person
+      #   Personal information about the individual.
+      #
+      #   @return [Dataleon::Models::IndividualUpdateParams::Person, nil]
+      optional :person, -> { Dataleon::IndividualUpdateParams::Person }
+
+      # @!attribute source_id
+      #   Optional identifier for tracking the source system or integration from your
+      #   system.
+      #
+      #   @return [String, nil]
+      optional :source_id, String
+
+      # @!attribute technical_data
+      #   Technical metadata related to the request or processing.
+      #
+      #   @return [Dataleon::Models::IndividualUpdateParams::TechnicalData, nil]
+      optional :technical_data, -> { Dataleon::IndividualUpdateParams::TechnicalData }
+
+      # @!method initialize(workspace_id:, person: nil, source_id: nil, technical_data: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dataleon::Models::IndividualUpdateParams} for more details.
+      #
+      #   @param workspace_id [String] Unique identifier of the workspace where the individual is being registered.
+      #
+      #   @param person [Dataleon::Models::IndividualUpdateParams::Person] Personal information about the individual.
+      #
+      #   @param source_id [String] Optional identifier for tracking the source system or integration from your syst
+      #
+      #   @param technical_data [Dataleon::Models::IndividualUpdateParams::TechnicalData] Technical metadata related to the request or processing.
+      #
+      #   @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}]
+
+      class Person < Dataleon::Internal::Type::BaseModel
+        # @!attribute birthday
+        #   Date of birth in DD/MM/YYYY format.
+        #
+        #   @return [String, nil]
+        optional :birthday, String
+
+        # @!attribute email
+        #   Email address of the individual.
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute first_name
+        #   First name of the individual.
+        #
+        #   @return [String, nil]
+        optional :first_name, String
+
+        # @!attribute gender
+        #   Gender of the individual (M for male, F for female).
+        #
+        #   @return [Symbol, Dataleon::Models::IndividualUpdateParams::Person::Gender, nil]
+        optional :gender, enum: -> { Dataleon::IndividualUpdateParams::Person::Gender }
+
+        # @!attribute last_name
+        #   Last name (family name) of the individual.
+        #
+        #   @return [String, nil]
+        optional :last_name, String
+
+        # @!attribute maiden_name
+        #   Maiden name, if applicable.
+        #
+        #   @return [String, nil]
+        optional :maiden_name, String
+
+        # @!attribute phone_number
+        #   Phone number of the individual.
+        #
+        #   @return [String, nil]
+        optional :phone_number, String
+
+        # @!method initialize(birthday: nil, email: nil, first_name: nil, gender: nil, last_name: nil, maiden_name: nil, phone_number: nil)
+        #   Personal information about the individual.
+        #
+        #   @param birthday [String] Date of birth in DD/MM/YYYY format.
+        #
+        #   @param email [String] Email address of the individual.
+        #
+        #   @param first_name [String] First name of the individual.
+        #
+        #   @param gender [Symbol, Dataleon::Models::IndividualUpdateParams::Person::Gender] Gender of the individual (M for male, F for female).
+        #
+        #   @param last_name [String] Last name (family name) of the individual.
+        #
+        #   @param maiden_name [String] Maiden name, if applicable.
+        #
+        #   @param phone_number [String] Phone number of the individual.
+
+        # Gender of the individual (M for male, F for female).
+        #
+        # @see Dataleon::Models::IndividualUpdateParams::Person#gender
+        module Gender
+          extend Dataleon::Internal::Type::Enum
+
+          M = :M
+          F = :F
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      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 individual 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 call back upon completion of processing.
+        #
+        #   @return [String, nil]
+        optional :callback_url, String
+
+        # @!attribute callback_url_notification
+        #   URL for receive notifications about the processing state or status.
+        #
+        #   @return [String, nil]
+        optional :callback_url_notification, String
+
+        # @!attribute language
+        #   Preferred language for communication (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::IndividualUpdateParams::TechnicalData} for more details.
+        #
+        #   Technical metadata related to the request or processing.
+        #
+        #   @param active_aml_suspicions [Boolean] Flag indicating whether there are active research AML (Anti-Money Laundering) su
+        #
+        #   @param callback_url [String] URL to call back upon completion of processing.
+        #
+        #   @param callback_url_notification [String] URL for receive notifications about the processing state or status.
+        #
+        #   @param language [String] Preferred language for communication (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/individuals/document_list_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    module Individuals
+      # @see Dataleon::Resources::Individuals::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/individuals/document_response.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Models
+    module Individuals
+      # @see Dataleon::Resources::Individuals::Documents#list
+      class DocumentResponse < Dataleon::Internal::Type::BaseModel
+        # @!attribute documents
+        #   List of documents associated with the response.
+        #
+        #   @return [Array<Dataleon::Models::Individuals::DocumentResponse::Document>, nil]
+        optional :documents,
+                 -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Individuals::DocumentResponse::Document] }
+
+        # @!attribute total_document
+        #   Total number of documents available in the response.
+        #
+        #   @return [Integer, nil]
+        optional :total_document, Integer
+
+        # @!method initialize(documents: nil, total_document: nil)
+        #   @param documents [Array<Dataleon::Models::Individuals::DocumentResponse::Document>] List of documents associated with the response.
+        #
+        #   @param total_document [Integer] Total number of documents available in the response.
+
+        class Document < Dataleon::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique identifier of the document.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute document_type
+          #   Functional type of the document (e.g., identity document, invoice).
+          #
+          #   @return [String, nil]
+          optional :document_type, String
+
+          # @!attribute filename
+          #   Original filename of the uploaded document.
+          #
+          #   @return [String, nil]
+          optional :filename, String
+
+          # @!attribute name
+          #   Human-readable name of the document.
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute signed_url
+          #   Secure URL to access the document.
+          #
+          #   @return [String, nil]
+          optional :signed_url, String
+
+          # @!attribute state
+          #   Processing state of the document (e.g., WAITING, STARTED, RUNNING, PROCESSED).
+          #
+          #   @return [String, nil]
+          optional :state, String
+
+          # @!attribute status
+          #   Validation status of the document (e.g., need_review, approved, rejected).
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!attribute workspace_id
+          #   Identifier of the workspace to which the document belongs.
+          #
+          #   @return [String, nil]
+          optional :workspace_id, String
+
+          # @!method initialize(id: nil, document_type: nil, filename: nil, name: nil, signed_url: nil, state: nil, status: nil, workspace_id: nil)
+          #   Represents a document stored and processed by the system, such as an identity
+          #   card or a PDF contract.
+          #
+          #   @param id [String] Unique identifier of the document.
+          #
+          #   @param document_type [String] Functional type of the document (e.g., identity document, invoice).
+          #
+          #   @param filename [String] Original filename of the uploaded document.
+          #
+          #   @param name [String] Human-readable name of the document.
+          #
+          #   @param signed_url [String] Secure URL to access the document.
+          #
+          #   @param state [String] Processing state of the document (e.g., WAITING, STARTED, RUNNING, PROCESSED).
+          #
+          #   @param status [String] Validation status of the document (e.g., need_review, approved, rejected).
+          #
+          #   @param workspace_id [String] Identifier of the workspace to which the document belongs.
+        end
+      end
+    end
+  end
+end