dataleon 0.1.0.pre.alpha.1

data/lib/dataleon/resources/companies/documents.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Resources
+    class Companies
+      class Documents
+        # Get documents to an company
+        #
+        # @overload list(company_id, request_options: {})
+        #
+        # @param company_id [String] ID of the company to upload document
+        #
+        # @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Dataleon::Models::Individuals::DocumentResponse]
+        #
+        # @see Dataleon::Models::Companies::DocumentListParams
+        def list(company_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["companies/%1$s/documents", company_id],
+            model: Dataleon::Individuals::DocumentResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Upload documents to an company
+        #
+        # @overload upload(company_id, document_type:, file: nil, url: nil, request_options: {})
+        #
+        # @param company_id [String] ID of the company to upload document
+        #
+        # @param document_type [Symbol, Dataleon::Models::Companies::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}, nil]
+        #
+        # @return [Dataleon::Models::Individuals::GenericDocument]
+        #
+        # @see Dataleon::Models::Companies::DocumentUploadParams
+        def upload(company_id, params)
+          parsed, options = Dataleon::Companies::DocumentUploadParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["companies/%1$s/documents", company_id],
+            headers: {"content-type" => "multipart/form-data"},
+            body: parsed,
+            model: Dataleon::Individuals::GenericDocument,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Dataleon::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/dataleon/resources/companies.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Resources
+    class Companies
+      # @return [Dataleon::Resources::Companies::Documents]
+      attr_reader :documents
+
+      # Some parameter documentations has been truncated, see
+      # {Dataleon::Models::CompanyCreateParams} for more details.
+      #
+      # Create a new company
+      #
+      # @overload create(company:, workspace_id:, source_id: nil, technical_data: nil, request_options: {})
+      #
+      # @param company [Dataleon::Models::CompanyCreateParams::Company] Main information about the company being registered.
+      #
+      # @param workspace_id [String] Unique identifier of the workspace in which the company is being created.
+      #
+      # @param source_id [String] Optional identifier to track the origin of the request or integration from your
+      #
+      # @param technical_data [Dataleon::Models::CompanyCreateParams::TechnicalData] Technical metadata and callback configuration.
+      #
+      # @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dataleon::Models::CompanyRegistration]
+      #
+      # @see Dataleon::Models::CompanyCreateParams
+      def create(params)
+        parsed, options = Dataleon::CompanyCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "companies",
+          body: parsed,
+          model: Dataleon::CompanyRegistration,
+          options: options
+        )
+      end
+
+      # Get a company by ID
+      #
+      # @overload retrieve(company_id, document: nil, scope: nil, request_options: {})
+      #
+      # @param company_id [String] ID of the company
+      #
+      # @param document [Boolean] Include document signed url
+      #
+      # @param scope [String] Scope filter (id or scope)
+      #
+      # @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dataleon::Models::CompanyRegistration]
+      #
+      # @see Dataleon::Models::CompanyRetrieveParams
+      def retrieve(company_id, params = {})
+        parsed, options = Dataleon::CompanyRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["companies/%1$s", company_id],
+          query: parsed,
+          model: Dataleon::CompanyRegistration,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Dataleon::Models::CompanyUpdateParams} for more details.
+      #
+      # Update a company by ID
+      #
+      # @overload update(company_id, company:, workspace_id:, source_id: nil, technical_data: nil, request_options: {})
+      #
+      # @param company_id [String] ID of the company to update
+      #
+      # @param company [Dataleon::Models::CompanyUpdateParams::Company] Main information about the company being registered.
+      #
+      # @param workspace_id [String] Unique identifier of the workspace in which the company is being created.
+      #
+      # @param source_id [String] Optional identifier to track the origin of the request or integration from your
+      #
+      # @param technical_data [Dataleon::Models::CompanyUpdateParams::TechnicalData] Technical metadata and callback configuration.
+      #
+      # @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dataleon::Models::CompanyRegistration]
+      #
+      # @see Dataleon::Models::CompanyUpdateParams
+      def update(company_id, params)
+        parsed, options = Dataleon::CompanyUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["companies/%1$s", company_id],
+          body: parsed,
+          model: Dataleon::CompanyRegistration,
+          options: options
+        )
+      end
+
+      # Get all companies
+      #
+      # @overload list(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 companies 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 skip (must be ≥ 0)
+      #
+      # @param source_id [String] Filter by source ID
+      #
+      # @param start_date [Date] Filter companies created after this date (format YYYY-MM-DD)
+      #
+      # @param state [Symbol, Dataleon::Models::CompanyListParams::State] Filter by company state (must be one of the allowed values)
+      #
+      # @param status [Symbol, Dataleon::Models::CompanyListParams::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}, nil]
+      #
+      # @return [Array<Dataleon::Models::CompanyRegistration>]
+      #
+      # @see Dataleon::Models::CompanyListParams
+      def list(params = {})
+        parsed, options = Dataleon::CompanyListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "companies",
+          query: parsed,
+          model: Dataleon::Internal::Type::ArrayOf[Dataleon::CompanyRegistration],
+          options: options
+        )
+      end
+
+      # Delete a company by ID
+      #
+      # @overload delete(company_id, request_options: {})
+      #
+      # @param company_id [String] ID of the company to delete
+      #
+      # @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Dataleon::Models::CompanyDeleteParams
+      def delete(company_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["companies/%1$s", company_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Dataleon::Client]
+      def initialize(client:)
+        @client = client
+        @documents = Dataleon::Resources::Companies::Documents.new(client: client)
+      end
+    end
+  end
+end

data/lib/dataleon/resources/individuals/documents.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Resources
+    class Individuals
+      class Documents
+        # Get documents to an individuals
+        #
+        # @overload list(individual_id, request_options: {})
+        #
+        # @param individual_id [String] ID of the individual to upload document
+        #
+        # @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Dataleon::Models::Individuals::DocumentResponse]
+        #
+        # @see Dataleon::Models::Individuals::DocumentListParams
+        def list(individual_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["individuals/%1$s/documents", individual_id],
+            model: Dataleon::Individuals::DocumentResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Upload documents to an individual
+        #
+        # @overload upload(individual_id, document_type:, file: nil, url: nil, request_options: {})
+        #
+        # @param individual_id [String] ID of the individual to upload document
+        #
+        # @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}, nil]
+        #
+        # @return [Dataleon::Models::Individuals::GenericDocument]
+        #
+        # @see Dataleon::Models::Individuals::DocumentUploadParams
+        def upload(individual_id, params)
+          parsed, options = Dataleon::Individuals::DocumentUploadParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["individuals/%1$s/documents", individual_id],
+            headers: {"content-type" => "multipart/form-data"},
+            body: parsed,
+            model: Dataleon::Individuals::GenericDocument,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Dataleon::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/dataleon/resources/individuals.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Dataleon
+  module Resources
+    class Individuals
+      # @return [Dataleon::Resources::Individuals::Documents]
+      attr_reader :documents
+
+      # Some parameter documentations has been truncated, see
+      # {Dataleon::Models::IndividualCreateParams} for more details.
+      #
+      # Create a new individual
+      #
+      # @overload create(workspace_id:, person: nil, source_id: nil, technical_data: nil, request_options: {})
+      #
+      # @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}, nil]
+      #
+      # @return [Dataleon::Models::Individual]
+      #
+      # @see Dataleon::Models::IndividualCreateParams
+      def create(params)
+        parsed, options = Dataleon::IndividualCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "individuals",
+          body: parsed,
+          model: Dataleon::Individual,
+          options: options
+        )
+      end
+
+      # Get an individual by ID
+      #
+      # @overload retrieve(individual_id, document: nil, scope: nil, request_options: {})
+      #
+      # @param individual_id [String] ID of the individual
+      #
+      # @param document [Boolean] Include document information
+      #
+      # @param scope [String] Scope filter (id or scope)
+      #
+      # @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dataleon::Models::Individual]
+      #
+      # @see Dataleon::Models::IndividualRetrieveParams
+      def retrieve(individual_id, params = {})
+        parsed, options = Dataleon::IndividualRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["individuals/%1$s", individual_id],
+          query: parsed,
+          model: Dataleon::Individual,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Dataleon::Models::IndividualUpdateParams} for more details.
+      #
+      # Update an individual by ID
+      #
+      # @overload update(individual_id, workspace_id:, person: nil, source_id: nil, technical_data: nil, request_options: {})
+      #
+      # @param individual_id [String] ID of the individual to update
+      #
+      # @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}, nil]
+      #
+      # @return [Dataleon::Models::Individual]
+      #
+      # @see Dataleon::Models::IndividualUpdateParams
+      def update(individual_id, params)
+        parsed, options = Dataleon::IndividualUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["individuals/%1$s", individual_id],
+          body: parsed,
+          model: Dataleon::Individual,
+          options: options
+        )
+      end
+
+      # Get all individuals
+      #
+      # @overload list(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}, nil]
+      #
+      # @return [Array<Dataleon::Models::Individual>]
+      #
+      # @see Dataleon::Models::IndividualListParams
+      def list(params = {})
+        parsed, options = Dataleon::IndividualListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "individuals",
+          query: parsed,
+          model: Dataleon::Internal::Type::ArrayOf[Dataleon::Individual],
+          options: options
+        )
+      end
+
+      # Delete an individual by ID
+      #
+      # @overload delete(individual_id, request_options: {})
+      #
+      # @param individual_id [String] ID of the individual to delete
+      #
+      # @param request_options [Dataleon::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Dataleon::Models::IndividualDeleteParams
+      def delete(individual_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["individuals/%1$s", individual_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Dataleon::Client]
+      def initialize(client:)
+        @client = client
+        @documents = Dataleon::Resources::Individuals::Documents.new(client: client)
+      end
+    end
+  end
+end

data/lib/dataleon/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Dataleon
+  VERSION = "0.1.0.pre.alpha.1"
+end

data/lib/dataleon.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "dataleon/version"
+require_relative "dataleon/internal/util"
+require_relative "dataleon/internal/type/converter"
+require_relative "dataleon/internal/type/unknown"
+require_relative "dataleon/internal/type/boolean"
+require_relative "dataleon/internal/type/file_input"
+require_relative "dataleon/internal/type/enum"
+require_relative "dataleon/internal/type/union"
+require_relative "dataleon/internal/type/array_of"
+require_relative "dataleon/internal/type/hash_of"
+require_relative "dataleon/internal/type/base_model"
+require_relative "dataleon/internal/type/base_page"
+require_relative "dataleon/internal/type/request_parameters"
+require_relative "dataleon/internal"
+require_relative "dataleon/request_options"
+require_relative "dataleon/file_part"
+require_relative "dataleon/errors"
+require_relative "dataleon/internal/transport/base_client"
+require_relative "dataleon/internal/transport/pooled_net_requester"
+require_relative "dataleon/client"
+require_relative "dataleon/models/check"
+require_relative "dataleon/models/companies/document_list_params"
+require_relative "dataleon/models/companies/document_upload_params"
+require_relative "dataleon/models/company_create_params"
+require_relative "dataleon/models/company_delete_params"
+require_relative "dataleon/models/company_list_params"
+require_relative "dataleon/models/company_list_response"
+require_relative "dataleon/models/company_registration"
+require_relative "dataleon/models/company_retrieve_params"
+require_relative "dataleon/models/company_update_params"
+require_relative "dataleon/models/individual"
+require_relative "dataleon/models/individual_create_params"
+require_relative "dataleon/models/individual_delete_params"
+require_relative "dataleon/models/individual_list_params"
+require_relative "dataleon/models/individual_list_response"
+require_relative "dataleon/models/individual_retrieve_params"
+require_relative "dataleon/models/individuals/document_list_params"
+require_relative "dataleon/models/individuals/document_response"
+require_relative "dataleon/models/individuals/document_upload_params"
+require_relative "dataleon/models/individuals/generic_document"
+require_relative "dataleon/models/individuals/kbis"
+require_relative "dataleon/models/individual_update_params"
+require_relative "dataleon/models"
+require_relative "dataleon/resources/companies"
+require_relative "dataleon/resources/companies/documents"
+require_relative "dataleon/resources/individuals"
+require_relative "dataleon/resources/individuals/documents"

data/manifest.yaml

@@ -0,0 +1,15 @@
+dependencies:
+  - English
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/dataleon/client.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Dataleon
+  class Client < Dataleon::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    # API key needed to authorize requests. You must provide a valid API key in the
+    # `Api-Key` header. Get your API key from the Dataleon dashboard.
+    sig { returns(String) }
+    attr_reader :api_key
+
+    sig { returns(Dataleon::Resources::Individuals) }
+    attr_reader :individuals
+
+    sig { returns(Dataleon::Resources::Companies) }
+    attr_reader :companies
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # API key needed to authorize requests. You must provide a valid API key in the
+      # `Api-Key` header. Get your API key from the Dataleon dashboard. Defaults to
+      # `ENV["DATALEON_API_KEY"]`
+      api_key: ENV["DATALEON_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["DATALEON_BASE_URL"]`
+      base_url: ENV["DATALEON_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: Dataleon::Client::DEFAULT_MAX_RETRIES,
+      timeout: Dataleon::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Dataleon::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Dataleon::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end