spitch 1.38.0__py3-none-any.whl → 1.39.0__py3-none-any.whl

spitch/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "spitch"
-__version__ = "1.38.0"  # x-release-please-version
+__version__ = "1.39.0"  # x-release-please-version

spitch/resources/files.py

@@ -22,7 +22,6 @@ from ..pagination import SyncFilesCursor, AsyncFilesCursor
 from ..types.file import File
 from .._base_client import AsyncPaginator, make_request_options
 from ..types.file_usage import FileUsage
-from ..types.file_delete_response import FileDeleteResponse
 from ..types.file_download_response import FileDownloadResponse
 
 __all__ = ["FilesResource", "AsyncFilesResource"]
@@ -62,7 +61,16 @@ class FilesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> SyncFilesCursor[File]:
         """
-        Get Files
+        Get a paginated list of files for the authenticated organization.
+
+        Args: identity: Authentication identity containing org_id and user_id limit:
+        Maximum number of files to return (max 100) status: Optional filter by file
+        status (processing, ready, etc.) cursor: Optional pagination cursor for getting
+        next page db: Database session
+
+        Returns: ListFilesResponse: Paginated list of files with metadata
+
+        Raises: HTTPException: 400 if cursor is invalid
 
         Args:
           extra_headers: Send extra headers
@@ -103,9 +111,16 @@ class FilesResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> FileDeleteResponse:
+    ) -> object:
         """
-        Delete File
+        Delete a file and its associated S3 object.
+
+        Args: file_id: UUID of the file to delete identity: Authentication identity
+        containing org_id db: Database session s3: S3 session for deleting objects
+
+        Returns: dict: Success confirmation
+
+        Raises: HTTPException: 404 if file not found or doesn't belong to org
 
         Args:
           extra_headers: Send extra headers
@@ -123,7 +138,7 @@ class FilesResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=FileDeleteResponse,
+            cast_to=object,
         )
 
     def download(
@@ -139,7 +154,17 @@ class FilesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> FileDownloadResponse:
         """
-        Download File
+        Generate a pre-signed download URL for a file.
+
+        Args: file_id: UUID of the file to download identity: Authentication identity
+        containing org_id ttl: Time-to-live for the download URL in seconds (60-3600)
+        db: Database session s3: S3 session for generating pre-signed URLs
+
+        Returns: FileDownloadResponse: Contains file_id, download URL, and expiration
+        time
+
+        Raises: HTTPException: 404 if file not found, doesn't belong to org, or not
+        ready
 
         Args:
           extra_headers: Send extra headers
@@ -176,7 +201,15 @@ class FilesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> File:
         """
-        Get File
+        Get metadata for a specific file.
+
+        Args: file_id: UUID of the file to retrieve identity: Authentication identity
+        containing org_id db: Database session
+
+        Returns: FileMetaResponse: File metadata including upload information
+
+        Raises: HTTPException: 404 if file not found or doesn't belong to org
+        HTTPException: 500 if uploader information is corrupted
 
         Args:
           extra_headers: Send extra headers
@@ -209,7 +242,14 @@ class FilesResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> File:
         """
-        Upload File
+        Upload a file to the Spitch server.
+
+        Args: file: The file to upload from the request identity: Authentication
+        identity containing org_id and user_id db: Database session
+
+        Returns: FileMetaResponse: Metadata for the uploaded file
+
+        Raises: HTTPException: 500 if upload fails
 
         Args:
           extra_headers: Send extra headers
@@ -246,7 +286,15 @@ class FilesResource(SyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> FileUsage:
-        """Get Usage"""
+        """
+        Get storage usage statistics for the authenticated organization.
+
+        Args: identity: Authentication identity containing org_id db: Database session
+
+        Returns: FileUsage: Usage statistics including total/used bytes and file count
+
+        Raises: HTTPException: 500 if unable to calculate usage
+        """
         return self._get(
             "/v1/files:usage",
             options=make_request_options(
@@ -290,7 +338,16 @@ class AsyncFilesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AsyncPaginator[File, AsyncFilesCursor[File]]:
         """
-        Get Files
+        Get a paginated list of files for the authenticated organization.
+
+        Args: identity: Authentication identity containing org_id and user_id limit:
+        Maximum number of files to return (max 100) status: Optional filter by file
+        status (processing, ready, etc.) cursor: Optional pagination cursor for getting
+        next page db: Database session
+
+        Returns: ListFilesResponse: Paginated list of files with metadata
+
+        Raises: HTTPException: 400 if cursor is invalid
 
         Args:
           extra_headers: Send extra headers
@@ -331,9 +388,16 @@ class AsyncFilesResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> FileDeleteResponse:
+    ) -> object:
         """
-        Delete File
+        Delete a file and its associated S3 object.
+
+        Args: file_id: UUID of the file to delete identity: Authentication identity
+        containing org_id db: Database session s3: S3 session for deleting objects
+
+        Returns: dict: Success confirmation
+
+        Raises: HTTPException: 404 if file not found or doesn't belong to org
 
         Args:
           extra_headers: Send extra headers
@@ -351,7 +415,7 @@ class AsyncFilesResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=FileDeleteResponse,
+            cast_to=object,
         )
 
     async def download(
@@ -367,7 +431,17 @@ class AsyncFilesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> FileDownloadResponse:
         """
-        Download File
+        Generate a pre-signed download URL for a file.
+
+        Args: file_id: UUID of the file to download identity: Authentication identity
+        containing org_id ttl: Time-to-live for the download URL in seconds (60-3600)
+        db: Database session s3: S3 session for generating pre-signed URLs
+
+        Returns: FileDownloadResponse: Contains file_id, download URL, and expiration
+        time
+
+        Raises: HTTPException: 404 if file not found, doesn't belong to org, or not
+        ready
 
         Args:
           extra_headers: Send extra headers
@@ -404,7 +478,15 @@ class AsyncFilesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> File:
         """
-        Get File
+        Get metadata for a specific file.
+
+        Args: file_id: UUID of the file to retrieve identity: Authentication identity
+        containing org_id db: Database session
+
+        Returns: FileMetaResponse: File metadata including upload information
+
+        Raises: HTTPException: 404 if file not found or doesn't belong to org
+        HTTPException: 500 if uploader information is corrupted
 
         Args:
           extra_headers: Send extra headers
@@ -437,7 +519,14 @@ class AsyncFilesResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> File:
         """
-        Upload File
+        Upload a file to the Spitch server.
+
+        Args: file: The file to upload from the request identity: Authentication
+        identity containing org_id and user_id db: Database session
+
+        Returns: FileMetaResponse: Metadata for the uploaded file
+
+        Raises: HTTPException: 500 if upload fails
 
         Args:
           extra_headers: Send extra headers
@@ -474,7 +563,15 @@ class AsyncFilesResource(AsyncAPIResource):
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> FileUsage:
-        """Get Usage"""
+        """
+        Get storage usage statistics for the authenticated organization.
+
+        Args: identity: Authentication identity containing org_id db: Database session
+
+        Returns: FileUsage: Usage statistics including total/used bytes and file count
+
+        Raises: HTTPException: 500 if unable to calculate usage
+        """
         return await self._get(
             "/v1/files:usage",
             options=make_request_options(

spitch/resources/speech.py

@@ -33,6 +33,8 @@ __all__ = ["SpeechResource", "AsyncSpeechResource"]
 
 
 class SpeechResource(SyncAPIResource):
+    """All speech-focused APIs (TTS and STT)"""
+
     @cached_property
     def with_raw_response(self) -> SpeechResourceWithRawResponse:
         """
@@ -102,7 +104,7 @@ class SpeechResource(SyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        extra_headers = {"Accept": "audio/wav", **(extra_headers or {})}
+        extra_headers = {"Accept": "audio/*", **(extra_headers or {})}
         return self._post(
             "/v1/speech",
             body=maybe_transform(
@@ -176,6 +178,8 @@ class SpeechResource(SyncAPIResource):
 
 
 class AsyncSpeechResource(AsyncAPIResource):
+    """All speech-focused APIs (TTS and STT)"""
+
     @cached_property
     def with_raw_response(self) -> AsyncSpeechResourceWithRawResponse:
         """
@@ -245,7 +249,7 @@ class AsyncSpeechResource(AsyncAPIResource):
 
           timeout: Override the client-level default timeout for this request, in seconds
         """
-        extra_headers = {"Accept": "audio/wav", **(extra_headers or {})}
+        extra_headers = {"Accept": "audio/*", **(extra_headers or {})}
         return await self._post(
             "/v1/speech",
             body=await async_maybe_transform(

spitch/resources/text.py

@@ -2,12 +2,13 @@
 
 from __future__ import annotations
 
+from typing import Optional
 from typing_extensions import Literal
 
 import httpx
 
 from ..types import text_tone_mark_params, text_translate_params
-from .._types import Body, Query, Headers, NotGiven, not_given
+from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
 from .._utils import maybe_transform, async_maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
@@ -88,7 +89,10 @@ class TextResource(SyncAPIResource):
         *,
         source: Literal["yo", "en", "ha", "ig", "am"],
         target: Literal["yo", "en", "ha", "ig", "am"],
-        text: str,
+        file_id: Optional[str] | Omit = omit,
+        instructions: Optional[str] | Omit = omit,
+        model: Literal["human", "auto"] | Omit = omit,
+        text: 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,
@@ -114,6 +118,9 @@ class TextResource(SyncAPIResource):
                 {
                     "source": source,
                     "target": target,
+                    "file_id": file_id,
+                    "instructions": instructions,
+                    "model": model,
                     "text": text,
                 },
                 text_translate_params.TextTranslateParams,
@@ -189,7 +196,10 @@ class AsyncTextResource(AsyncAPIResource):
         *,
         source: Literal["yo", "en", "ha", "ig", "am"],
         target: Literal["yo", "en", "ha", "ig", "am"],
-        text: str,
+        file_id: Optional[str] | Omit = omit,
+        instructions: Optional[str] | Omit = omit,
+        model: Literal["human", "auto"] | Omit = omit,
+        text: 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,
@@ -215,6 +225,9 @@ class AsyncTextResource(AsyncAPIResource):
                 {
                     "source": source,
                     "target": target,
+                    "file_id": file_id,
+                    "instructions": instructions,
+                    "model": model,
                     "text": text,
                 },
                 text_translate_params.TextTranslateParams,

spitch/types/__init__.py

@@ -10,7 +10,6 @@ from .translation import Translation as Translation
 from .transcription import Transcription as Transcription
 from .file_list_params import FileListParams as FileListParams
 from .file_upload_params import FileUploadParams as FileUploadParams
-from .file_delete_response import FileDeleteResponse as FileDeleteResponse
 from .file_download_params import FileDownloadParams as FileDownloadParams
 from .text_tone_mark_params import TextToneMarkParams as TextToneMarkParams
 from .text_translate_params import TextTranslateParams as TextTranslateParams

spitch/types/file.py

@@ -2,6 +2,7 @@
 
 from typing import Optional
 from datetime import datetime
+from typing_extensions import Literal
 
 from .._models import BaseModel
 
@@ -21,6 +22,6 @@ class File(BaseModel):
 
     size_bytes: Optional[int] = None
 
-    status: str
+    status: Literal["uploading", "ready"]
 
     uploaded_by: Optional[str] = None

spitch/types/text_translate_params.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Optional
 from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["TextTranslateParams"]
@@ -12,4 +13,10 @@ class TextTranslateParams(TypedDict, total=False):
 
     target: Required[Literal["yo", "en", "ha", "ig", "am"]]
 
-    text: Required[str]
+    file_id: Optional[str]
+
+    instructions: Optional[str]
+
+    model: Literal["human", "auto"]
+
+    text: Optional[str]

spitch/types/translation.py

@@ -1,5 +1,8 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+from typing import Optional
+from datetime import datetime
+
 from .._models import BaseModel
 
 __all__ = ["Translation"]
@@ -9,3 +12,5 @@ class Translation(BaseModel):
     request_id: str
 
     text: str
+
+    due_date: Optional[datetime] = None

{spitch-1.38.0.dist-info → spitch-1.39.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: spitch
-Version: 1.38.0
+Version: 1.39.0
 Summary: The official Python library for the spitch API
 Project-URL: Homepage, https://github.com/spi-tch/spitch-python
 Project-URL: Repository, https://github.com/spi-tch/spitch-python

{spitch-1.38.0.dist-info → spitch-1.39.0.dist-info}/RECORD

@@ -11,7 +11,7 @@ spitch/_resource.py,sha256=TLFPcOOmtxZOQLh3XCNPB_BdrQpp0MIYoKoH52aRAu8,1100
 spitch/_response.py,sha256=-1LLK1wjPW3Hcro9NXjf_SnPRArU1ozdctNIStvxbWo,28690
 spitch/_streaming.py,sha256=5SpId2EIfF8Ee8UUYmJxqgHUGP1ZdHCUHhHCdNJREFA,10100
 spitch/_types.py,sha256=oa5CdZaglGw0wrxxpdWxeoliiTfNpce300esw52GnGk,7260
-spitch/_version.py,sha256=0N9Hhk8Ou5F_nU7MD3SYh_68q3OT8_gsDWao5-oz858,159
+spitch/_version.py,sha256=hsTeegcoUyLuJZ43lFF7-m_PsheGWgh3sW24EumLikU,159
 spitch/pagination.py,sha256=XQaAXcd1OtYzc7zqwCJLQVqFMkC0W-1-0njeSyxT88A,1312
 spitch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 spitch/_utils/__init__.py,sha256=WhaZJLzT8oCtvdIvbs8gyd6emLYa4usodcqgcpFiciU,2259
@@ -28,13 +28,12 @@ spitch/_utils/_typing.py,sha256=AmI-ZWKfmGpa8sE_wXUPqJm-aqfO8JapbGAk7bX-Sy0,4156
 spitch/_utils/_utils.py,sha256=0dDqauUbVZEXV0NVl7Bwu904Wwo5eyFCZpQThhFNhyA,12253
 spitch/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
 spitch/resources/__init__.py,sha256=oUfkZqMUtVuaZj1l1YuWwDDcfCTFMs89K1-DNgM89VY,1413
-spitch/resources/files.py,sha256=wslju1bXne3gIRBBLQs49BQwAQhARvF1JGTemGtkcNI,21492
-spitch/resources/speech.py,sha256=OiwFiY3shX0vi1NwvAresjfbAQC9CR9w355cuaDpz0U,13432
-spitch/resources/text.py,sha256=jPOwxYWoqDUWvbmYlYsMJiZLDy4-C_gIzhnvsbY3p94,9555
-spitch/types/__init__.py,sha256=716oGh0nu8qXtnA8yGH5Hj8VDYSnVKm93pYAFwdO0E0,1079
+spitch/resources/files.py,sha256=Tac8zPK6unJEzeB57ZlBuPVC1EasIiImNrs-qERZCkg,25938
+spitch/resources/speech.py,sha256=8hPIV_Xw-bFMn0Oo96bx6OorRKvy4xi_e3VZkKsBCEg,13526
+spitch/resources/text.py,sha256=O6jJCtoM5ajVOn1s6q48Pz3OvZhL6HwYJg0ukpkHDJw,10199
+spitch/types/__init__.py,sha256=FiURBa3qgB02NnovHxVjAQwTihCMb-06hMpVkihJNPs,1004
 spitch/types/diacritics.py,sha256=btOCAZTQ5qLjN78nCb7kyfJeBeBKW4nXlA9T8hsVquE,211
-spitch/types/file.py,sha256=xRfk8t2q7YhQFzhjL8S1EHImdFWwXGIBiUhDDw1Tytk,477
-spitch/types/file_delete_response.py,sha256=r4OwDVrG4BGSEdqYyr7iPpaPzon5pm5Wx61KIRZk1zY,255
+spitch/types/file.py,sha256=JqaBmIenjSwk4Z3-Idyg7CQF4Xvu5m7m4JsqeiSJUsY,541
 spitch/types/file_download_params.py,sha256=tCiwTeSSbPuniZXdiOQll7Bdc2enBp9yJD-D9SpeEqg,262
 spitch/types/file_download_response.py,sha256=OeO6JIFo97dLZcL8iTtazGU1PVZy1rp5VVa5w6d8DHg,284
 spitch/types/file_list_params.py,sha256=FrWZhMUC38sGkBtdQKateTyStVuMOz90x5AHtkoZnzk,373
@@ -44,10 +43,10 @@ spitch/types/files.py,sha256=FkNfexYBP3Ug4klnbGbGQTtXj6DC9y4Akbhd78ijb-c,285
 spitch/types/speech_generate_params.py,sha256=9kjye1XOMJPNZginEDMTS6Gt05bkB1s1r5H7oEj1Chk,1037
 spitch/types/speech_transcribe_params.py,sha256=fAVwTfPRR4aLzcu4Y8qrmKXESemnWJIdnyhyVcR3W20,613
 spitch/types/text_tone_mark_params.py,sha256=MEnWzcSjPT_Z_8Mio96LgwYbx2BngG5By-MoeSt0Sms,355
-spitch/types/text_translate_params.py,sha256=skEeG7oTZUSl_gugnqL4Mb7HE_pEFhKNygZPTvci2hA,416
+spitch/types/text_translate_params.py,sha256=3rHSFo3ITqvUEGkm2iL-cy1HDZnYeojqHdgc3W2oWfc,542
 spitch/types/transcription.py,sha256=SrbWIwItrt-FdPUPV8PofYTxzLCiwxg7Ya4QsKE1PoY,393
-spitch/types/translation.py,sha256=ICtp42meKFR_CvfW5mSmy3Y0az8SuIhdDi3BAfnWs8k,213
-spitch-1.38.0.dist-info/METADATA,sha256=rQ54GbRfWe6zKwGeyuolLkjXuOdpWIN8YoaySvY5Jzg,15962
-spitch-1.38.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-spitch-1.38.0.dist-info/licenses/LICENSE,sha256=C0lDWY-no8IxmnqzQA9BA7Z8jeh_bogVPfeWSgeDDcc,11336
-spitch-1.38.0.dist-info/RECORD,,
+spitch/types/translation.py,sha256=GbqjtTZTuULha75cMEUVizfz8ZenvdFHQ2jr7_1wxNY,313
+spitch-1.39.0.dist-info/METADATA,sha256=8ikEyUlW9cBJwlnhXMooXu-Xa1B52t9_lnsa24EJbXU,15962
+spitch-1.39.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+spitch-1.39.0.dist-info/licenses/LICENSE,sha256=C0lDWY-no8IxmnqzQA9BA7Z8jeh_bogVPfeWSgeDDcc,11336
+spitch-1.39.0.dist-info/RECORD,,

spitch/types/file_delete_response.py

@@ -1,11 +0,0 @@
-# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-from typing import Optional
-
-from .._models import BaseModel
-
-__all__ = ["FileDeleteResponse"]
-
-
-class FileDeleteResponse(BaseModel):
-    status: Optional[bool] = None