ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.209.2

This commit is contained in:
speakeasybot
2024-03-15 00:30:19 +00:00
parent 6748e94a9a
commit 4ecc50f7a7
351 changed files with 3969 additions and 2525 deletions

View File

@@ -0,0 +1,17 @@
import GetTransientToken from "./get_transient_token/get_transient_token.mdx";
import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx";
## Authentication
API Calls regarding authentication for Plex Media Server
### Available Operations
* [Get Transient Token](/python/authentication/get_transient_token) - Get a Transient Token.
* [Get Source Connection Information](/python/authentication/get_source_connection_information) - Get Source Connection Information
---
<GetTransientToken />
---
<GetSourceConnectionInformation />

View File

@@ -0,0 +1,4 @@
## Get Source Connection Information
If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token.
Note: requires Plex Media Server >= 1.15.4.

View File

@@ -0,0 +1,6 @@
{/* Autogenerated DO NOT EDIT */}
##### `source` *{`str`}*
The source identifier with an included prefix.
<br/>
**Example:** `server://client-identifier`

View File

@@ -0,0 +1,13 @@
{/* Autogenerated DO NOT EDIT */}
import GetSourceConnectionInformationResponse from "/content/types/models/operations/get_source_connection_information_response/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`operations.GetSourceConnectionInformationResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetSourceConnectionInformationResponse />
</Collapsible>

View File

@@ -0,0 +1,32 @@
<CH.Code>
```python GetSourceConnectionInformation.py
import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.authentication.get_source_connection_information(source='server://client-identifier')
if res is not None:
# handle response
pass
```
---
```json Example Response
{
"errors": [
{
"code": 1001,
"message": "User could not be authenticated",
"status": 401
}
],
"HttpMeta": {}
}
```
</CH.Code>

View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Authentication*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

View File

@@ -0,0 +1,3 @@
## Get Transient Token
This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.

View File

@@ -0,0 +1,21 @@
{/* Autogenerated DO NOT EDIT */}
import GetTransientTokenQueryParamType from "/content/types/models/operations/get_transient_token_query_param_type/python.mdx"
import Scope from "/content/types/models/operations/scope/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### `type` *{`operations.GetTransientTokenQueryParamType`}*
`delegation` \- This is the only supported `type` parameter.
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetTransientTokenQueryParamType />
</Collapsible>
---
##### `scope` *{`operations.Scope`}*
`all` \- This is the only supported `scope` parameter.
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<Scope />
</Collapsible>

View File

@@ -0,0 +1,13 @@
{/* Autogenerated DO NOT EDIT */}
import GetTransientTokenResponse from "/content/types/models/operations/get_transient_token_response/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`operations.GetTransientTokenResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<GetTransientTokenResponse />
</Collapsible>

View File

@@ -0,0 +1,33 @@
<CH.Code>
```python GetTransientToken.py
import plex_api
from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.authentication.get_transient_token(type=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL)
if res is not None:
# handle response
pass
```
---
```json Example Response
{
"errors": [
{
"code": 1001,
"message": "User could not be authenticated",
"status": 401
}
],
"HttpMeta": {}
}
```
</CH.Code>

View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Authentication*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}