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

casedev/types/vault/object_delete_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["ObjectDeleteParams"]
+
+
+class ObjectDeleteParams(TypedDict, total=False):
+    id: Required[str]
+
+    force: Literal["true"]
+    """Force delete a stuck document that is still in 'processing' state.
+
+    Use this if a document got stuck during ingestion (e.g., OCR timeout).
+    """

casedev/types/vault/object_delete_response.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ObjectDeleteResponse", "DeletedObject"]
+
+
+class DeletedObject(BaseModel):
+    id: Optional[str] = None
+    """Deleted object ID"""
+
+    filename: Optional[str] = None
+    """Original filename"""
+
+    size_bytes: Optional[int] = FieldInfo(alias="sizeBytes", default=None)
+    """Size of deleted file in bytes"""
+
+    vectors_deleted: Optional[int] = FieldInfo(alias="vectorsDeleted", default=None)
+    """Number of vectors deleted"""
+
+
+class ObjectDeleteResponse(BaseModel):
+    deleted_object: Optional[DeletedObject] = FieldInfo(alias="deletedObject", default=None)
+
+    success: Optional[bool] = None

casedev/types/vault/object_get_ocr_words_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ObjectGetOcrWordsParams"]
+
+
+class ObjectGetOcrWordsParams(TypedDict, total=False):
+    id: Required[str]
+
+    page: int
+    """Filter to a specific page number (1-indexed). If omitted, returns all pages."""
+
+    word_end: Annotated[int, PropertyInfo(alias="wordEnd")]
+    """Filter to words ending at this index (inclusive).
+
+    Useful for retrieving words for a specific chunk.
+    """
+
+    word_start: Annotated[int, PropertyInfo(alias="wordStart")]
+    """Filter to words starting at this index (inclusive).
+
+    Useful for retrieving words for a specific chunk.
+    """

casedev/types/vault/object_get_ocr_words_response.py

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ObjectGetOcrWordsResponse", "Page", "PageWord"]
+
+
+class PageWord(BaseModel):
+    bbox: Optional[List[float]] = None
+    """Bounding box [x0, y0, x1, y1] normalized to 0-1 range"""
+
+    confidence: Optional[float] = None
+    """OCR confidence score (0-1)"""
+
+    text: Optional[str] = None
+    """The word text"""
+
+    word_index: Optional[int] = FieldInfo(alias="wordIndex", default=None)
+    """Global word index across the entire document (0-based)"""
+
+
+class Page(BaseModel):
+    page: Optional[int] = None
+    """Page number (1-indexed)"""
+
+    words: Optional[List[PageWord]] = None
+
+
+class ObjectGetOcrWordsResponse(BaseModel):
+    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+    """When the OCR data was extracted"""
+
+    object_id: Optional[str] = FieldInfo(alias="objectId", default=None)
+    """The object ID"""
+
+    page_count: Optional[int] = FieldInfo(alias="pageCount", default=None)
+    """Total number of pages in the document"""
+
+    pages: Optional[List[Page]] = None
+    """Per-page word data with bounding boxes"""
+
+    total_words: Optional[int] = FieldInfo(alias="totalWords", default=None)
+    """Total number of words extracted from the document"""

casedev/types/vault/object_get_summarize_job_response.py

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ObjectGetSummarizeJobResponse"]
+
+
+class ObjectGetSummarizeJobResponse(BaseModel):
+    completed_at: Optional[datetime] = FieldInfo(alias="completedAt", default=None)
+    """When the job completed"""
+
+    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+    """When the job was created"""
+
+    error: Optional[str] = None
+    """Error message (if failed)"""
+
+    job_id: Optional[str] = FieldInfo(alias="jobId", default=None)
+    """Case.dev job ID"""
+
+    result_filename: Optional[str] = FieldInfo(alias="resultFilename", default=None)
+    """Filename of the result document (if completed)"""
+
+    result_object_id: Optional[str] = FieldInfo(alias="resultObjectId", default=None)
+    """ID of the result document (if completed)"""
+
+    source_object_id: Optional[str] = FieldInfo(alias="sourceObjectId", default=None)
+    """ID of the source document"""
+
+    status: Optional[Literal["pending", "processing", "completed", "failed"]] = None
+    """Current job status"""
+
+    workflow_type: Optional[str] = FieldInfo(alias="workflowType", default=None)
+    """Type of workflow being executed"""

casedev/types/vault/object_get_text_response.py

@@ -9,27 +9,27 @@ __all__ = ["ObjectGetTextResponse", "Metadata"]
 
 
 class Metadata(BaseModel):
-    chunk_count: Optional[int] = None
+    chunk_count: int
     """Number of text chunks the document was split into"""
 
-    filename: Optional[str] = None
+    filename: str
     """Original filename of the document"""
 
-    ingestion_completed_at: Optional[datetime] = None
-    """When the document processing completed"""
-
-    length: Optional[int] = None
+    length: int
     """Total character count of the extracted text"""
 
-    object_id: Optional[str] = None
+    object_id: str
     """The object ID"""
 
-    vault_id: Optional[str] = None
+    vault_id: str
     """The vault ID"""
 
+    ingestion_completed_at: Optional[datetime] = None
+    """When the document processing completed"""
+
 
 class ObjectGetTextResponse(BaseModel):
-    metadata: Optional[Metadata] = None
+    metadata: Metadata
 
-    text: Optional[str] = None
+    text: str
     """Full concatenated text content from all chunks"""

casedev/types/vault/object_list_response.py

@@ -11,27 +11,27 @@ __all__ = ["ObjectListResponse", "Object"]
 
 
 class Object(BaseModel):
-    id: Optional[str] = None
+    id: str
     """Unique object identifier"""
 
-    chunk_count: Optional[float] = FieldInfo(alias="chunkCount", default=None)
-    """Number of text chunks created for vectorization"""
-
-    content_type: Optional[str] = FieldInfo(alias="contentType", default=None)
+    content_type: str = FieldInfo(alias="contentType")
     """MIME type of the document"""
 
-    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+    created_at: datetime = FieldInfo(alias="createdAt")
     """Document upload timestamp"""
 
-    filename: Optional[str] = None
+    filename: str
     """Original filename of the uploaded document"""
 
+    ingestion_status: str = FieldInfo(alias="ingestionStatus")
+    """Processing status of the document"""
+
+    chunk_count: Optional[float] = FieldInfo(alias="chunkCount", default=None)
+    """Number of text chunks created for vectorization"""
+
     ingestion_completed_at: Optional[datetime] = FieldInfo(alias="ingestionCompletedAt", default=None)
     """Processing completion timestamp"""
 
-    ingestion_status: Optional[str] = FieldInfo(alias="ingestionStatus", default=None)
-    """Processing status of the document"""
-
     metadata: Optional[object] = None
     """Custom metadata associated with the document"""
 
@@ -55,10 +55,10 @@ class Object(BaseModel):
 
 
 class ObjectListResponse(BaseModel):
-    count: Optional[float] = None
+    count: float
     """Total number of objects in the vault"""
 
-    objects: Optional[List[Object]] = None
+    objects: List[Object]
 
-    vault_id: Optional[str] = FieldInfo(alias="vaultId", default=None)
+    vault_id: str = FieldInfo(alias="vaultId")
     """The ID of the vault"""

casedev/types/vault/object_retrieve_response.py

@@ -11,30 +11,33 @@ __all__ = ["ObjectRetrieveResponse"]
 
 
 class ObjectRetrieveResponse(BaseModel):
-    id: Optional[str] = None
+    id: str
     """Object ID"""
 
-    chunk_count: Optional[int] = FieldInfo(alias="chunkCount", default=None)
-    """Number of text chunks created"""
-
-    content_type: Optional[str] = FieldInfo(alias="contentType", default=None)
+    content_type: str = FieldInfo(alias="contentType")
     """MIME type"""
 
-    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+    created_at: datetime = FieldInfo(alias="createdAt")
     """Upload timestamp"""
 
-    download_url: Optional[str] = FieldInfo(alias="downloadUrl", default=None)
+    download_url: str = FieldInfo(alias="downloadUrl")
     """Presigned S3 download URL"""
 
-    expires_in: Optional[int] = FieldInfo(alias="expiresIn", default=None)
+    expires_in: int = FieldInfo(alias="expiresIn")
     """URL expiration time in seconds"""
 
-    filename: Optional[str] = None
+    filename: str
     """Original filename"""
 
-    ingestion_status: Optional[str] = FieldInfo(alias="ingestionStatus", default=None)
+    ingestion_status: str = FieldInfo(alias="ingestionStatus")
     """Processing status (pending, processing, completed, failed)"""
 
+    vault_id: str = FieldInfo(alias="vaultId")
+    """Vault ID"""
+
+    chunk_count: Optional[int] = FieldInfo(alias="chunkCount", default=None)
+    """Number of text chunks created"""
+
     metadata: Optional[object] = None
     """Additional metadata"""
 
@@ -50,8 +53,5 @@ class ObjectRetrieveResponse(BaseModel):
     text_length: Optional[int] = FieldInfo(alias="textLength", default=None)
     """Length of extracted text"""
 
-    vault_id: Optional[str] = FieldInfo(alias="vaultId", default=None)
-    """Vault ID"""
-
     vector_count: Optional[int] = FieldInfo(alias="vectorCount", default=None)
     """Number of embedding vectors generated"""

casedev/types/vault/object_update_params.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["ObjectUpdateParams"]
+
+
+class ObjectUpdateParams(TypedDict, total=False):
+    id: Required[str]
+
+    filename: str
+    """New filename for the document (affects display name and downloads)"""
+
+    metadata: object
+    """Additional metadata to merge with existing metadata"""
+
+    path: Optional[str]
+    """Folder path for hierarchy preservation (e.g., '/Discovery/Depositions').
+
+    Set to null or empty string to remove.
+    """

casedev/types/vault/object_update_response.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ObjectUpdateResponse"]
+
+
+class ObjectUpdateResponse(BaseModel):
+    id: Optional[str] = None
+    """Object ID"""
+
+    content_type: Optional[str] = FieldInfo(alias="contentType", default=None)
+    """MIME type"""
+
+    filename: Optional[str] = None
+    """Updated filename"""
+
+    ingestion_status: Optional[str] = FieldInfo(alias="ingestionStatus", default=None)
+    """Processing status"""
+
+    metadata: Optional[object] = None
+    """Full metadata object"""
+
+    path: Optional[str] = None
+    """Folder path for hierarchy preservation"""
+
+    size_bytes: Optional[int] = FieldInfo(alias="sizeBytes", default=None)
+    """File size in bytes"""
+
+    updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
+    """Last update timestamp"""
+
+    vault_id: Optional[str] = FieldInfo(alias="vaultId", default=None)
+    """Vault ID"""

casedev/types/vault_delete_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["VaultDeleteParams"]
+
+
+class VaultDeleteParams(TypedDict, total=False):
+    async_: Annotated[bool, PropertyInfo(alias="async")]
+    """
+    If true and vault has many objects, queue deletion in background and return
+    immediately
+    """

casedev/types/vault_delete_response.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["VaultDeleteResponse", "DeletedVault"]
+
+
+class DeletedVault(BaseModel):
+    id: Optional[str] = None
+
+    bytes_freed: Optional[int] = FieldInfo(alias="bytesFreed", default=None)
+
+    name: Optional[str] = None
+
+    objects_deleted: Optional[int] = FieldInfo(alias="objectsDeleted", default=None)
+
+    vectors_deleted: Optional[int] = FieldInfo(alias="vectorsDeleted", default=None)
+
+
+class VaultDeleteResponse(BaseModel):
+    deleted_vault: Optional[DeletedVault] = FieldInfo(alias="deletedVault", default=None)
+
+    status: Optional[str] = None
+    """Either 'deleted' or 'deletion_queued'"""
+
+    success: Optional[bool] = None

casedev/types/vault_retrieve_response.py

@@ -27,24 +27,30 @@ class ChunkStrategy(BaseModel):
 
 
 class VaultRetrieveResponse(BaseModel):
-    id: Optional[str] = None
+    id: str
     """Vault identifier"""
 
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """Vault creation timestamp"""
+
+    files_bucket: str = FieldInfo(alias="filesBucket")
+    """S3 bucket for document storage"""
+
+    name: str
+    """Vault name"""
+
+    region: str
+    """AWS region"""
+
     chunk_strategy: Optional[ChunkStrategy] = FieldInfo(alias="chunkStrategy", default=None)
     """Document chunking strategy configuration"""
 
-    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
-    """Vault creation timestamp"""
-
     description: Optional[str] = None
     """Vault description"""
 
     enable_graph: Optional[bool] = FieldInfo(alias="enableGraph", default=None)
     """Whether GraphRAG is enabled"""
 
-    files_bucket: Optional[str] = FieldInfo(alias="filesBucket", default=None)
-    """S3 bucket for document storage"""
-
     index_name: Optional[str] = FieldInfo(alias="indexName", default=None)
     """Search index name"""
 
@@ -54,12 +60,6 @@ class VaultRetrieveResponse(BaseModel):
     metadata: Optional[object] = None
     """Additional vault metadata"""
 
-    name: Optional[str] = None
-    """Vault name"""
-
-    region: Optional[str] = None
-    """AWS region"""
-
     total_bytes: Optional[int] = FieldInfo(alias="totalBytes", default=None)
     """Total storage size in bytes"""
 

casedev/types/vault_search_response.py

@@ -41,6 +41,20 @@ class Chunk(BaseModel):
     text: Optional[str] = None
     """Preview of the chunk text (up to 500 characters)"""
 
+    word_end_index: Optional[int] = None
+    """Ending word index (0-based) in the OCR word list.
+
+    Use with GET /vault/:id/objects/:objectId/ocr-words to retrieve bounding boxes
+    for highlighting.
+    """
+
+    word_start_index: Optional[int] = None
+    """Starting word index (0-based) in the OCR word list.
+
+    Use with GET /vault/:id/objects/:objectId/ocr-words to retrieve bounding boxes
+    for highlighting.
+    """
+
 
 class Source(BaseModel):
     id: Optional[str] = None

casedev/types/vault_update_params.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["VaultUpdateParams"]
+
+
+class VaultUpdateParams(TypedDict, total=False):
+    description: Optional[str]
+    """New description for the vault. Set to null to remove."""
+
+    enable_graph: Annotated[bool, PropertyInfo(alias="enableGraph")]
+    """Whether to enable GraphRAG for future document uploads"""
+
+    name: str
+    """New name for the vault"""

casedev/types/vault_update_response.py

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["VaultUpdateResponse"]
+
+
+class VaultUpdateResponse(BaseModel):
+    id: Optional[str] = None
+    """Vault identifier"""
+
+    chunk_strategy: Optional[object] = FieldInfo(alias="chunkStrategy", default=None)
+    """Document chunking strategy configuration"""
+
+    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+    """Vault creation timestamp"""
+
+    description: Optional[str] = None
+    """Vault description"""
+
+    enable_graph: Optional[bool] = FieldInfo(alias="enableGraph", default=None)
+    """Whether GraphRAG is enabled for future uploads"""
+
+    files_bucket: Optional[str] = FieldInfo(alias="filesBucket", default=None)
+    """S3 bucket for document storage"""
+
+    index_name: Optional[str] = FieldInfo(alias="indexName", default=None)
+    """Search index name"""
+
+    kms_key_id: Optional[str] = FieldInfo(alias="kmsKeyId", default=None)
+    """KMS key for encryption"""
+
+    metadata: Optional[object] = None
+    """Additional vault metadata"""
+
+    name: Optional[str] = None
+    """Vault name"""
+
+    region: Optional[str] = None
+    """AWS region"""
+
+    total_bytes: Optional[int] = FieldInfo(alias="totalBytes", default=None)
+    """Total storage size in bytes"""
+
+    total_objects: Optional[int] = FieldInfo(alias="totalObjects", default=None)
+    """Number of stored documents"""
+
+    total_vectors: Optional[int] = FieldInfo(alias="totalVectors", default=None)
+    """Number of vector embeddings"""
+
+    updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
+    """Last update timestamp"""
+
+    vector_bucket: Optional[str] = FieldInfo(alias="vectorBucket", default=None)
+    """S3 bucket for vector embeddings"""

casedev/types/vault_upload_params.py

@@ -29,5 +29,8 @@ class VaultUploadParams(TypedDict, total=False):
     NetDocs, Clio, or Smokeball. Example: '/Discovery/Depositions/2024'
     """
 
-    size_bytes: Annotated[float, PropertyInfo(alias="sizeBytes")]
-    """Estimated file size in bytes for cost calculation"""
+    size_bytes: Annotated[int, PropertyInfo(alias="sizeBytes")]
+    """File size in bytes (optional, max 5GB for single PUT uploads).
+
+    When provided, enforces exact file size at S3 level.
+    """

{casedev-0.2.0.dist-info → casedev-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: casedev
-Version: 0.2.0
+Version: 0.4.0
 Summary: The official Python library for the casedev API
 Project-URL: Homepage, https://github.com/CaseMark/casedev-python
 Project-URL: Repository, https://github.com/CaseMark/casedev-python