casedev 0.1.0__py3-none-any.whl

casedev/resources/vault/objects.py

@@ -0,0 +1,571 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal
+
+import httpx
+
+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 ..._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 ...types.vault import object_create_presigned_url_params
+from ..._base_client import make_request_options
+from ...types.vault.object_create_presigned_url_response import ObjectCreatePresignedURLResponse
+
+__all__ = ["ObjectsResource", "AsyncObjectsResource"]
+
+
+class ObjectsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> ObjectsResourceWithRawResponse:
+        """
+        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/CaseMark/casedev-python#accessing-raw-response-data-eg-headers
+        """
+        return ObjectsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> ObjectsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/CaseMark/casedev-python#with_streaming_response
+        """
+        return ObjectsResourceWithStreamingResponse(self)
+
+    def retrieve(
+        self,
+        object_id: str,
+        *,
+        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:
+        """
+        Retrieves metadata for a specific document in a vault and generates a temporary
+        download URL. The download URL expires after 1 hour for security. This endpoint
+        also updates the file size if it wasn't previously calculated.
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not object_id:
+            raise ValueError(f"Expected a non-empty value for `object_id` but received {object_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._get(
+            f"/vault/{id}/objects/{object_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def list(
+        self,
+        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:
+        """
+        Retrieve all objects stored in a specific vault, including document metadata,
+        ingestion status, and processing statistics.
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._get(
+            f"/vault/{id}/objects",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def create_presigned_url(
+        self,
+        object_id: str,
+        *,
+        id: str,
+        content_type: str | Omit = omit,
+        expires_in: int | Omit = omit,
+        operation: Literal["GET", "PUT", "DELETE", "HEAD"] | 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,
+    ) -> ObjectCreatePresignedURLResponse:
+        """
+        Generate presigned URLs for direct S3 operations (GET, PUT, DELETE, HEAD) on
+        vault objects. This allows secure, time-limited access to files without proxying
+        through the API. Essential for large document uploads/downloads in legal
+        workflows.
+
+        Args:
+          content_type: Content type for PUT operations (optional, defaults to object's content type)
+
+          expires_in: URL expiration time in seconds (1 minute to 7 days)
+
+          operation: The S3 operation to generate URL for
+
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not object_id:
+            raise ValueError(f"Expected a non-empty value for `object_id` but received {object_id!r}")
+        return self._post(
+            f"/vault/{id}/objects/{object_id}/presigned-url",
+            body=maybe_transform(
+                {
+                    "content_type": content_type,
+                    "expires_in": expires_in,
+                    "operation": operation,
+                },
+                object_create_presigned_url_params.ObjectCreatePresignedURLParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ObjectCreatePresignedURLResponse,
+        )
+
+    def download(
+        self,
+        object_id: str,
+        *,
+        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:
+        """Downloads a file from a vault.
+
+        Returns the actual file content as a binary
+        stream with appropriate headers for file download. Useful for retrieving
+        contracts, depositions, case files, and other legal documents stored in your
+        vault.
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not object_id:
+            raise ValueError(f"Expected a non-empty value for `object_id` but received {object_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._get(
+            f"/vault/{id}/objects/{object_id}/download",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    def get_text(
+        self,
+        object_id: str,
+        *,
+        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:
+        """Retrieves the full extracted text content from a processed vault object.
+
+        Returns
+        the concatenated text from all chunks, useful for document review, analysis, or
+        export. The object must have completed processing before text can be retrieved.
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not object_id:
+            raise ValueError(f"Expected a non-empty value for `object_id` but received {object_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return self._get(
+            f"/vault/{id}/objects/{object_id}/text",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class AsyncObjectsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncObjectsResourceWithRawResponse:
+        """
+        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/CaseMark/casedev-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncObjectsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncObjectsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/CaseMark/casedev-python#with_streaming_response
+        """
+        return AsyncObjectsResourceWithStreamingResponse(self)
+
+    async def retrieve(
+        self,
+        object_id: str,
+        *,
+        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:
+        """
+        Retrieves metadata for a specific document in a vault and generates a temporary
+        download URL. The download URL expires after 1 hour for security. This endpoint
+        also updates the file size if it wasn't previously calculated.
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not object_id:
+            raise ValueError(f"Expected a non-empty value for `object_id` but received {object_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._get(
+            f"/vault/{id}/objects/{object_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def list(
+        self,
+        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:
+        """
+        Retrieve all objects stored in a specific vault, including document metadata,
+        ingestion status, and processing statistics.
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._get(
+            f"/vault/{id}/objects",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def create_presigned_url(
+        self,
+        object_id: str,
+        *,
+        id: str,
+        content_type: str | Omit = omit,
+        expires_in: int | Omit = omit,
+        operation: Literal["GET", "PUT", "DELETE", "HEAD"] | 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,
+    ) -> ObjectCreatePresignedURLResponse:
+        """
+        Generate presigned URLs for direct S3 operations (GET, PUT, DELETE, HEAD) on
+        vault objects. This allows secure, time-limited access to files without proxying
+        through the API. Essential for large document uploads/downloads in legal
+        workflows.
+
+        Args:
+          content_type: Content type for PUT operations (optional, defaults to object's content type)
+
+          expires_in: URL expiration time in seconds (1 minute to 7 days)
+
+          operation: The S3 operation to generate URL for
+
+          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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not object_id:
+            raise ValueError(f"Expected a non-empty value for `object_id` but received {object_id!r}")
+        return await self._post(
+            f"/vault/{id}/objects/{object_id}/presigned-url",
+            body=await async_maybe_transform(
+                {
+                    "content_type": content_type,
+                    "expires_in": expires_in,
+                    "operation": operation,
+                },
+                object_create_presigned_url_params.ObjectCreatePresignedURLParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ObjectCreatePresignedURLResponse,
+        )
+
+    async def download(
+        self,
+        object_id: str,
+        *,
+        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:
+        """Downloads a file from a vault.
+
+        Returns the actual file content as a binary
+        stream with appropriate headers for file download. Useful for retrieving
+        contracts, depositions, case files, and other legal documents stored in your
+        vault.
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not object_id:
+            raise ValueError(f"Expected a non-empty value for `object_id` but received {object_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._get(
+            f"/vault/{id}/objects/{object_id}/download",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+    async def get_text(
+        self,
+        object_id: str,
+        *,
+        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:
+        """Retrieves the full extracted text content from a processed vault object.
+
+        Returns
+        the concatenated text from all chunks, useful for document review, analysis, or
+        export. The object must have completed processing before text can be retrieved.
+
+        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 id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        if not object_id:
+            raise ValueError(f"Expected a non-empty value for `object_id` but received {object_id!r}")
+        extra_headers = {"Accept": "*/*", **(extra_headers or {})}
+        return await self._get(
+            f"/vault/{id}/objects/{object_id}/text",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=NoneType,
+        )
+
+
+class ObjectsResourceWithRawResponse:
+    def __init__(self, objects: ObjectsResource) -> None:
+        self._objects = objects
+
+        self.retrieve = to_raw_response_wrapper(
+            objects.retrieve,
+        )
+        self.list = to_raw_response_wrapper(
+            objects.list,
+        )
+        self.create_presigned_url = to_raw_response_wrapper(
+            objects.create_presigned_url,
+        )
+        self.download = to_raw_response_wrapper(
+            objects.download,
+        )
+        self.get_text = to_raw_response_wrapper(
+            objects.get_text,
+        )
+
+
+class AsyncObjectsResourceWithRawResponse:
+    def __init__(self, objects: AsyncObjectsResource) -> None:
+        self._objects = objects
+
+        self.retrieve = async_to_raw_response_wrapper(
+            objects.retrieve,
+        )
+        self.list = async_to_raw_response_wrapper(
+            objects.list,
+        )
+        self.create_presigned_url = async_to_raw_response_wrapper(
+            objects.create_presigned_url,
+        )
+        self.download = async_to_raw_response_wrapper(
+            objects.download,
+        )
+        self.get_text = async_to_raw_response_wrapper(
+            objects.get_text,
+        )
+
+
+class ObjectsResourceWithStreamingResponse:
+    def __init__(self, objects: ObjectsResource) -> None:
+        self._objects = objects
+
+        self.retrieve = to_streamed_response_wrapper(
+            objects.retrieve,
+        )
+        self.list = to_streamed_response_wrapper(
+            objects.list,
+        )
+        self.create_presigned_url = to_streamed_response_wrapper(
+            objects.create_presigned_url,
+        )
+        self.download = to_streamed_response_wrapper(
+            objects.download,
+        )
+        self.get_text = to_streamed_response_wrapper(
+            objects.get_text,
+        )
+
+
+class AsyncObjectsResourceWithStreamingResponse:
+    def __init__(self, objects: AsyncObjectsResource) -> None:
+        self._objects = objects
+
+        self.retrieve = async_to_streamed_response_wrapper(
+            objects.retrieve,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            objects.list,
+        )
+        self.create_presigned_url = async_to_streamed_response_wrapper(
+            objects.create_presigned_url,
+        )
+        self.download = async_to_streamed_response_wrapper(
+            objects.download,
+        )
+        self.get_text = async_to_streamed_response_wrapper(
+            objects.get_text,
+        )