feat(api): add avatar, voice, document, and realtime session endpoints

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 14
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runwayml%2Frunwayml-b3276a8508268090b14e297f5cb18448da7a763653c6d38c23f0eea0984d8008.yml
-openapi_spec_hash: 95ae975f17217c8d144c4ba80846beca
-config_hash: 803d5c0aa94eea0a7981b91728218d3f
+configured_endpoints: 31
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runwayml%2Frunwayml-4ddc8e3d83c8601fc378c702bbcb5af2976b481db513bd389a5f57645a20cd04.yml
+openapi_spec_hash: 5795c6af9e9404765bda670e781fe500
+config_hash: 3c88fcd4dd6f3a7d7f6e94b57b430243

README.md

@@ -121,6 +121,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 RunwayML 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 runwayml import RunwayML
+
+client = RunwayML()
+
+all_avatars = []
+# Automatically fetches more pages as needed.
+for avatar in client.avatars.list(
+    limit=1,
+):
+    # Do something with avatar here
+    all_avatars.append(avatar)
+print(all_avatars)
+```
+
+Or, asynchronously:
+
+```python
+import asyncio
+from runwayml import AsyncRunwayML
+
+client = AsyncRunwayML()
+
+
+async def main() -> None:
+    all_avatars = []
+    # Iterate through items across all pages, issuing requests as needed.
+    async for avatar in client.avatars.list(
+        limit=1,
+    ):
+        all_avatars.append(avatar)
+    print(all_avatars)
+
+
+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.avatars.list(
+    limit=1,
+)
+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.data)}")
+
+# Remove `await` for non-async usage.
+```
+
+Or just work directly with the returned data:
+
+```python
+first_page = await client.avatars.list(
+    limit=1,
+)
+
+print(f"next page cursor: {first_page.next_cursor}")  # => "next page cursor: ..."
+for avatar in first_page.data:
+    print(avatar)
+
+# Remove `await` for non-async usage.
+```
+
 ## Nested params
 
 Nested parameters are dictionaries, typed using `TypedDict`, for example:

api.md

@@ -143,3 +143,74 @@ Methods:
 
 - <code title="get /v1/organization">client.organization.<a href="./src/runwayml/resources/organization.py">retrieve</a>() -> <a href="./src/runwayml/types/organization_retrieve_response.py">OrganizationRetrieveResponse</a></code>
 - <code title="post /v1/organization/usage">client.organization.<a href="./src/runwayml/resources/organization.py">retrieve_usage</a>(\*\*<a href="src/runwayml/types/organization_retrieve_usage_params.py">params</a>) -> <a href="./src/runwayml/types/organization_retrieve_usage_response.py">OrganizationRetrieveUsageResponse</a></code>
+
+# Avatars
+
+Types:
+
+```python
+from runwayml.types import (
+    AvatarCreateResponse,
+    AvatarRetrieveResponse,
+    AvatarUpdateResponse,
+    AvatarListResponse,
+)
+```
+
+Methods:
+
+- <code title="post /v1/avatars">client.avatars.<a href="./src/runwayml/resources/avatars.py">create</a>(\*\*<a href="src/runwayml/types/avatar_create_params.py">params</a>) -> <a href="./src/runwayml/types/avatar_create_response.py">AvatarCreateResponse</a></code>
+- <code title="get /v1/avatars/{id}">client.avatars.<a href="./src/runwayml/resources/avatars.py">retrieve</a>(id) -> <a href="./src/runwayml/types/avatar_retrieve_response.py">AvatarRetrieveResponse</a></code>
+- <code title="patch /v1/avatars/{id}">client.avatars.<a href="./src/runwayml/resources/avatars.py">update</a>(id, \*\*<a href="src/runwayml/types/avatar_update_params.py">params</a>) -> <a href="./src/runwayml/types/avatar_update_response.py">AvatarUpdateResponse</a></code>
+- <code title="get /v1/avatars">client.avatars.<a href="./src/runwayml/resources/avatars.py">list</a>(\*\*<a href="src/runwayml/types/avatar_list_params.py">params</a>) -> <a href="./src/runwayml/types/avatar_list_response.py">SyncCursorPage[AvatarListResponse]</a></code>
+- <code title="delete /v1/avatars/{id}">client.avatars.<a href="./src/runwayml/resources/avatars.py">delete</a>(id) -> None</code>
+
+# Documents
+
+Types:
+
+```python
+from runwayml.types import DocumentCreateResponse, DocumentRetrieveResponse, DocumentListResponse
+```
+
+Methods:
+
+- <code title="post /v1/documents">client.documents.<a href="./src/runwayml/resources/documents.py">create</a>(\*\*<a href="src/runwayml/types/document_create_params.py">params</a>) -> <a href="./src/runwayml/types/document_create_response.py">DocumentCreateResponse</a></code>
+- <code title="get /v1/documents/{id}">client.documents.<a href="./src/runwayml/resources/documents.py">retrieve</a>(id) -> <a href="./src/runwayml/types/document_retrieve_response.py">DocumentRetrieveResponse</a></code>
+- <code title="get /v1/documents">client.documents.<a href="./src/runwayml/resources/documents.py">list</a>(\*\*<a href="src/runwayml/types/document_list_params.py">params</a>) -> <a href="./src/runwayml/types/document_list_response.py">SyncCursorPage[DocumentListResponse]</a></code>
+- <code title="delete /v1/documents/{id}">client.documents.<a href="./src/runwayml/resources/documents.py">delete</a>(id) -> None</code>
+
+# RealtimeSessions
+
+Types:
+
+```python
+from runwayml.types import RealtimeSessionCreateResponse, RealtimeSessionRetrieveResponse
+```
+
+Methods:
+
+- <code title="post /v1/realtime_sessions">client.realtime_sessions.<a href="./src/runwayml/resources/realtime_sessions.py">create</a>(\*\*<a href="src/runwayml/types/realtime_session_create_params.py">params</a>) -> <a href="./src/runwayml/types/realtime_session_create_response.py">RealtimeSessionCreateResponse</a></code>
+- <code title="get /v1/realtime_sessions/{id}">client.realtime_sessions.<a href="./src/runwayml/resources/realtime_sessions.py">retrieve</a>(id) -> <a href="./src/runwayml/types/realtime_session_retrieve_response.py">RealtimeSessionRetrieveResponse</a></code>
+- <code title="delete /v1/realtime_sessions/{id}">client.realtime_sessions.<a href="./src/runwayml/resources/realtime_sessions.py">delete</a>(id) -> None</code>
+
+# Voices
+
+Types:
+
+```python
+from runwayml.types import (
+    VoiceCreateResponse,
+    VoiceRetrieveResponse,
+    VoiceListResponse,
+    VoicePreviewResponse,
+)
+```
+
+Methods:
+
+- <code title="post /v1/voices">client.voices.<a href="./src/runwayml/resources/voices.py">create</a>(\*\*<a href="src/runwayml/types/voice_create_params.py">params</a>) -> <a href="./src/runwayml/types/voice_create_response.py">VoiceCreateResponse</a></code>
+- <code title="get /v1/voices/{id}">client.voices.<a href="./src/runwayml/resources/voices.py">retrieve</a>(id) -> <a href="./src/runwayml/types/voice_retrieve_response.py">VoiceRetrieveResponse</a></code>
+- <code title="get /v1/voices">client.voices.<a href="./src/runwayml/resources/voices.py">list</a>(\*\*<a href="src/runwayml/types/voice_list_params.py">params</a>) -> <a href="./src/runwayml/types/voice_list_response.py">SyncCursorPage[VoiceListResponse]</a></code>
+- <code title="delete /v1/voices/{id}">client.voices.<a href="./src/runwayml/resources/voices.py">delete</a>(id) -> None</code>
+- <code title="post /v1/voices/preview">client.voices.<a href="./src/runwayml/resources/voices.py">preview</a>(\*\*<a href="src/runwayml/types/voice_preview_params.py">params</a>) -> <a href="./src/runwayml/types/voice_preview_response.py">VoicePreviewResponse</a></code>

src/runwayml/_client.py

@@ -44,10 +44,11 @@
         video_to_video,
         voice_isolation,
         speech_to_speech,
+        realtime_sessions,
         character_performance,
     )
     from .resources.tasks import TasksResource, AsyncTasksResource
-    from .resources.uploads import UploadsResource, AsyncUploadsResource
+
     from .resources.organization import OrganizationResource, AsyncOrganizationResource
     from .resources.sound_effect import SoundEffectResource, AsyncSoundEffectResource
     from .resources.text_to_image import TextToImageResource, AsyncTextToImageResource
@@ -58,6 +59,7 @@
     from .resources.video_to_video import VideoToVideoResource, AsyncVideoToVideoResource
     from .resources.voice_isolation import VoiceIsolationResource, AsyncVoiceIsolationResource
     from .resources.speech_to_speech import SpeechToSpeechResource, AsyncSpeechToSpeechResource
+    from .resources.realtime_sessions import RealtimeSessionsResource, AsyncRealtimeSessionsResource
     from .resources.character_performance import CharacterPerformanceResource, AsyncCharacterPerformanceResource
 
 __all__ = [
@@ -222,6 +224,30 @@ def organization(self) -> OrganizationResource:
 
         return OrganizationResource(self)
 
+    @cached_property
+    def avatars(self) -> AvatarsResource:
+        from .resources.avatars import AvatarsResource
+
+        return AvatarsResource(self)
+
+    @cached_property
+    def documents(self) -> DocumentsResource:
+        from .resources.documents import DocumentsResource
+
+        return DocumentsResource(self)
+
+    @cached_property
+    def realtime_sessions(self) -> RealtimeSessionsResource:
+        from .resources.realtime_sessions import RealtimeSessionsResource
+
+        return RealtimeSessionsResource(self)
+
+    @cached_property
+    def voices(self) -> VoicesResource:
+        from .resources.voices import VoicesResource
+
+        return VoicesResource(self)
+
     @cached_property
     def with_raw_response(self) -> RunwayMLWithRawResponse:
         return RunwayMLWithRawResponse(self)
@@ -488,6 +514,30 @@ def organization(self) -> AsyncOrganizationResource:
 
         return AsyncOrganizationResource(self)
 
+    @cached_property
+    def avatars(self) -> AsyncAvatarsResource:
+        from .resources.avatars import AsyncAvatarsResource
+
+        return AsyncAvatarsResource(self)
+
+    @cached_property
+    def documents(self) -> AsyncDocumentsResource:
+        from .resources.documents import AsyncDocumentsResource
+
+        return AsyncDocumentsResource(self)
+
+    @cached_property
+    def realtime_sessions(self) -> AsyncRealtimeSessionsResource:
+        from .resources.realtime_sessions import AsyncRealtimeSessionsResource
+
+        return AsyncRealtimeSessionsResource(self)
+
+    @cached_property
+    def voices(self) -> AsyncVoicesResource:
+        from .resources.voices import AsyncVoicesResource
+
+        return AsyncVoicesResource(self)
+
     @cached_property
     def with_raw_response(self) -> AsyncRunwayMLWithRawResponse:
         return AsyncRunwayMLWithRawResponse(self)
@@ -699,6 +749,30 @@ def organization(self) -> organization.OrganizationResourceWithRawResponse:
 
         return OrganizationResourceWithRawResponse(self._client.organization)
 
+    @cached_property
+    def avatars(self) -> avatars.AvatarsResourceWithRawResponse:
+        from .resources.avatars import AvatarsResourceWithRawResponse
+
+        return AvatarsResourceWithRawResponse(self._client.avatars)
+
+    @cached_property
+    def documents(self) -> documents.DocumentsResourceWithRawResponse:
+        from .resources.documents import DocumentsResourceWithRawResponse
+
+        return DocumentsResourceWithRawResponse(self._client.documents)
+
+    @cached_property
+    def realtime_sessions(self) -> realtime_sessions.RealtimeSessionsResourceWithRawResponse:
+        from .resources.realtime_sessions import RealtimeSessionsResourceWithRawResponse
+
+        return RealtimeSessionsResourceWithRawResponse(self._client.realtime_sessions)
+
+    @cached_property
+    def voices(self) -> voices.VoicesResourceWithRawResponse:
+        from .resources.voices import VoicesResourceWithRawResponse
+
+        return VoicesResourceWithRawResponse(self._client.voices)
+
 
 class AsyncRunwayMLWithRawResponse:
     _client: AsyncRunwayML
@@ -795,6 +869,30 @@ def organization(self) -> organization.AsyncOrganizationResourceWithRawResponse:
 
         return AsyncOrganizationResourceWithRawResponse(self._client.organization)
 
+    @cached_property
+    def avatars(self) -> avatars.AsyncAvatarsResourceWithRawResponse:
+        from .resources.avatars import AsyncAvatarsResourceWithRawResponse
+
+        return AsyncAvatarsResourceWithRawResponse(self._client.avatars)
+
+    @cached_property
+    def documents(self) -> documents.AsyncDocumentsResourceWithRawResponse:
+        from .resources.documents import AsyncDocumentsResourceWithRawResponse
+
+        return AsyncDocumentsResourceWithRawResponse(self._client.documents)
+
+    @cached_property
+    def realtime_sessions(self) -> realtime_sessions.AsyncRealtimeSessionsResourceWithRawResponse:
+        from .resources.realtime_sessions import AsyncRealtimeSessionsResourceWithRawResponse
+
+        return AsyncRealtimeSessionsResourceWithRawResponse(self._client.realtime_sessions)
+
+    @cached_property
+    def voices(self) -> voices.AsyncVoicesResourceWithRawResponse:
+        from .resources.voices import AsyncVoicesResourceWithRawResponse
+
+        return AsyncVoicesResourceWithRawResponse(self._client.voices)
+
 
 class RunwayMLWithStreamedResponse:
     _client: RunwayML
@@ -891,6 +989,30 @@ def organization(self) -> organization.OrganizationResourceWithStreamingResponse
 
         return OrganizationResourceWithStreamingResponse(self._client.organization)
 
+    @cached_property
+    def avatars(self) -> avatars.AvatarsResourceWithStreamingResponse:
+        from .resources.avatars import AvatarsResourceWithStreamingResponse
+
+        return AvatarsResourceWithStreamingResponse(self._client.avatars)
+
+    @cached_property
+    def documents(self) -> documents.DocumentsResourceWithStreamingResponse:
+        from .resources.documents import DocumentsResourceWithStreamingResponse
+
+        return DocumentsResourceWithStreamingResponse(self._client.documents)
+
+    @cached_property
+    def realtime_sessions(self) -> realtime_sessions.RealtimeSessionsResourceWithStreamingResponse:
+        from .resources.realtime_sessions import RealtimeSessionsResourceWithStreamingResponse
+
+        return RealtimeSessionsResourceWithStreamingResponse(self._client.realtime_sessions)
+
+    @cached_property
+    def voices(self) -> voices.VoicesResourceWithStreamingResponse:
+        from .resources.voices import VoicesResourceWithStreamingResponse
+
+        return VoicesResourceWithStreamingResponse(self._client.voices)
+
 
 class AsyncRunwayMLWithStreamedResponse:
     _client: AsyncRunwayML
@@ -987,6 +1109,30 @@ def organization(self) -> organization.AsyncOrganizationResourceWithStreamingRes
 
         return AsyncOrganizationResourceWithStreamingResponse(self._client.organization)
 
+    @cached_property
+    def avatars(self) -> avatars.AsyncAvatarsResourceWithStreamingResponse:
+        from .resources.avatars import AsyncAvatarsResourceWithStreamingResponse
+
+        return AsyncAvatarsResourceWithStreamingResponse(self._client.avatars)
+
+    @cached_property
+    def documents(self) -> documents.AsyncDocumentsResourceWithStreamingResponse:
+        from .resources.documents import AsyncDocumentsResourceWithStreamingResponse
+
+        return AsyncDocumentsResourceWithStreamingResponse(self._client.documents)
+
+    @cached_property
+    def realtime_sessions(self) -> realtime_sessions.AsyncRealtimeSessionsResourceWithStreamingResponse:
+        from .resources.realtime_sessions import AsyncRealtimeSessionsResourceWithStreamingResponse
+
+        return AsyncRealtimeSessionsResourceWithStreamingResponse(self._client.realtime_sessions)
+
+    @cached_property
+    def voices(self) -> voices.AsyncVoicesResourceWithStreamingResponse:
+        from .resources.voices import AsyncVoicesResourceWithStreamingResponse
+
+        return AsyncVoicesResourceWithStreamingResponse(self._client.voices)
+
 
 Client = RunwayML