Merge pull request #18 from livepeer/speakeasy-sdk-regen-1724890566

chore: 🐝 Update SDK - Generate 0.1.3
livepeer · Sep 13, 2024 · 0cff7f5 · 0cff7f5
2 parents ceb4163 + 318b596
commit 0cff7f5
Show file tree

Hide file tree

Showing 17 changed files with 1,069 additions and 508 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -12,7 +12,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: true
 python:
-  version: 0.1.2
+  version: 0.1.3
   additionalDependencies:
     dependencies: {}
     extraDependencies:

diff --git a/README.md b/README.md
@@ -151,7 +151,7 @@ s = livepeer.Livepeer(
 
 res = None
 try:
-    res = s.playback.get(id='<value>')
+    res = s.playback.get(id='<id>')
 
 except errors.Error as e:
     # handle exception
@@ -456,9 +456,31 @@ if res.stream is not None:
 ```
 <!-- End Authentication [security] -->
 
+<!-- Start Summary [summary] -->
+## Summary
+
+Livepeer API Reference: Welcome to the Livepeer API reference docs. Here you will find all the
+endpoints exposed on the standard Livepeer API, learn how to use them and
+what they return.
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+
+* [SDK Installation](#sdk-installation)
+* [SDK Example Usage](#sdk-example-usage)
+* [Available Resources and Operations](#available-resources-and-operations)
+* [Error Handling](#error-handling)
+* [Server Selection](#server-selection)
+* [Custom HTTP Client](#custom-http-client)
+* [Authentication](#authentication)
+<!-- End Table of Contents [toc] -->
+
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
+The SDK can be installed using the *pip* package manager, with dependencies and metadata stored in the `setup.py` file.
+
 ```bash
 pip install git+https://github.com/livepeer/livepeer-python.git
 ```
@@ -553,38 +575,16 @@ if res.stream is not None:
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
-### [stream](docs/sdks/stream/README.md)
+<details open>
+<summary>Available methods</summary>
 
-* [create](docs/sdks/stream/README.md#create) - Create a stream
-* [get_all](docs/sdks/stream/README.md#get_all) - Retrieve streams
-* [get](docs/sdks/stream/README.md#get) - Retrieve a stream
-* [update](docs/sdks/stream/README.md#update) - Update a stream
-* [delete](docs/sdks/stream/README.md#delete) - Delete a stream
-* [terminate](docs/sdks/stream/README.md#terminate) - Terminates a live stream
-* [start_pull](docs/sdks/stream/README.md#start_pull) - Start ingest for a pull stream
-* [create_clip](docs/sdks/stream/README.md#create_clip) - Create a clip
-* [get_clips](docs/sdks/stream/README.md#get_clips) - Retrieve clips of a livestream
-* [add_multistream_target](docs/sdks/stream/README.md#add_multistream_target) - Add a multistream target
-* [remove_multistream_target](docs/sdks/stream/README.md#remove_multistream_target) - Remove a multistream target
-
-### [multistream](docs/sdks/multistream/README.md)
-
-* [get_all](docs/sdks/multistream/README.md#get_all) - Retrieve Multistream Targets
-* [create](docs/sdks/multistream/README.md#create) - Create a multistream target
-* [get](docs/sdks/multistream/README.md#get) - Retrieve a multistream target
-* [update](docs/sdks/multistream/README.md#update) - Update Multistream Target
-* [delete](docs/sdks/multistream/README.md#delete) - Delete a multistream target
-
-### [webhook](docs/sdks/webhook/README.md)
+### [access_control](docs/sdks/accesscontrol/README.md)
 
-* [get_all](docs/sdks/webhook/README.md#get_all) - Retrieve a Webhook
-* [create](docs/sdks/webhook/README.md#create) - Create a webhook
-* [get](docs/sdks/webhook/README.md#get) - Retrieve a webhook
-* [update](docs/sdks/webhook/README.md#update) - Update a webhook
-* [delete](docs/sdks/webhook/README.md#delete) - Delete a webhook
-* [get_logs](docs/sdks/webhook/README.md#get_logs) - Retrieve webhook logs
-* [get_log](docs/sdks/webhook/README.md#get_log) - Retrieve a webhook log
-* [resend_log](docs/sdks/webhook/README.md#resend_log) - Resend a webhook
+* [create](docs/sdks/accesscontrol/README.md#create) - Create a signing key
+* [get_all](docs/sdks/accesscontrol/README.md#get_all) - Retrieves signing keys
+* [delete](docs/sdks/accesscontrol/README.md#delete) - Delete Signing Key
+* [get](docs/sdks/accesscontrol/README.md#get) - Retrieves a signing key
+* [update](docs/sdks/accesscontrol/README.md#update) - Update a signing key
 
 ### [asset](docs/sdks/asset/README.md)
 
@@ -595,14 +595,28 @@ if res.stream is not None:
 * [update](docs/sdks/asset/README.md#update) - Patch an asset
 * [delete](docs/sdks/asset/README.md#delete) - Delete an asset
 
-### [session](docs/sdks/session/README.md)
 
-* [get_clips](docs/sdks/session/README.md#get_clips) - Retrieve clips of a session
-* [get_all](docs/sdks/session/README.md#get_all) - Retrieve sessions
-* [get](docs/sdks/session/README.md#get) - Retrieve a session
-* [get_recorded](docs/sdks/session/README.md#get_recorded) - Retrieve Recorded Sessions
+### [metrics](docs/sdks/metrics/README.md)
 
-### [room](docs/sdks/room/README.md)
+* [get_realtime_viewership](docs/sdks/metrics/README.md#get_realtime_viewership) - Query realtime viewership
+* [get_viewership](docs/sdks/metrics/README.md#get_viewership) - Query viewership metrics
+* [get_creator_viewership](docs/sdks/metrics/README.md#get_creator_viewership) - Query creator viewership metrics
+* [get_public_viewership](docs/sdks/metrics/README.md#get_public_viewership) - Query public total views metrics
+* [get_usage](docs/sdks/metrics/README.md#get_usage) - Query usage metrics
+
+### [multistream](docs/sdks/multistream/README.md)
+
+* [get_all](docs/sdks/multistream/README.md#get_all) - Retrieve Multistream Targets
+* [create](docs/sdks/multistream/README.md#create) - Create a multistream target
+* [get](docs/sdks/multistream/README.md#get) - Retrieve a multistream target
+* [update](docs/sdks/multistream/README.md#update) - Update Multistream Target
+* [delete](docs/sdks/multistream/README.md#delete) - Delete a multistream target
+
+### [playback](docs/sdks/playback/README.md)
+
+* [get](docs/sdks/playback/README.md#get) - Retrieve Playback Info
+
+### [~~room~~](docs/sdks/room/README.md)
 
 * [~~create~~](docs/sdks/room/README.md#create) - Create a room :warning: **Deprecated**
 * [~~get~~](docs/sdks/room/README.md#get) - Retrieve a room :warning: **Deprecated**
@@ -614,21 +628,26 @@ if res.stream is not None:
 * [~~update_user~~](docs/sdks/room/README.md#update_user) - Update a room user :warning: **Deprecated**
 * [~~delete_user~~](docs/sdks/room/README.md#delete_user) - Remove a user from the room :warning: **Deprecated**
 
-### [metrics](docs/sdks/metrics/README.md)
+### [session](docs/sdks/session/README.md)
 
-* [get_realtime_viewership](docs/sdks/metrics/README.md#get_realtime_viewership) - Query realtime viewership
-* [get_viewership](docs/sdks/metrics/README.md#get_viewership) - Query viewership metrics
-* [get_creator_viewership](docs/sdks/metrics/README.md#get_creator_viewership) - Query creator viewership metrics
-* [get_public_viewership](docs/sdks/metrics/README.md#get_public_viewership) - Query public total views metrics
-* [get_usage](docs/sdks/metrics/README.md#get_usage) - Query usage metrics
+* [get_clips](docs/sdks/session/README.md#get_clips) - Retrieve clips of a session
+* [get_all](docs/sdks/session/README.md#get_all) - Retrieve sessions
+* [get](docs/sdks/session/README.md#get) - Retrieve a session
+* [get_recorded](docs/sdks/session/README.md#get_recorded) - Retrieve Recorded Sessions
 
-### [access_control](docs/sdks/accesscontrol/README.md)
+### [stream](docs/sdks/stream/README.md)
 
-* [create](docs/sdks/accesscontrol/README.md#create) - Create a signing key
-* [get_all](docs/sdks/accesscontrol/README.md#get_all) - Retrieves signing keys
-* [delete](docs/sdks/accesscontrol/README.md#delete) - Delete Signing Key
-* [get](docs/sdks/accesscontrol/README.md#get) - Retrieves a signing key
-* [update](docs/sdks/accesscontrol/README.md#update) - Update a signing key
+* [create](docs/sdks/stream/README.md#create) - Create a stream
+* [get_all](docs/sdks/stream/README.md#get_all) - Retrieve streams
+* [get](docs/sdks/stream/README.md#get) - Retrieve a stream
+* [update](docs/sdks/stream/README.md#update) - Update a stream
+* [delete](docs/sdks/stream/README.md#delete) - Delete a stream
+* [terminate](docs/sdks/stream/README.md#terminate) - Terminates a live stream
+* [start_pull](docs/sdks/stream/README.md#start_pull) - Start ingest for a pull stream
+* [create_clip](docs/sdks/stream/README.md#create_clip) - Create a clip
+* [get_clips](docs/sdks/stream/README.md#get_clips) - Retrieve clips of a livestream
+* [add_multistream_target](docs/sdks/stream/README.md#add_multistream_target) - Add a multistream target
+* [remove_multistream_target](docs/sdks/stream/README.md#remove_multistream_target) - Remove a multistream target
 
 ### [task](docs/sdks/task/README.md)
 
@@ -639,9 +658,18 @@ if res.stream is not None:
 
 * [create](docs/sdks/transcode/README.md#create) - Transcode a video
 
-### [playback](docs/sdks/playback/README.md)
+### [webhook](docs/sdks/webhook/README.md)
 
-* [get](docs/sdks/playback/README.md#get) - Retrieve Playback Info
+* [get_all](docs/sdks/webhook/README.md#get_all) - Retrieve a Webhook
+* [create](docs/sdks/webhook/README.md#create) - Create a webhook
+* [get](docs/sdks/webhook/README.md#get) - Retrieve a webhook
+* [update](docs/sdks/webhook/README.md#update) - Update a webhook
+* [delete](docs/sdks/webhook/README.md#delete) - Delete a webhook
+* [get_logs](docs/sdks/webhook/README.md#get_logs) - Retrieve webhook logs
+* [get_log](docs/sdks/webhook/README.md#get_log) - Retrieve a webhook log
+* [resend_log](docs/sdks/webhook/README.md#resend_log) - Resend a webhook
+
+</details>
 <!-- End Available Resources and Operations [operations] -->
 
 <!-- Placeholder for Future Speakeasy SDK Sections -->

diff --git a/RELEASES.md b/RELEASES.md
@@ -78,4 +78,12 @@ Based on:
 - OpenAPI Doc  
 - Speakeasy CLI 1.377.1 (2.404.1) https://github.com/speakeasy-api/speakeasy
 ### Generated
-- [python v0.1.2] .
+- [python v0.1.2] .
+
+## 2024-09-13 00:16:30
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.396.6 (2.415.6) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v0.1.3] .
diff --git a/docs/models/components/recordingstatus.md b/docs/models/components/recordingstatus.md
@@ -10,4 +10,5 @@ The status of the recording process of this stream session.
 | `WAITING` | waiting   |
 | `READY`   | ready     |
 | `FAILED`  | failed    |
+| `DELETED` | deleted   |
 | `NONE`    | none      |
diff --git a/docs/models/components/task.md b/docs/models/components/task.md
@@ -11,6 +11,7 @@
 | `scheduled_at`                                                                                                | *Optional[float]*                                                                                             | :heavy_minus_sign:                                                                                            | Timestamp (in milliseconds) at which the task was scheduled for<br/>execution (e.g. after file upload finished).<br/> | 1587667174725                                                                                                 |
 | `input_asset_id`                                                                                              | *Optional[str]*                                                                                               | :heavy_minus_sign:                                                                                            | ID of the input asset                                                                                         | 09F8B46C-61A0-4254-9875-F71F4C605BC7                                                                          |
 | `output_asset_id`                                                                                             | *Optional[str]*                                                                                               | :heavy_minus_sign:                                                                                            | ID of the output asset                                                                                        | 09F8B46C-61A0-4254-9875-F71F4C605BC7                                                                          |
+| `project_id`                                                                                                  | *Optional[str]*                                                                                               | :heavy_minus_sign:                                                                                            | ID of the project                                                                                             | 09F8B46C-61A0-4254-9875-F71F4C605BC7                                                                          |
 | `requester_id`                                                                                                | *Optional[str]*                                                                                               | :heavy_minus_sign:                                                                                            | ID of the requester hash(IP + SALT + PlaybackId)                                                              | 09F8B46C-61A0-4254-9875-F71F4C605BC7                                                                          |
 | `params`                                                                                                      | [Optional[components.Params]](../../models/components/params.md)                                              | :heavy_minus_sign:                                                                                            | Parameters of the task                                                                                        |                                                                                                               |
 | `status`                                                                                                      | [Optional[components.TaskStatus]](../../models/components/taskstatus.md)                                      | :heavy_minus_sign:                                                                                            | Status of the task                                                                                            |                                                                                                               |

diff --git a/docs/sdks/metrics/README.md b/docs/sdks/metrics/README.md
@@ -64,13 +64,14 @@ Requires a private (non-CORS) API key to be used.
 
 ```python
 import livepeer
+from livepeer.models import operations
 
 s = livepeer.Livepeer(
     api_key="<YOUR_BEARER_TOKEN_HERE>",
 )
 
 
-res = s.metrics.get_viewership()
+res = s.metrics.get_viewership(request=operations.GetViewershipMetricsRequest())
 
 if res.data is not None:
     # handle response
@@ -104,13 +105,14 @@ Requires a proof of ownership to be sent in the request, which for now is just t
 
 ```python
 import livepeer
+from livepeer.models import operations
 
 s = livepeer.Livepeer(
     api_key="<YOUR_BEARER_TOKEN_HERE>",
 )
 
 
-res = s.metrics.get_creator_viewership()
+res = s.metrics.get_creator_viewership(request=operations.GetCreatorViewershipMetricsRequest())
 
 if res.data is not None:
     # handle response
@@ -185,13 +187,14 @@ Query usage metrics
 
 ```python
 import livepeer
+from livepeer.models import operations
 
 s = livepeer.Livepeer(
     api_key="<YOUR_BEARER_TOKEN_HERE>",
 )
 
 
-res = s.metrics.get_usage()
+res = s.metrics.get_usage(request=operations.GetUsageMetricsRequest())
 
 if res.usage_metric is not None:
     # handle response

diff --git a/docs/sdks/multistream/README.md b/docs/sdks/multistream/README.md
@@ -102,7 +102,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.multistream.get(id='<value>')
+res = s.multistream.get(id='<id>')
 
 if res.multistream_target is not None:
     # handle response
@@ -142,7 +142,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.multistream.update(id='<value>', multistream_target_patch_payload=components.MultistreamTargetPatchPayload(
+res = s.multistream.update(id='<id>', multistream_target_patch_payload=components.MultistreamTargetPatchPayload(
     url='rtmps://live.my-service.tv/channel/secretKey',
 ))
 
@@ -186,7 +186,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.multistream.delete(id='<value>')
+res = s.multistream.delete(id='<id>')
 
 if res is not None:
     # handle response

diff --git a/docs/sdks/playback/README.md b/docs/sdks/playback/README.md
@@ -23,7 +23,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.playback.get(id='<value>')
+res = s.playback.get(id='<id>')
 
 if res.playback_info is not None:
     # handle response

diff --git a/docs/sdks/room/README.md b/docs/sdks/room/README.md
@@ -69,7 +69,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.room.get(id='<value>')
+res = s.room.get(id='<id>')
 
 if res.room is not None:
     # handle response
@@ -110,7 +110,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.room.delete(id='<value>')
+res = s.room.delete(id='<id>')
 
 if res is not None:
     # handle response
@@ -154,7 +154,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.room.start_egress(id='<value>', room_egress_payload=components.RoomEgressPayload(
+res = s.room.start_egress(id='<id>', room_egress_payload=components.RoomEgressPayload(
     stream_id='aac12556-4d65-4d34-9fb6-d1f0985eb0a9',
 ))
 
@@ -198,7 +198,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.room.stop_egress(id='<value>')
+res = s.room.stop_egress(id='<id>')
 
 if res is not None:
     # handle response
@@ -243,7 +243,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.room.create_user(id='<value>', room_user_payload=components.RoomUserPayload(
+res = s.room.create_user(id='<id>', room_user_payload=components.RoomUserPayload(
     name='name',
     can_publish=True,
     can_publish_data=True,
@@ -289,7 +289,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.room.get_user(id='<value>', user_id='<value>')
+res = s.room.get_user(id='<id>', user_id='<value>')
 
 if res.get_room_user_response is not None:
     # handle response
@@ -332,7 +332,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.room.update_user(id='<value>', user_id='<value>', room_user_update_payload=components.RoomUserUpdatePayload(
+res = s.room.update_user(id='<id>', user_id='<value>', room_user_update_payload=components.RoomUserUpdatePayload(
     can_publish=True,
     can_publish_data=True,
 ))
@@ -378,7 +378,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.room.delete_user(id='<value>', user_id='<value>')
+res = s.room.delete_user(id='<id>', user_id='<value>')
 
 if res is not None:
     # handle response

diff --git a/docs/sdks/session/README.md b/docs/sdks/session/README.md
@@ -26,7 +26,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.session.get_clips(id='<value>')
+res = s.session.get_clips(id='<id>')
 
 if res.data is not None:
     # handle response
@@ -98,7 +98,7 @@ s = livepeer.Livepeer(
 )
 
 
-res = s.session.get(id='<value>')
+res = s.session.get(id='<id>')
 
 if res.session is not None:
     # handle response