ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.228.1

This commit is contained in:
speakeasybot
2024-03-29 16:37:20 +00:00
parent 6ce3adfd94
commit 03e43e4b00
42 changed files with 216 additions and 79 deletions

View File

@@ -25,6 +25,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -164,6 +165,7 @@ from plex_api.models import errors
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -203,6 +205,7 @@ import plex_api
s = plex_api.PlexAPI(
server_idx=0,
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -230,6 +233,7 @@ import plex_api
s = plex_api.PlexAPI(
server_url="{protocol}://{ip}:{port}",
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -247,10 +251,12 @@ The server URL can also be overridden on a per-operation basis, provided a serve
```python
import plex_api
s = plex_api.PlexAPI()
s = plex_api.PlexAPI(
x_plex_client_identifier='<value>',
)
res = s.plex.get_pin(server_url="https://plex.tv/api/v2", x_plex_client_identifier='<value>', strong=False)
res = s.plex.get_pin(server_url="https://plex.tv/api/v2", strong=False, x_plex_client_identifier='<value>')
if res.object is not None:
# handle response
@@ -292,6 +298,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -304,6 +311,45 @@ if res.object is not None:
```
<!-- End Authentication [security] -->
<!-- Start Global Parameters [global-parameters] -->
## Global Parameters
A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set `X-Plex-Client-Identifier` to `'<value>'` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_pin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
### Available Globals
The following global parameter is available. The required parameter must be set when you initialize the SDK client.
| Name | Type | Required | Description |
| ---- | ---- |:--------:| ----------- |
| x_plex_client_identifier | str | ✔️ | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
|
### Example
```python
import plex_api
s = plex_api.PlexAPI(
x_plex_client_identifier='<value>',
)
res = s.plex.get_pin(strong=False, x_plex_client_identifier='<value>')
if res.object is not None:
# handle response
pass
```
<!-- End Global Parameters [global-parameters] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# Development