spitch 1.35.0__tar.gz → 1.37.0__tar.gz

spitch-1.37.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.37.0"
+}

{spitch-1.35.0 → spitch-1.37.0}/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.37.0 (2025-10-06)
+
+Full Changelog: [v1.36.0...v1.37.0](https://github.com/spi-tch/spitch-python/compare/v1.36.0...v1.37.0)
+
+### Features
+
+* **api:** manual updates ([c8f4f39](https://github.com/spi-tch/spitch-python/commit/c8f4f3942e2a9a7a2c3897a81288ab03e9172885))
+
+## 1.36.0 (2025-10-06)
+
+Full Changelog: [v1.35.0...v1.36.0](https://github.com/spi-tch/spitch-python/compare/v1.35.0...v1.36.0)
+
+### Features
+
+* **api:** manual updates ([813fc60](https://github.com/spi-tch/spitch-python/commit/813fc60ce810fc61aa542eae3a780bce8b21e506))
+
 ## 1.35.0 (2025-10-06)
 
 Full Changelog: [v1.34.0...v1.35.0](https://github.com/spi-tch/spitch-python/compare/v1.34.0...v1.35.0)

{spitch-1.35.0 → spitch-1.37.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: spitch
-Version: 1.35.0
+Version: 1.37.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
@@ -70,8 +70,8 @@ client = Spitch(
 
 response = client.speech.generate(
     language="yo",
-    text="text",
-    voice="sade",
+    text="Bawo ni, ololufe?",
+    voice="femi",
 )
 ```
 
@@ -97,8 +97,8 @@ client = AsyncSpitch(
 async def main() -> None:
     response = await client.speech.generate(
         language="yo",
-        text="text",
-        voice="sade",
+        text="Bawo ni, ololufe?",
+        voice="femi",
     )
 
 
@@ -133,8 +133,8 @@ async def main() -> None:
     ) as client:
         response = await client.speech.generate(
             language="yo",
-            text="text",
-            voice="sade",
+            text="Bawo ni, ololufe?",
+            voice="femi",
         )
 
 
@@ -150,6 +150,77 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Pagination
+
+List methods in the Spitch API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```python
+from spitch import Spitch
+
+client = Spitch()
+
+all_files = []
+# Automatically fetches more pages as needed.
+for file in client.files.list(
+    limit=10,
+):
+    # Do something with file here
+    all_files.append(file)
+print(all_files)
+```
+
+Or, asynchronously:
+
+```python
+import asyncio
+from spitch import AsyncSpitch
+
+client = AsyncSpitch()
+
+
+async def main() -> None:
+    all_files = []
+    # Iterate through items across all pages, issuing requests as needed.
+    async for file in client.files.list(
+        limit=10,
+    ):
+        all_files.append(file)
+    print(all_files)
+
+
+asyncio.run(main())
+```
+
+Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
+
+```python
+first_page = await client.files.list(
+    limit=10,
+)
+if first_page.has_next_page():
+    print(f"will fetch next page using these details: {first_page.next_page_info()}")
+    next_page = await first_page.get_next_page()
+    print(f"number of items we just fetched: {len(next_page.items)}")
+
+# Remove `await` for non-async usage.
+```
+
+Or just work directly with the returned data:
+
+```python
+first_page = await client.files.list(
+    limit=10,
+)
+
+print(f"next page cursor: {first_page.next_cursor}")  # => "next page cursor: ..."
+for file in first_page.items:
+    print(file.file_id)
+
+# Remove `await` for non-async usage.
+```
+
 ## File uploads
 
 Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
@@ -186,7 +257,7 @@ client = Spitch()
 try:
     client.speech.generate(
         language="yo",
-        text="text",
+        text="Bawo ni, ololufe?",
         voice="sade",
     )
 except spitch.APIConnectionError as e:
@@ -233,7 +304,7 @@ client = Spitch(
 # Or, configure per-request:
 client.with_options(max_retries=5).speech.generate(
     language="yo",
-    text="text",
+    text="Bawo ni, ololufe?",
     voice="sade",
 )
 ```
@@ -260,7 +331,7 @@ client = Spitch(
 # Override per-request:
 client.with_options(timeout=5.0).speech.generate(
     language="yo",
-    text="text",
+    text="Bawo ni, ololufe?",
     voice="sade",
 )
 ```
@@ -303,7 +374,7 @@ from spitch import Spitch
 client = Spitch()
 response = client.speech.with_raw_response.generate(
     language="yo",
-    text="text",
+    text="Bawo ni, ololufe?",
     voice="sade",
 )
 print(response.headers.get('X-My-Header'))
@@ -325,7 +396,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 ```python
 with client.speech.with_streaming_response.generate(
     language="yo",
-    text="text",
+    text="Bawo ni, ololufe?",
     voice="sade",
 ) as response:
     print(response.headers.get("X-My-Header"))

{spitch-1.35.0 → spitch-1.37.0}/README.md

@@ -34,8 +34,8 @@ client = Spitch(
 
 response = client.speech.generate(
     language="yo",
-    text="text",
-    voice="sade",
+    text="Bawo ni, ololufe?",
+    voice="femi",
 )
 ```
 
@@ -61,8 +61,8 @@ client = AsyncSpitch(
 async def main() -> None:
     response = await client.speech.generate(
         language="yo",
-        text="text",
-        voice="sade",
+        text="Bawo ni, ololufe?",
+        voice="femi",
     )
 
 
@@ -97,8 +97,8 @@ async def main() -> None:
     ) as client:
         response = await client.speech.generate(
             language="yo",
-            text="text",
-            voice="sade",
+            text="Bawo ni, ololufe?",
+            voice="femi",
         )
 
 
@@ -114,6 +114,77 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Pagination
+
+List methods in the Spitch API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```python
+from spitch import Spitch
+
+client = Spitch()
+
+all_files = []
+# Automatically fetches more pages as needed.
+for file in client.files.list(
+    limit=10,
+):
+    # Do something with file here
+    all_files.append(file)
+print(all_files)
+```
+
+Or, asynchronously:
+
+```python
+import asyncio
+from spitch import AsyncSpitch
+
+client = AsyncSpitch()
+
+
+async def main() -> None:
+    all_files = []
+    # Iterate through items across all pages, issuing requests as needed.
+    async for file in client.files.list(
+        limit=10,
+    ):
+        all_files.append(file)
+    print(all_files)
+
+
+asyncio.run(main())
+```
+
+Alternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:
+
+```python
+first_page = await client.files.list(
+    limit=10,
+)
+if first_page.has_next_page():
+    print(f"will fetch next page using these details: {first_page.next_page_info()}")
+    next_page = await first_page.get_next_page()
+    print(f"number of items we just fetched: {len(next_page.items)}")
+
+# Remove `await` for non-async usage.
+```
+
+Or just work directly with the returned data:
+
+```python
+first_page = await client.files.list(
+    limit=10,
+)
+
+print(f"next page cursor: {first_page.next_cursor}")  # => "next page cursor: ..."
+for file in first_page.items:
+    print(file.file_id)
+
+# Remove `await` for non-async usage.
+```
+
 ## File uploads
 
 Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
@@ -150,7 +221,7 @@ client = Spitch()
 try:
     client.speech.generate(
         language="yo",
-        text="text",
+        text="Bawo ni, ololufe?",
         voice="sade",
     )
 except spitch.APIConnectionError as e:
@@ -197,7 +268,7 @@ client = Spitch(
 # Or, configure per-request:
 client.with_options(max_retries=5).speech.generate(
     language="yo",
-    text="text",
+    text="Bawo ni, ololufe?",
     voice="sade",
 )
 ```
@@ -224,7 +295,7 @@ client = Spitch(
 # Override per-request:
 client.with_options(timeout=5.0).speech.generate(
     language="yo",
-    text="text",
+    text="Bawo ni, ololufe?",
     voice="sade",
 )
 ```
@@ -267,7 +338,7 @@ from spitch import Spitch
 client = Spitch()
 response = client.speech.with_raw_response.generate(
     language="yo",
-    text="text",
+    text="Bawo ni, ololufe?",
     voice="sade",
 )
 print(response.headers.get('X-My-Header'))
@@ -289,7 +360,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 ```python
 with client.speech.with_streaming_response.generate(
     language="yo",
-    text="text",
+    text="Bawo ni, ololufe?",
     voice="sade",
 ) as response:
     print(response.headers.get("X-My-Header"))

{spitch-1.35.0 → spitch-1.37.0}/api.md

@@ -3,40 +3,40 @@
 Types:
 
 ```python
-from spitch.types import SpeechTranscribeResponse
+from spitch.types import Transcription
 ```
 
 Methods:
 
 - <code title="post /v1/speech">client.speech.<a href="./src/spitch/resources/speech.py">generate</a>(\*\*<a href="src/spitch/types/speech_generate_params.py">params</a>) -> BinaryAPIResponse</code>
-- <code title="post /v1/transcriptions">client.speech.<a href="./src/spitch/resources/speech.py">transcribe</a>(\*\*<a href="src/spitch/types/speech_transcribe_params.py">params</a>) -> <a href="./src/spitch/types/speech_transcribe_response.py">SpeechTranscribeResponse</a></code>
+- <code title="post /v1/transcriptions">client.speech.<a href="./src/spitch/resources/speech.py">transcribe</a>(\*\*<a href="src/spitch/types/speech_transcribe_params.py">params</a>) -> <a href="./src/spitch/types/transcription.py">Transcription</a></code>
 
 # Text
 
 Types:
 
 ```python
-from spitch.types import TextToneMarkResponse, TextTranslateResponse
+from spitch.types import Diacritics, Translation
 ```
 
 Methods:
 
-- <code title="post /v1/diacritics">client.text.<a href="./src/spitch/resources/text.py">tone_mark</a>(\*\*<a href="src/spitch/types/text_tone_mark_params.py">params</a>) -> <a href="./src/spitch/types/text_tone_mark_response.py">TextToneMarkResponse</a></code>
-- <code title="post /v1/translate">client.text.<a href="./src/spitch/resources/text.py">translate</a>(\*\*<a href="src/spitch/types/text_translate_params.py">params</a>) -> <a href="./src/spitch/types/text_translate_response.py">TextTranslateResponse</a></code>
+- <code title="post /v1/diacritics">client.text.<a href="./src/spitch/resources/text.py">tone_mark</a>(\*\*<a href="src/spitch/types/text_tone_mark_params.py">params</a>) -> <a href="./src/spitch/types/diacritics.py">Diacritics</a></code>
+- <code title="post /v1/translate">client.text.<a href="./src/spitch/resources/text.py">translate</a>(\*\*<a href="src/spitch/types/text_translate_params.py">params</a>) -> <a href="./src/spitch/types/translation.py">Translation</a></code>
 
 # Files
 
 Types:
 
 ```python
-from spitch.types import FileListResponse, FileDeleteResponse, FileGetResponse, FileUploadResponse
+from spitch.types import File, FileUsage, Files, FileDeleteResponse, FileDownloadResponse
 ```
 
 Methods:
 
-- <code title="get /v1/files">client.files.<a href="./src/spitch/resources/files.py">list</a>(\*\*<a href="src/spitch/types/file_list_params.py">params</a>) -> <a href="./src/spitch/types/file_list_response.py">SyncFilesCursor[FileListResponse]</a></code>
+- <code title="get /v1/files">client.files.<a href="./src/spitch/resources/files.py">list</a>(\*\*<a href="src/spitch/types/file_list_params.py">params</a>) -> <a href="./src/spitch/types/file.py">SyncFilesCursor[File]</a></code>
 - <code title="delete /v1/files/{file_id}">client.files.<a href="./src/spitch/resources/files.py">delete</a>(file_id) -> <a href="./src/spitch/types/file_delete_response.py">FileDeleteResponse</a></code>
-- <code title="get /v1/files/{file_id}/url">client.files.<a href="./src/spitch/resources/files.py">download</a>(file_id, \*\*<a href="src/spitch/types/file_download_params.py">params</a>) -> object</code>
-- <code title="get /v1/files/{file_id}">client.files.<a href="./src/spitch/resources/files.py">get</a>(file_id) -> <a href="./src/spitch/types/file_get_response.py">FileGetResponse</a></code>
-- <code title="post /v1/files">client.files.<a href="./src/spitch/resources/files.py">upload</a>(\*\*<a href="src/spitch/types/file_upload_params.py">params</a>) -> <a href="./src/spitch/types/file_upload_response.py">FileUploadResponse</a></code>
-- <code title="get /v1/files:usage">client.files.<a href="./src/spitch/resources/files.py">usage</a>() -> object</code>
+- <code title="get /v1/files/{file_id}/url">client.files.<a href="./src/spitch/resources/files.py">download</a>(file_id, \*\*<a href="src/spitch/types/file_download_params.py">params</a>) -> <a href="./src/spitch/types/file_download_response.py">FileDownloadResponse</a></code>
+- <code title="get /v1/files/{file_id}">client.files.<a href="./src/spitch/resources/files.py">get</a>(file_id) -> <a href="./src/spitch/types/file.py">File</a></code>
+- <code title="post /v1/files">client.files.<a href="./src/spitch/resources/files.py">upload</a>(\*\*<a href="src/spitch/types/file_upload_params.py">params</a>) -> <a href="./src/spitch/types/file.py">File</a></code>
+- <code title="get /v1/files:usage">client.files.<a href="./src/spitch/resources/files.py">usage</a>() -> <a href="./src/spitch/types/file_usage.py">FileUsage</a></code>

{spitch-1.35.0 → spitch-1.37.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "spitch"
-version = "1.35.0"
+version = "1.37.0"
 description = "The official Python library for the spitch API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{spitch-1.35.0 → spitch-1.37.0}/src/spitch/_version.py

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

{spitch-1.35.0 → spitch-1.37.0}/src/spitch/resources/files.py

@@ -19,11 +19,11 @@ from .._response import (
     async_to_streamed_response_wrapper,
 )
 from ..pagination import SyncFilesCursor, AsyncFilesCursor
+from ..types.file import File
 from .._base_client import AsyncPaginator, make_request_options
-from ..types.file_get_response import FileGetResponse
-from ..types.file_list_response import FileListResponse
+from ..types.file_usage import FileUsage
 from ..types.file_delete_response import FileDeleteResponse
-from ..types.file_upload_response import FileUploadResponse
+from ..types.file_download_response import FileDownloadResponse
 
 __all__ = ["FilesResource", "AsyncFilesResource"]
 
@@ -60,7 +60,7 @@ class FilesResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SyncFilesCursor[FileListResponse]:
+    ) -> SyncFilesCursor[File]:
         """
         Get Files
 
@@ -75,7 +75,7 @@ class FilesResource(SyncAPIResource):
         """
         return self._get_api_list(
             "/v1/files",
-            page=SyncFilesCursor[FileListResponse],
+            page=SyncFilesCursor[File],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -90,7 +90,7 @@ class FilesResource(SyncAPIResource):
                     file_list_params.FileListParams,
                 ),
             ),
-            model=FileListResponse,
+            model=File,
         )
 
     def delete(
@@ -137,7 +137,7 @@ class FilesResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> FileDownloadResponse:
         """
         Download File
 
@@ -161,7 +161,7 @@ class FilesResource(SyncAPIResource):
                 timeout=timeout,
                 query=maybe_transform({"ttl": ttl}, file_download_params.FileDownloadParams),
             ),
-            cast_to=object,
+            cast_to=FileDownloadResponse,
         )
 
     def get(
@@ -174,7 +174,7 @@ class FilesResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> FileGetResponse:
+    ) -> File:
         """
         Get File
 
@@ -194,7 +194,7 @@ class FilesResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=FileGetResponse,
+            cast_to=File,
         )
 
     def upload(
@@ -207,7 +207,7 @@ class FilesResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> FileUploadResponse:
+    ) -> File:
         """
         Upload File
 
@@ -233,7 +233,7 @@ class FilesResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=FileUploadResponse,
+            cast_to=File,
         )
 
     def usage(
@@ -245,14 +245,14 @@ class FilesResource(SyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> FileUsage:
         """Get Usage"""
         return self._get(
             "/v1/files:usage",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=object,
+            cast_to=FileUsage,
         )
 
 
@@ -288,7 +288,7 @@ class AsyncFilesResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> AsyncPaginator[FileListResponse, AsyncFilesCursor[FileListResponse]]:
+    ) -> AsyncPaginator[File, AsyncFilesCursor[File]]:
         """
         Get Files
 
@@ -303,7 +303,7 @@ class AsyncFilesResource(AsyncAPIResource):
         """
         return self._get_api_list(
             "/v1/files",
-            page=AsyncFilesCursor[FileListResponse],
+            page=AsyncFilesCursor[File],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -318,7 +318,7 @@ class AsyncFilesResource(AsyncAPIResource):
                     file_list_params.FileListParams,
                 ),
             ),
-            model=FileListResponse,
+            model=File,
         )
 
     async def delete(
@@ -365,7 +365,7 @@ class AsyncFilesResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> FileDownloadResponse:
         """
         Download File
 
@@ -389,7 +389,7 @@ class AsyncFilesResource(AsyncAPIResource):
                 timeout=timeout,
                 query=await async_maybe_transform({"ttl": ttl}, file_download_params.FileDownloadParams),
             ),
-            cast_to=object,
+            cast_to=FileDownloadResponse,
         )
 
     async def get(
@@ -402,7 +402,7 @@ class AsyncFilesResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> FileGetResponse:
+    ) -> File:
         """
         Get File
 
@@ -422,7 +422,7 @@ class AsyncFilesResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=FileGetResponse,
+            cast_to=File,
         )
 
     async def upload(
@@ -435,7 +435,7 @@ class AsyncFilesResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> FileUploadResponse:
+    ) -> File:
         """
         Upload File
 
@@ -461,7 +461,7 @@ class AsyncFilesResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=FileUploadResponse,
+            cast_to=File,
         )
 
     async def usage(
@@ -473,14 +473,14 @@ class AsyncFilesResource(AsyncAPIResource):
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> object:
+    ) -> FileUsage:
         """Get Usage"""
         return await self._get(
             "/v1/files:usage",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=object,
+            cast_to=FileUsage,
         )