dataleon 0.1.0.pre.alpha.1

data/rbi/dataleon/resources/companies.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module Dataleon
+  module Resources
+    class Companies
+      sig { returns(Dataleon::Resources::Companies::Documents) }
+      attr_reader :documents
+
+      # Create a new company
+      sig do
+        params(
+          company: Dataleon::CompanyCreateParams::Company::OrHash,
+          workspace_id: String,
+          source_id: String,
+          technical_data: Dataleon::CompanyCreateParams::TechnicalData::OrHash,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).returns(Dataleon::CompanyRegistration)
+      end
+      def create(
+        # Main information about the company being registered.
+        company:,
+        # Unique identifier of the workspace in which the company is being created.
+        workspace_id:,
+        # Optional identifier to track the origin of the request or integration from your
+        # system.
+        source_id: nil,
+        # Technical metadata and callback configuration.
+        technical_data: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a company by ID
+      sig do
+        params(
+          company_id: String,
+          document: T::Boolean,
+          scope: String,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).returns(Dataleon::CompanyRegistration)
+      end
+      def retrieve(
+        # ID of the company
+        company_id,
+        # Include document signed url
+        document: nil,
+        # Scope filter (id or scope)
+        scope: nil,
+        request_options: {}
+      )
+      end
+
+      # Update a company by ID
+      sig do
+        params(
+          company_id: String,
+          company: Dataleon::CompanyUpdateParams::Company::OrHash,
+          workspace_id: String,
+          source_id: String,
+          technical_data: Dataleon::CompanyUpdateParams::TechnicalData::OrHash,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).returns(Dataleon::CompanyRegistration)
+      end
+      def update(
+        # ID of the company to update
+        company_id,
+        # Main information about the company being registered.
+        company:,
+        # Unique identifier of the workspace in which the company is being created.
+        workspace_id:,
+        # Optional identifier to track the origin of the request or integration from your
+        # system.
+        source_id: nil,
+        # Technical metadata and callback configuration.
+        technical_data: nil,
+        request_options: {}
+      )
+      end
+
+      # Get all companies
+      sig do
+        params(
+          end_date: Date,
+          limit: Integer,
+          offset: Integer,
+          source_id: String,
+          start_date: Date,
+          state: Dataleon::CompanyListParams::State::OrSymbol,
+          status: Dataleon::CompanyListParams::Status::OrSymbol,
+          workspace_id: String,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).returns(T::Array[Dataleon::CompanyRegistration])
+      end
+      def list(
+        # Filter companies created before this date (format YYYY-MM-DD)
+        end_date: nil,
+        # Number of results to return (between 1 and 100)
+        limit: nil,
+        # Number of results to skip (must be ≥ 0)
+        offset: nil,
+        # Filter by source ID
+        source_id: nil,
+        # Filter companies created after this date (format YYYY-MM-DD)
+        start_date: nil,
+        # Filter by company state (must be one of the allowed values)
+        state: nil,
+        # Filter by individual status (must be one of the allowed values)
+        status: nil,
+        # Filter by workspace ID
+        workspace_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete a company by ID
+      sig do
+        params(
+          company_id: String,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # ID of the company to delete
+        company_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Dataleon::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/dataleon/resources/individuals/documents.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module Dataleon
+  module Resources
+    class Individuals
+      class Documents
+        # Get documents to an individuals
+        sig do
+          params(
+            individual_id: String,
+            request_options: Dataleon::RequestOptions::OrHash
+          ).returns(Dataleon::Individuals::DocumentResponse)
+        end
+        def list(
+          # ID of the individual to upload document
+          individual_id,
+          request_options: {}
+        )
+        end
+
+        # Upload documents to an individual
+        sig do
+          params(
+            individual_id: String,
+            document_type:
+              Dataleon::Individuals::DocumentUploadParams::DocumentType::OrSymbol,
+            file: Dataleon::Internal::FileInput,
+            url: String,
+            request_options: Dataleon::RequestOptions::OrHash
+          ).returns(Dataleon::Individuals::GenericDocument)
+        end
+        def upload(
+          # ID of the individual to upload document
+          individual_id,
+          # 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
+
+        # @api private
+        sig { params(client: Dataleon::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/dataleon/resources/individuals.rbi

@@ -0,0 +1,137 @@
+# typed: strong
+
+module Dataleon
+  module Resources
+    class Individuals
+      sig { returns(Dataleon::Resources::Individuals::Documents) }
+      attr_reader :documents
+
+      # Create a new individual
+      sig do
+        params(
+          workspace_id: String,
+          person: Dataleon::IndividualCreateParams::Person::OrHash,
+          source_id: String,
+          technical_data:
+            Dataleon::IndividualCreateParams::TechnicalData::OrHash,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).returns(Dataleon::Individual)
+      end
+      def create(
+        # 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
+
+      # Get an individual by ID
+      sig do
+        params(
+          individual_id: String,
+          document: T::Boolean,
+          scope: String,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).returns(Dataleon::Individual)
+      end
+      def retrieve(
+        # ID of the individual
+        individual_id,
+        # Include document information
+        document: nil,
+        # Scope filter (id or scope)
+        scope: nil,
+        request_options: {}
+      )
+      end
+
+      # Update an individual by ID
+      sig do
+        params(
+          individual_id: String,
+          workspace_id: String,
+          person: Dataleon::IndividualUpdateParams::Person::OrHash,
+          source_id: String,
+          technical_data:
+            Dataleon::IndividualUpdateParams::TechnicalData::OrHash,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).returns(Dataleon::Individual)
+      end
+      def update(
+        # ID of the individual to update
+        individual_id,
+        # 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
+
+      # Get all individuals
+      sig do
+        params(
+          end_date: Date,
+          limit: Integer,
+          offset: Integer,
+          source_id: String,
+          start_date: Date,
+          state: Dataleon::IndividualListParams::State::OrSymbol,
+          status: Dataleon::IndividualListParams::Status::OrSymbol,
+          workspace_id: String,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).returns(T::Array[Dataleon::Individual])
+      end
+      def list(
+        # Filter individuals created before this date (format YYYY-MM-DD)
+        end_date: nil,
+        # Number of results to return (between 1 and 100)
+        limit: nil,
+        # Number of results to offset (must be ≥ 0)
+        offset: nil,
+        # Filter by source ID
+        source_id: nil,
+        # Filter individuals created after this date (format YYYY-MM-DD)
+        start_date: nil,
+        # Filter by individual status (must be one of the allowed values)
+        state: nil,
+        # Filter by individual status (must be one of the allowed values)
+        status: nil,
+        # Filter by workspace ID
+        workspace_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete an individual by ID
+      sig do
+        params(
+          individual_id: String,
+          request_options: Dataleon::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # ID of the individual to delete
+        individual_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Dataleon::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/dataleon/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module Dataleon
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/dataleon/client.rbs

@@ -0,0 +1,28 @@
+module Dataleon
+  class Client < Dataleon::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_key: String
+
+    attr_reader individuals: Dataleon::Resources::Individuals
+
+    attr_reader companies: Dataleon::Resources::Companies
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_key: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/dataleon/errors.rbs

@@ -0,0 +1,110 @@
+module Dataleon
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < Dataleon::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
+    end
+
+    class APIError < Dataleon::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < Dataleon::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < Dataleon::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < Dataleon::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class BadRequestError < Dataleon::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < Dataleon::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < Dataleon::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < Dataleon::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < Dataleon::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < Dataleon::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < Dataleon::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < Dataleon::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end

data/sig/dataleon/file_part.rbs

@@ -0,0 +1,21 @@
+module Dataleon
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: String?,
+      ?content_type: String?
+    ) -> void
+  end
+end

data/sig/dataleon/internal/transport/base_client.rbs

@@ -0,0 +1,131 @@
+module Dataleon
+  module Internal
+    module Transport
+      class BaseClient
+        extend Dataleon::Internal::Util::SorbetRuntimeSupport
+
+        type request_components =
+          {
+            method: Symbol,
+            path: String | ::Array[String],
+            query: ::Hash[String, (::Array[String] | String)?]?,
+            headers: ::Hash[String, (String
+            | Integer
+            | ::Array[(String | Integer)?])?]?,
+            body: top?,
+            unwrap: (Symbol
+            | Integer
+            | ::Array[(Symbol | Integer)]
+            | (^(top arg0) -> top))?,
+            page: Class?,
+            stream: Class?,
+            model: Dataleon::Internal::Type::Converter::input?,
+            options: Dataleon::request_opts?
+          }
+        type request_input =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            max_retries: Integer,
+            timeout: Float
+          }
+
+        MAX_REDIRECTS: 20
+
+        PLATFORM_HEADERS: ::Hash[String, String]
+
+        def self.validate!: (
+          Dataleon::Internal::Transport::BaseClient::request_components req
+        ) -> void
+
+        def self.should_retry?: (
+          Integer status,
+          headers: ::Hash[String, String]
+        ) -> bool
+
+        def self.follow_redirect: (
+          Dataleon::Internal::Transport::BaseClient::request_input request,
+          status: Integer,
+          response_headers: ::Hash[String, String]
+        ) -> Dataleon::Internal::Transport::BaseClient::request_input
+
+        def self.reap_connection!: (
+          Integer | Dataleon::Errors::APIConnectionError status,
+          stream: Enumerable[String]?
+        ) -> void
+
+        attr_reader base_url: URI::Generic
+
+        attr_reader timeout: Float
+
+        attr_reader max_retries: Integer
+
+        attr_reader initial_retry_delay: Float
+
+        attr_reader max_retry_delay: Float
+
+        attr_reader headers: ::Hash[String, String]
+
+        attr_reader idempotency_header: String?
+
+        # @api private
+        attr_reader requester: Dataleon::Internal::Transport::PooledNetRequester
+
+        def initialize: (
+          base_url: String,
+          ?timeout: Float,
+          ?max_retries: Integer,
+          ?initial_retry_delay: Float,
+          ?max_retry_delay: Float,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?],
+          ?idempotency_header: String?
+        ) -> void
+
+        private def auth_headers: -> ::Hash[String, String]
+
+        private def generate_idempotency_key: -> String
+
+        private def build_request: (
+          Dataleon::Internal::Transport::BaseClient::request_components req,
+          Dataleon::request_options opts
+        ) -> Dataleon::Internal::Transport::BaseClient::request_input
+
+        private def retry_delay: (
+          ::Hash[String, String] headers,
+          retry_count: Integer
+        ) -> Float
+
+        def send_request: (
+          Dataleon::Internal::Transport::BaseClient::request_input request,
+          redirect_count: Integer,
+          retry_count: Integer,
+          send_retry_header: bool
+        ) -> [Integer, top, Enumerable[String]]
+
+        def request: (
+          Symbol method,
+          String | ::Array[String] path,
+          ?query: ::Hash[String, (::Array[String] | String)?]?,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?]?,
+          ?body: top?,
+          ?unwrap: (Symbol
+          | Integer
+          | ::Array[(Symbol | Integer)]
+          | (^(top arg0) -> top))?,
+          ?page: Class?,
+          ?stream: Class?,
+          ?model: Dataleon::Internal::Type::Converter::input?,
+          ?options: Dataleon::request_opts?
+        ) -> top
+
+        def inspect: -> String
+      end
+    end
+  end
+end

data/sig/dataleon/internal/transport/pooled_net_requester.rbs

@@ -0,0 +1,45 @@
+module Dataleon
+  module Internal
+    module Transport
+      class PooledNetRequester
+        extend Dataleon::Internal::Util::SorbetRuntimeSupport
+
+        type request =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            deadline: Float
+          }
+
+        KEEP_ALIVE_TIMEOUT: 30
+
+        DEFAULT_MAX_CONNECTIONS: Integer
+
+        def self.connect: (URI::Generic url) -> top
+
+        def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
+
+        def self.build_request: (
+          Dataleon::Internal::Transport::PooledNetRequester::request request
+        ) {
+          (String arg0) -> void
+        } -> [top, (^-> void)]
+
+        private def with_pool: (
+          URI::Generic url,
+          deadline: Float
+        ) {
+          (top arg0) -> void
+        } -> void
+
+        def execute: (
+          Dataleon::Internal::Transport::PooledNetRequester::request request
+        ) -> [Integer, top, Enumerable[String]]
+
+        def initialize: (?size: Integer) -> void
+      end
+    end
+  end
+end