dataleon 0.1.0a8__py3-none-any.whl

dataleon/resources/individuals/individuals.py

@@ -0,0 +1,711 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from datetime import date
+from typing_extensions import Literal
+
+import httpx
+
+from ...types import (
+    individual_list_params,
+    individual_create_params,
+    individual_update_params,
+    individual_retrieve_params,
+)
+from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
+from ..._utils import maybe_transform, async_maybe_transform
+from ..._compat import cached_property
+from .documents import (
+    DocumentsResource,
+    AsyncDocumentsResource,
+    DocumentsResourceWithRawResponse,
+    AsyncDocumentsResourceWithRawResponse,
+    DocumentsResourceWithStreamingResponse,
+    AsyncDocumentsResourceWithStreamingResponse,
+)
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from ..._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from ..._base_client import make_request_options
+from ...types.individual import Individual
+from ...types.individual_list_response import IndividualListResponse
+
+__all__ = ["IndividualsResource", "AsyncIndividualsResource"]
+
+
+class IndividualsResource(SyncAPIResource):
+    @cached_property
+    def documents(self) -> DocumentsResource:
+        return DocumentsResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> IndividualsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/dataleonlabs/dataleon-python#accessing-raw-response-data-eg-headers
+        """
+        return IndividualsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> IndividualsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/dataleonlabs/dataleon-python#with_streaming_response
+        """
+        return IndividualsResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        workspace_id: str,
+        person: individual_create_params.Person | Omit = omit,
+        source_id: str | Omit = omit,
+        technical_data: individual_create_params.TechnicalData | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> Individual:
+        """
+        Create a new individual
+
+        Args:
+          workspace_id: Unique identifier of the workspace where the individual is being registered.
+
+          person: Personal information about the individual.
+
+          source_id: Optional identifier for tracking the source system or integration from your
+              system.
+
+          technical_data: Technical metadata related to the request or processing.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._post(
+            "/individuals",
+            body=maybe_transform(
+                {
+                    "workspace_id": workspace_id,
+                    "person": person,
+                    "source_id": source_id,
+                    "technical_data": technical_data,
+                },
+                individual_create_params.IndividualCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Individual,
+        )
+
+    def retrieve(
+        self,
+        individual_id: str,
+        *,
+        document: bool | Omit = omit,
+        scope: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> Individual:
+        """
+        Get an individual by ID
+
+        Args:
+          document: Include document information
+
+          scope: Scope filter (id or scope)
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not individual_id:
+            raise ValueError(f"Expected a non-empty value for `individual_id` but received {individual_id!r}")
+        return self._get(
+            f"/individuals/{individual_id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "document": document,
+                        "scope": scope,
+                    },
+                    individual_retrieve_params.IndividualRetrieveParams,
+                ),
+            ),
+            cast_to=Individual,
+        )
+
+    def update(
+        self,
+        individual_id: str,
+        *,
+        workspace_id: str,
+        person: individual_update_params.Person | Omit = omit,
+        source_id: str | Omit = omit,
+        technical_data: individual_update_params.TechnicalData | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> Individual:
+        """
+        Update an individual by ID
+
+        Args:
+          workspace_id: Unique identifier of the workspace where the individual is being registered.
+
+          person: Personal information about the individual.
+
+          source_id: Optional identifier for tracking the source system or integration from your
+              system.
+
+          technical_data: Technical metadata related to the request or processing.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not individual_id:
+            raise ValueError(f"Expected a non-empty value for `individual_id` but received {individual_id!r}")
+        return self._put(
+            f"/individuals/{individual_id}",
+            body=maybe_transform(
+                {
+                    "workspace_id": workspace_id,
+                    "person": person,
+                    "source_id": source_id,
+                    "technical_data": technical_data,
+                },
+                individual_update_params.IndividualUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Individual,
+        )
+
+    def list(
+        self,
+        *,
+        end_date: Union[str, date] | Omit = omit,
+        limit: int | Omit = omit,
+        offset: int | Omit = omit,
+        source_id: str | Omit = omit,
+        start_date: Union[str, date] | Omit = omit,
+        state: Literal["VOID", "WAITING", "STARTED", "RUNNING", "PROCESSED", "FAILED", "ABORTED", "EXPIRED", "DELETED"]
+        | Omit = omit,
+        status: Literal["rejected", "need_review", "approved"] | Omit = omit,
+        workspace_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> IndividualListResponse:
+        """
+        Get all individuals
+
+        Args:
+          end_date: Filter individuals created before this date (format YYYY-MM-DD)
+
+          limit: Number of results to return (between 1 and 100)
+
+          offset: Number of results to offset (must be ≥ 0)
+
+          source_id: Filter by source ID
+
+          start_date: Filter individuals created after this date (format YYYY-MM-DD)
+
+          state: Filter by individual status (must be one of the allowed values)
+
+          status: Filter by individual status (must be one of the allowed values)
+
+          workspace_id: Filter by workspace ID
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get(
+            "/individuals",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "end_date": end_date,
+                        "limit": limit,
+                        "offset": offset,
+                        "source_id": source_id,
+                        "start_date": start_date,
+                        "state": state,
+                        "status": status,
+                        "workspace_id": workspace_id,
+                    },
+                    individual_list_params.IndividualListParams,
+                ),
+            ),
+            cast_to=IndividualListResponse,
+        )
+
+    def delete(
+        self,
+        individual_id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> None:
+        """
+        Delete an individual by ID
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not individual_id:
+            raise ValueError(f"Expected a non-empty value for `individual_id` but received {individual_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._delete(
+            f"/individuals/{individual_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class AsyncIndividualsResource(AsyncAPIResource):
+    @cached_property
+    def documents(self) -> AsyncDocumentsResource:
+        return AsyncDocumentsResource(self._client)
+
+    @cached_property
+    def with_raw_response(self) -> AsyncIndividualsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/dataleonlabs/dataleon-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncIndividualsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncIndividualsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/dataleonlabs/dataleon-python#with_streaming_response
+        """
+        return AsyncIndividualsResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        workspace_id: str,
+        person: individual_create_params.Person | Omit = omit,
+        source_id: str | Omit = omit,
+        technical_data: individual_create_params.TechnicalData | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> Individual:
+        """
+        Create a new individual
+
+        Args:
+          workspace_id: Unique identifier of the workspace where the individual is being registered.
+
+          person: Personal information about the individual.
+
+          source_id: Optional identifier for tracking the source system or integration from your
+              system.
+
+          technical_data: Technical metadata related to the request or processing.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._post(
+            "/individuals",
+            body=await async_maybe_transform(
+                {
+                    "workspace_id": workspace_id,
+                    "person": person,
+                    "source_id": source_id,
+                    "technical_data": technical_data,
+                },
+                individual_create_params.IndividualCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Individual,
+        )
+
+    async def retrieve(
+        self,
+        individual_id: str,
+        *,
+        document: bool | Omit = omit,
+        scope: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> Individual:
+        """
+        Get an individual by ID
+
+        Args:
+          document: Include document information
+
+          scope: Scope filter (id or scope)
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not individual_id:
+            raise ValueError(f"Expected a non-empty value for `individual_id` but received {individual_id!r}")
+        return await self._get(
+            f"/individuals/{individual_id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "document": document,
+                        "scope": scope,
+                    },
+                    individual_retrieve_params.IndividualRetrieveParams,
+                ),
+            ),
+            cast_to=Individual,
+        )
+
+    async def update(
+        self,
+        individual_id: str,
+        *,
+        workspace_id: str,
+        person: individual_update_params.Person | Omit = omit,
+        source_id: str | Omit = omit,
+        technical_data: individual_update_params.TechnicalData | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> Individual:
+        """
+        Update an individual by ID
+
+        Args:
+          workspace_id: Unique identifier of the workspace where the individual is being registered.
+
+          person: Personal information about the individual.
+
+          source_id: Optional identifier for tracking the source system or integration from your
+              system.
+
+          technical_data: Technical metadata related to the request or processing.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not individual_id:
+            raise ValueError(f"Expected a non-empty value for `individual_id` but received {individual_id!r}")
+        return await self._put(
+            f"/individuals/{individual_id}",
+            body=await async_maybe_transform(
+                {
+                    "workspace_id": workspace_id,
+                    "person": person,
+                    "source_id": source_id,
+                    "technical_data": technical_data,
+                },
+                individual_update_params.IndividualUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Individual,
+        )
+
+    async def list(
+        self,
+        *,
+        end_date: Union[str, date] | Omit = omit,
+        limit: int | Omit = omit,
+        offset: int | Omit = omit,
+        source_id: str | Omit = omit,
+        start_date: Union[str, date] | Omit = omit,
+        state: Literal["VOID", "WAITING", "STARTED", "RUNNING", "PROCESSED", "FAILED", "ABORTED", "EXPIRED", "DELETED"]
+        | Omit = omit,
+        status: Literal["rejected", "need_review", "approved"] | Omit = omit,
+        workspace_id: str | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> IndividualListResponse:
+        """
+        Get all individuals
+
+        Args:
+          end_date: Filter individuals created before this date (format YYYY-MM-DD)
+
+          limit: Number of results to return (between 1 and 100)
+
+          offset: Number of results to offset (must be ≥ 0)
+
+          source_id: Filter by source ID
+
+          start_date: Filter individuals created after this date (format YYYY-MM-DD)
+
+          state: Filter by individual status (must be one of the allowed values)
+
+          status: Filter by individual status (must be one of the allowed values)
+
+          workspace_id: Filter by workspace ID
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._get(
+            "/individuals",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "end_date": end_date,
+                        "limit": limit,
+                        "offset": offset,
+                        "source_id": source_id,
+                        "start_date": start_date,
+                        "state": state,
+                        "status": status,
+                        "workspace_id": workspace_id,
+                    },
+                    individual_list_params.IndividualListParams,
+                ),
+            ),
+            cast_to=IndividualListResponse,
+        )
+
+    async def delete(
+        self,
+        individual_id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> None:
+        """
+        Delete an individual by ID
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not individual_id:
+            raise ValueError(f"Expected a non-empty value for `individual_id` but received {individual_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._delete(
+            f"/individuals/{individual_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class IndividualsResourceWithRawResponse:
+    def __init__(self, individuals: IndividualsResource) -> None:
+        self._individuals = individuals
+
+        self.create = to_raw_response_wrapper(
+            individuals.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            individuals.retrieve,
+        )
+        self.update = to_raw_response_wrapper(
+            individuals.update,
+        )
+        self.list = to_raw_response_wrapper(
+            individuals.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            individuals.delete,
+        )
+
+    @cached_property
+    def documents(self) -> DocumentsResourceWithRawResponse:
+        return DocumentsResourceWithRawResponse(self._individuals.documents)
+
+
+class AsyncIndividualsResourceWithRawResponse:
+    def __init__(self, individuals: AsyncIndividualsResource) -> None:
+        self._individuals = individuals
+
+        self.create = async_to_raw_response_wrapper(
+            individuals.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            individuals.retrieve,
+        )
+        self.update = async_to_raw_response_wrapper(
+            individuals.update,
+        )
+        self.list = async_to_raw_response_wrapper(
+            individuals.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            individuals.delete,
+        )
+
+    @cached_property
+    def documents(self) -> AsyncDocumentsResourceWithRawResponse:
+        return AsyncDocumentsResourceWithRawResponse(self._individuals.documents)
+
+
+class IndividualsResourceWithStreamingResponse:
+    def __init__(self, individuals: IndividualsResource) -> None:
+        self._individuals = individuals
+
+        self.create = to_streamed_response_wrapper(
+            individuals.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            individuals.retrieve,
+        )
+        self.update = to_streamed_response_wrapper(
+            individuals.update,
+        )
+        self.list = to_streamed_response_wrapper(
+            individuals.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            individuals.delete,
+        )
+
+    @cached_property
+    def documents(self) -> DocumentsResourceWithStreamingResponse:
+        return DocumentsResourceWithStreamingResponse(self._individuals.documents)
+
+
+class AsyncIndividualsResourceWithStreamingResponse:
+    def __init__(self, individuals: AsyncIndividualsResource) -> None:
+        self._individuals = individuals
+
+        self.create = async_to_streamed_response_wrapper(
+            individuals.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            individuals.retrieve,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            individuals.update,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            individuals.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            individuals.delete,
+        )
+
+    @cached_property
+    def documents(self) -> AsyncDocumentsResourceWithStreamingResponse:
+        return AsyncDocumentsResourceWithStreamingResponse(self._individuals.documents)