casedev 0.3.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

casedev/resources/vault/objects.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Optional
 from typing_extensions import Literal
 
 import httpx
@@ -16,11 +17,20 @@ from ..._response import (
     async_to_raw_response_wrapper,
     async_to_streamed_response_wrapper,
 )
-from ...types.vault import object_create_presigned_url_params
+from ...types.vault import (
+    object_delete_params,
+    object_update_params,
+    object_get_ocr_words_params,
+    object_create_presigned_url_params,
+)
 from ..._base_client import make_request_options
 from ...types.vault.object_list_response import ObjectListResponse
+from ...types.vault.object_delete_response import ObjectDeleteResponse
+from ...types.vault.object_update_response import ObjectUpdateResponse
 from ...types.vault.object_get_text_response import ObjectGetTextResponse
 from ...types.vault.object_retrieve_response import ObjectRetrieveResponse
+from ...types.vault.object_get_ocr_words_response import ObjectGetOcrWordsResponse
+from ...types.vault.object_get_summarize_job_response import ObjectGetSummarizeJobResponse
 from ...types.vault.object_create_presigned_url_response import ObjectCreatePresignedURLResponse
 
 __all__ = ["ObjectsResource", "AsyncObjectsResource"]
@@ -84,6 +94,63 @@ class ObjectsResource(SyncAPIResource):
             cast_to=ObjectRetrieveResponse,
         )
 
+    def update(
+        self,
+        object_id: str,
+        *,
+        id: str,
+        filename: str | Omit = omit,
+        metadata: object | Omit = omit,
+        path: Optional[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,
+    ) -> ObjectUpdateResponse:
+        """Update a document's filename, path, or metadata.
+
+        Use this to rename files or
+        organize them into virtual folders. The path is stored in metadata.path and can
+        be used to build folder hierarchies in your application.
+
+        Args:
+          filename: New filename for the document (affects display name and downloads)
+
+          metadata: Additional metadata to merge with existing metadata
+
+          path: Folder path for hierarchy preservation (e.g., '/Discovery/Depositions'). Set to
+              null or empty string to remove.
+
+          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._patch(
+            f"/vault/{id}/objects/{object_id}",
+            body=maybe_transform(
+                {
+                    "filename": filename,
+                    "metadata": metadata,
+                    "path": path,
+                },
+                object_update_params.ObjectUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ObjectUpdateResponse,
+        )
+
     def list(
         self,
         id: str,
@@ -118,6 +185,51 @@ class ObjectsResource(SyncAPIResource):
             cast_to=ObjectListResponse,
         )
 
+    def delete(
+        self,
+        object_id: str,
+        *,
+        id: str,
+        force: Literal["true"] | 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,
+    ) -> ObjectDeleteResponse:
+        """
+        Permanently deletes a document from the vault including all associated vectors,
+        chunks, graph data, and the original file. This operation cannot be undone.
+
+        Args:
+          force: Force delete a stuck document that is still in 'processing' state. Use this if a
+              document got stuck during ingestion (e.g., OCR timeout).
+
+          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._delete(
+            f"/vault/{id}/objects/{object_id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"force": force}, object_delete_params.ObjectDeleteParams),
+            ),
+            cast_to=ObjectDeleteResponse,
+        )
+
     def create_presigned_url(
         self,
         object_id: str,
@@ -147,8 +259,8 @@ class ObjectsResource(SyncAPIResource):
 
           operation: The S3 operation to generate URL for
 
-          size_bytes: File size in bytes (optional, max 500MB). When provided for PUT operations,
-              enforces exact file size at S3 level.
+          size_bytes: File size in bytes (optional, max 5GB for single PUT uploads). When provided for
+              PUT operations, enforces exact file size at S3 level.
 
           extra_headers: Send extra headers
 
@@ -219,6 +331,110 @@ class ObjectsResource(SyncAPIResource):
             cast_to=str,
         )
 
+    def get_ocr_words(
+        self,
+        object_id: str,
+        *,
+        id: str,
+        page: int | Omit = omit,
+        word_end: int | Omit = omit,
+        word_start: int | 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,
+    ) -> ObjectGetOcrWordsResponse:
+        """Retrieves word-level OCR bounding box data for a processed PDF document.
+
+        Each
+        word includes its text, normalized bounding box coordinates (0-1 range),
+        confidence score, and global word index. Use this data to highlight specific
+        text ranges in a PDF viewer based on word indices from search results.
+
+        Args:
+          page: Filter to a specific page number (1-indexed). If omitted, returns all pages.
+
+          word_end: Filter to words ending at this index (inclusive). Useful for retrieving words
+              for a specific chunk.
+
+          word_start: Filter to words starting at this index (inclusive). Useful for retrieving words
+              for a specific chunk.
+
+          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._get(
+            f"/vault/{id}/objects/{object_id}/ocr-words",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "page": page,
+                        "word_end": word_end,
+                        "word_start": word_start,
+                    },
+                    object_get_ocr_words_params.ObjectGetOcrWordsParams,
+                ),
+            ),
+            cast_to=ObjectGetOcrWordsResponse,
+        )
+
+    def get_summarize_job(
+        self,
+        job_id: str,
+        *,
+        id: str,
+        object_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,
+    ) -> ObjectGetSummarizeJobResponse:
+        """Get the status of a CaseMark summary workflow job.
+
+        If the job has been
+        processing for too long, this endpoint will poll CaseMark directly to recover
+        stuck jobs.
+
+        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}")
+        if not job_id:
+            raise ValueError(f"Expected a non-empty value for `job_id` but received {job_id!r}")
+        return self._get(
+            f"/vault/{id}/objects/{object_id}/summarize/{job_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ObjectGetSummarizeJobResponse,
+        )
+
     def get_text(
         self,
         object_id: str,
@@ -317,6 +533,63 @@ class AsyncObjectsResource(AsyncAPIResource):
             cast_to=ObjectRetrieveResponse,
         )
 
+    async def update(
+        self,
+        object_id: str,
+        *,
+        id: str,
+        filename: str | Omit = omit,
+        metadata: object | Omit = omit,
+        path: Optional[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,
+    ) -> ObjectUpdateResponse:
+        """Update a document's filename, path, or metadata.
+
+        Use this to rename files or
+        organize them into virtual folders. The path is stored in metadata.path and can
+        be used to build folder hierarchies in your application.
+
+        Args:
+          filename: New filename for the document (affects display name and downloads)
+
+          metadata: Additional metadata to merge with existing metadata
+
+          path: Folder path for hierarchy preservation (e.g., '/Discovery/Depositions'). Set to
+              null or empty string to remove.
+
+          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._patch(
+            f"/vault/{id}/objects/{object_id}",
+            body=await async_maybe_transform(
+                {
+                    "filename": filename,
+                    "metadata": metadata,
+                    "path": path,
+                },
+                object_update_params.ObjectUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ObjectUpdateResponse,
+        )
+
     async def list(
         self,
         id: str,
@@ -351,6 +624,51 @@ class AsyncObjectsResource(AsyncAPIResource):
             cast_to=ObjectListResponse,
         )
 
+    async def delete(
+        self,
+        object_id: str,
+        *,
+        id: str,
+        force: Literal["true"] | 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,
+    ) -> ObjectDeleteResponse:
+        """
+        Permanently deletes a document from the vault including all associated vectors,
+        chunks, graph data, and the original file. This operation cannot be undone.
+
+        Args:
+          force: Force delete a stuck document that is still in 'processing' state. Use this if a
+              document got stuck during ingestion (e.g., OCR timeout).
+
+          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._delete(
+            f"/vault/{id}/objects/{object_id}",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform({"force": force}, object_delete_params.ObjectDeleteParams),
+            ),
+            cast_to=ObjectDeleteResponse,
+        )
+
     async def create_presigned_url(
         self,
         object_id: str,
@@ -380,8 +698,8 @@ class AsyncObjectsResource(AsyncAPIResource):
 
           operation: The S3 operation to generate URL for
 
-          size_bytes: File size in bytes (optional, max 500MB). When provided for PUT operations,
-              enforces exact file size at S3 level.
+          size_bytes: File size in bytes (optional, max 5GB for single PUT uploads). When provided for
+              PUT operations, enforces exact file size at S3 level.
 
           extra_headers: Send extra headers
 
@@ -452,6 +770,110 @@ class AsyncObjectsResource(AsyncAPIResource):
             cast_to=str,
         )
 
+    async def get_ocr_words(
+        self,
+        object_id: str,
+        *,
+        id: str,
+        page: int | Omit = omit,
+        word_end: int | Omit = omit,
+        word_start: int | 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,
+    ) -> ObjectGetOcrWordsResponse:
+        """Retrieves word-level OCR bounding box data for a processed PDF document.
+
+        Each
+        word includes its text, normalized bounding box coordinates (0-1 range),
+        confidence score, and global word index. Use this data to highlight specific
+        text ranges in a PDF viewer based on word indices from search results.
+
+        Args:
+          page: Filter to a specific page number (1-indexed). If omitted, returns all pages.
+
+          word_end: Filter to words ending at this index (inclusive). Useful for retrieving words
+              for a specific chunk.
+
+          word_start: Filter to words starting at this index (inclusive). Useful for retrieving words
+              for a specific chunk.
+
+          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._get(
+            f"/vault/{id}/objects/{object_id}/ocr-words",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform(
+                    {
+                        "page": page,
+                        "word_end": word_end,
+                        "word_start": word_start,
+                    },
+                    object_get_ocr_words_params.ObjectGetOcrWordsParams,
+                ),
+            ),
+            cast_to=ObjectGetOcrWordsResponse,
+        )
+
+    async def get_summarize_job(
+        self,
+        job_id: str,
+        *,
+        id: str,
+        object_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,
+    ) -> ObjectGetSummarizeJobResponse:
+        """Get the status of a CaseMark summary workflow job.
+
+        If the job has been
+        processing for too long, this endpoint will poll CaseMark directly to recover
+        stuck jobs.
+
+        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}")
+        if not job_id:
+            raise ValueError(f"Expected a non-empty value for `job_id` but received {job_id!r}")
+        return await self._get(
+            f"/vault/{id}/objects/{object_id}/summarize/{job_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ObjectGetSummarizeJobResponse,
+        )
+
     async def get_text(
         self,
         object_id: str,
@@ -499,15 +921,27 @@ class ObjectsResourceWithRawResponse:
         self.retrieve = to_raw_response_wrapper(
             objects.retrieve,
         )
+        self.update = to_raw_response_wrapper(
+            objects.update,
+        )
         self.list = to_raw_response_wrapper(
             objects.list,
         )
+        self.delete = to_raw_response_wrapper(
+            objects.delete,
+        )
         self.create_presigned_url = to_raw_response_wrapper(
             objects.create_presigned_url,
         )
         self.download = to_raw_response_wrapper(
             objects.download,
         )
+        self.get_ocr_words = to_raw_response_wrapper(
+            objects.get_ocr_words,
+        )
+        self.get_summarize_job = to_raw_response_wrapper(
+            objects.get_summarize_job,
+        )
         self.get_text = to_raw_response_wrapper(
             objects.get_text,
         )
@@ -520,15 +954,27 @@ class AsyncObjectsResourceWithRawResponse:
         self.retrieve = async_to_raw_response_wrapper(
             objects.retrieve,
         )
+        self.update = async_to_raw_response_wrapper(
+            objects.update,
+        )
         self.list = async_to_raw_response_wrapper(
             objects.list,
         )
+        self.delete = async_to_raw_response_wrapper(
+            objects.delete,
+        )
         self.create_presigned_url = async_to_raw_response_wrapper(
             objects.create_presigned_url,
         )
         self.download = async_to_raw_response_wrapper(
             objects.download,
         )
+        self.get_ocr_words = async_to_raw_response_wrapper(
+            objects.get_ocr_words,
+        )
+        self.get_summarize_job = async_to_raw_response_wrapper(
+            objects.get_summarize_job,
+        )
         self.get_text = async_to_raw_response_wrapper(
             objects.get_text,
         )
@@ -541,15 +987,27 @@ class ObjectsResourceWithStreamingResponse:
         self.retrieve = to_streamed_response_wrapper(
             objects.retrieve,
         )
+        self.update = to_streamed_response_wrapper(
+            objects.update,
+        )
         self.list = to_streamed_response_wrapper(
             objects.list,
         )
+        self.delete = to_streamed_response_wrapper(
+            objects.delete,
+        )
         self.create_presigned_url = to_streamed_response_wrapper(
             objects.create_presigned_url,
         )
         self.download = to_streamed_response_wrapper(
             objects.download,
         )
+        self.get_ocr_words = to_streamed_response_wrapper(
+            objects.get_ocr_words,
+        )
+        self.get_summarize_job = to_streamed_response_wrapper(
+            objects.get_summarize_job,
+        )
         self.get_text = to_streamed_response_wrapper(
             objects.get_text,
         )
@@ -562,15 +1020,27 @@ class AsyncObjectsResourceWithStreamingResponse:
         self.retrieve = async_to_streamed_response_wrapper(
             objects.retrieve,
         )
+        self.update = async_to_streamed_response_wrapper(
+            objects.update,
+        )
         self.list = async_to_streamed_response_wrapper(
             objects.list,
         )
+        self.delete = async_to_streamed_response_wrapper(
+            objects.delete,
+        )
         self.create_presigned_url = async_to_streamed_response_wrapper(
             objects.create_presigned_url,
         )
         self.download = async_to_streamed_response_wrapper(
             objects.download,
         )
+        self.get_ocr_words = async_to_streamed_response_wrapper(
+            objects.get_ocr_words,
+        )
+        self.get_summarize_job = async_to_streamed_response_wrapper(
+            objects.get_summarize_job,
+        )
         self.get_text = async_to_streamed_response_wrapper(
             objects.get_text,
         )