mirror of
https://github.com/LukeHagar/plexpy.git
synced 2025-12-06 04:20:52 +00:00
Regenerated with pythonv2 and newest spec
This commit is contained in:
Luke Hagar
23
.github/workflows/codesee-arch-diagram.yml
vendored
23
.github/workflows/codesee-arch-diagram.yml
vendored
@@ -1,23 +0,0 @@
|
||||
# This workflow was added by CodeSee. Learn more at https://codesee.io/
|
||||
# This is v2.0 of this workflow file
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request_target:
|
||||
types: [opened, synchronize, reopened]
|
||||
|
||||
name: CodeSee
|
||||
|
||||
permissions: read-all
|
||||
|
||||
jobs:
|
||||
codesee:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
name: Analyze the repo with CodeSee
|
||||
steps:
|
||||
- uses: Codesee-io/codesee-action@v2
|
||||
with:
|
||||
codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
|
||||
codesee-url: https://app.codesee.io
|
||||
30
.github/workflows/sdk_generation.yaml
vendored
Normal file
30
.github/workflows/sdk_generation.yaml
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
name: Generate
|
||||
permissions:
|
||||
checks: write
|
||||
contents: write
|
||||
pull-requests: write
|
||||
statuses: write
|
||||
"on":
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
force:
|
||||
description: Force generation of SDKs
|
||||
type: boolean
|
||||
default: false
|
||||
set_version:
|
||||
description: optionally set a specific SDK version
|
||||
type: string
|
||||
schedule:
|
||||
- cron: 0 0 * * *
|
||||
jobs:
|
||||
generate:
|
||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||
with:
|
||||
force: ${{ github.event.inputs.force }}
|
||||
mode: pr
|
||||
set_version: ${{ github.event.inputs.set_version }}
|
||||
speakeasy_version: latest
|
||||
secrets:
|
||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
pypi_token: ${{ secrets.PYPI_TOKEN }}
|
||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||
20
.github/workflows/sdk_publish.yaml
vendored
Normal file
20
.github/workflows/sdk_publish.yaml
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
name: Publish
|
||||
permissions:
|
||||
checks: write
|
||||
contents: write
|
||||
pull-requests: write
|
||||
statuses: write
|
||||
"on":
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- RELEASES.md
|
||||
- '*/RELEASES.md'
|
||||
jobs:
|
||||
publish:
|
||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-publish.yaml@v15
|
||||
secrets:
|
||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
pypi_token: ${{ secrets.PYPI_TOKEN }}
|
||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||
31
.github/workflows/speakeasy_sdk_generation.yml
vendored
31
.github/workflows/speakeasy_sdk_generation.yml
vendored
@@ -1,31 +0,0 @@
|
||||
name: Generate
|
||||
permissions:
|
||||
checks: write
|
||||
contents: write
|
||||
pull-requests: write
|
||||
statuses: write
|
||||
"on":
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
force:
|
||||
description: Force generation of SDKs
|
||||
type: boolean
|
||||
default: false
|
||||
push_code_samples_only:
|
||||
description: Force push only code samples from SDK generation
|
||||
type: boolean
|
||||
default: false
|
||||
schedule:
|
||||
- cron: 0 0 * * *
|
||||
jobs:
|
||||
generate:
|
||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||
with:
|
||||
force: ${{ github.event.inputs.force }}
|
||||
mode: direct
|
||||
push_code_samples_only: ${{ fromJSON(github.event.inputs.push_code_samples_only) }}
|
||||
speakeasy_version: latest
|
||||
secrets:
|
||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
pypi_token: ${{ secrets.PYPI_TOKEN }}
|
||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||
20
.github/workflows/tagging.yaml
vendored
20
.github/workflows/tagging.yaml
vendored
@@ -1,20 +0,0 @@
|
||||
name: Speakeasy Tagging
|
||||
permissions:
|
||||
checks: write
|
||||
contents: write
|
||||
pull-requests: write
|
||||
statuses: write
|
||||
"on":
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths: []
|
||||
workflow_dispatch: {}
|
||||
jobs:
|
||||
tag:
|
||||
uses: speakeasy-api/sdk-generation-action/.github/workflows/tag.yaml@v15
|
||||
with:
|
||||
registry_tags: main
|
||||
secrets:
|
||||
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,3 +1,6 @@
|
||||
.venv/
|
||||
pyrightconfig.json
|
||||
README-PYPI.md
|
||||
venv/
|
||||
src/*.egg-info/
|
||||
__pycache__/
|
||||
|
||||
2461
.speakeasy/gen.lock
2461
.speakeasy/gen.lock
File diff suppressed because it is too large
Load Diff
@@ -10,17 +10,20 @@ generation:
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: false
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
python:
|
||||
version: 0.10.0
|
||||
version: 0.11.0
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
extraDependencies:
|
||||
dev: {}
|
||||
dev: {}
|
||||
main: {}
|
||||
author: LukeHagar
|
||||
authors:
|
||||
- Speakeasy
|
||||
clientServerStatusCodesAsErrors: true
|
||||
description: Python Client SDK Generated by Speakeasy
|
||||
enumFormat: enum
|
||||
flattenGlobalSecurity: true
|
||||
flattenRequests: false
|
||||
imports:
|
||||
option: openapi
|
||||
paths:
|
||||
@@ -36,4 +39,4 @@ python:
|
||||
packageName: plex-api-client
|
||||
projectUrls: {}
|
||||
responseFormat: envelope
|
||||
templateVersion: v1
|
||||
templateVersion: v2
|
||||
|
||||
@@ -1,34 +1,35 @@
|
||||
speakeasyVersion: 1.322.3
|
||||
speakeasyVersion: 1.393.0
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:a349a5e821636e63846d0f807281264a5635e046828dadf05da5861f29fac24b
|
||||
sourceBlobDigest: sha256:b359c88992331fb1e15cbb1131469faf27d0c7e758c2a2713122c4cd687adca0
|
||||
sourceRevisionDigest: sha256:44184fe64938a688d21d58aa0e390471812eda6f10c9ca0145a7328cf31a4f0a
|
||||
sourceBlobDigest: sha256:7257c51225e1fb6fa7de445fbe2f31151dc89771894c9b731a29ab01b504f503
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
targets:
|
||||
plexpy:
|
||||
source: my-source
|
||||
sourceNamespace: my-source
|
||||
sourceRevisionDigest: sha256:a349a5e821636e63846d0f807281264a5635e046828dadf05da5861f29fac24b
|
||||
sourceBlobDigest: sha256:b359c88992331fb1e15cbb1131469faf27d0c7e758c2a2713122c4cd687adca0
|
||||
outLocation: /github/workspace/repo
|
||||
sourceRevisionDigest: sha256:44184fe64938a688d21d58aa0e390471812eda6f10c9ca0145a7328cf31a4f0a
|
||||
sourceBlobDigest: sha256:7257c51225e1fb6fa7de445fbe2f31151dc89771894c9b731a29ab01b504f503
|
||||
codeSamplesNamespace: code-samples-python-plexpy
|
||||
codeSamplesRevisionDigest: sha256:4e01301c28b13604518c3325dcca1ea1522d890c190a7f0a41fccd205ca10551
|
||||
outLocation: /home/luke/github/plexpy
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
my-source:
|
||||
inputs:
|
||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
||||
targets:
|
||||
plexpy:
|
||||
target: python
|
||||
source: my-source
|
||||
publish:
|
||||
pypi:
|
||||
token: $PYPI_TOKEN
|
||||
token: $pypi_token
|
||||
codeSamples:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-python-plexpy
|
||||
|
||||
@@ -3,16 +3,14 @@ speakeasyVersion: latest
|
||||
sources:
|
||||
my-source:
|
||||
inputs:
|
||||
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
|
||||
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main
|
||||
targets:
|
||||
plexpy:
|
||||
target: python
|
||||
source: my-source
|
||||
publish:
|
||||
pypi:
|
||||
token: $PYPI_TOKEN
|
||||
token: $pypi_token
|
||||
codeSamples:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
|
||||
6
.vscode/settings.json
vendored
Normal file
6
.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"python.testing.pytestArgs": ["tests", "-vv"],
|
||||
"python.testing.unittestEnabled": false,
|
||||
"python.testing.pytestEnabled": true,
|
||||
"pylint.args": ["--rcfile=pylintrc"]
|
||||
}
|
||||
26
CONTRIBUTING.md
Normal file
26
CONTRIBUTING.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Contributing to This Repository
|
||||
|
||||
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
|
||||
|
||||
## How to Report Issues
|
||||
|
||||
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
|
||||
|
||||
- A clear and descriptive title
|
||||
- Steps to reproduce the issue
|
||||
- Expected and actual behavior
|
||||
- Any relevant logs, screenshots, or error messages
|
||||
- Information about your environment (e.g., operating system, software versions)
|
||||
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
|
||||
|
||||
## Issue Triage and Upstream Fixes
|
||||
|
||||
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
|
||||
|
||||
## Contact
|
||||
|
||||
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
|
||||
|
||||
Thank you for your understanding and cooperation!
|
||||
|
||||
The Maintainers
|
||||
325
README.md
325
README.md
@@ -7,34 +7,100 @@
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<!-- Start Summary [summary] -->
|
||||
## Summary
|
||||
|
||||
Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||
<!-- End Summary [summary] -->
|
||||
|
||||
<!-- Start Table of Contents [toc] -->
|
||||
## Table of Contents
|
||||
|
||||
* [SDK Installation](#sdk-installation)
|
||||
* [IDE Support](#ide-support)
|
||||
* [SDK Example Usage](#sdk-example-usage)
|
||||
* [Available Resources and Operations](#available-resources-and-operations)
|
||||
* [Global Parameters](#global-parameters)
|
||||
* [Retries](#retries)
|
||||
* [Error Handling](#error-handling)
|
||||
* [Server Selection](#server-selection)
|
||||
* [Custom HTTP Client](#custom-http-client)
|
||||
* [Authentication](#authentication)
|
||||
* [Debugging](#debugging)
|
||||
<!-- End Table of Contents [toc] -->
|
||||
|
||||
<!-- Start SDK Installation [installation] -->
|
||||
## SDK Installation
|
||||
|
||||
The SDK can be installed with either *pip* or *poetry* package managers.
|
||||
|
||||
### PIP
|
||||
|
||||
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
|
||||
|
||||
```bash
|
||||
pip install plex-api-client
|
||||
```
|
||||
|
||||
### Poetry
|
||||
|
||||
*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
|
||||
|
||||
```bash
|
||||
poetry add plex-api-client
|
||||
```
|
||||
<!-- End SDK Installation [installation] -->
|
||||
|
||||
<!-- Start IDE Support [idesupport] -->
|
||||
## IDE Support
|
||||
|
||||
### PyCharm
|
||||
|
||||
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.
|
||||
|
||||
- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
|
||||
<!-- End IDE Support [idesupport] -->
|
||||
|
||||
<!-- Start SDK Example Usage [usage] -->
|
||||
## SDK Example Usage
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import plex_api
|
||||
# Synchronous Example
|
||||
from plex_api_client import PlexAPI
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
s = PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier='Postman',
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
|
||||
|
||||
res = s.server.get_server_capabilities()
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
|
||||
</br>
|
||||
|
||||
The same SDK client can also be used to make asychronous requests by importing asyncio.
|
||||
```python
|
||||
# Asynchronous Example
|
||||
import asyncio
|
||||
from plex_api_client import PlexAPI
|
||||
|
||||
async def main():
|
||||
s = PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
res = await s.server.get_server_capabilities_async()
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
asyncio.run(main())
|
||||
```
|
||||
<!-- End SDK Example Usage [usage] -->
|
||||
|
||||
@@ -50,6 +116,7 @@ if res.object is not None:
|
||||
* [get_server_identity](docs/sdks/server/README.md#get_server_identity) - Get Server Identity
|
||||
* [get_my_plex_account](docs/sdks/server/README.md#get_my_plex_account) - Get MyPlex Account
|
||||
* [get_resized_photo](docs/sdks/server/README.md#get_resized_photo) - Get a Resized Photo
|
||||
* [get_media_providers](docs/sdks/server/README.md#get_media_providers) - Get Media Providers
|
||||
* [get_server_list](docs/sdks/server/README.md#get_server_list) - Get Server List
|
||||
|
||||
### [media](docs/sdks/media/README.md)
|
||||
@@ -57,6 +124,8 @@ if res.object is not None:
|
||||
* [mark_played](docs/sdks/media/README.md#mark_played) - Mark Media Played
|
||||
* [mark_unplayed](docs/sdks/media/README.md#mark_unplayed) - Mark Media Unplayed
|
||||
* [update_play_progress](docs/sdks/media/README.md#update_play_progress) - Update Media Play Progress
|
||||
* [get_banner_image](docs/sdks/media/README.md#get_banner_image) - Get Banner Image
|
||||
* [get_thumb_image](docs/sdks/media/README.md#get_thumb_image) - Get Thumb Image
|
||||
|
||||
### [video](docs/sdks/video/README.md)
|
||||
|
||||
@@ -78,9 +147,13 @@ if res.object is not None:
|
||||
|
||||
### [plex](docs/sdks/plex/README.md)
|
||||
|
||||
* [get_companions_data](docs/sdks/plex/README.md#get_companions_data) - Get Companions Data
|
||||
* [get_user_friends](docs/sdks/plex/README.md#get_user_friends) - Get list of friends of the user logged in
|
||||
* [get_geo_data](docs/sdks/plex/README.md#get_geo_data) - Get Geo Data
|
||||
* [get_home_data](docs/sdks/plex/README.md#get_home_data) - Get Plex Home Data
|
||||
* [get_server_resources](docs/sdks/plex/README.md#get_server_resources) - Get Server Resources
|
||||
* [get_pin](docs/sdks/plex/README.md#get_pin) - Get a Pin
|
||||
* [get_token](docs/sdks/plex/README.md#get_token) - Get Access Token
|
||||
* [get_token_by_pin_id](docs/sdks/plex/README.md#get_token_by_pin_id) - Get Access Token by PinId
|
||||
|
||||
### [hubs](docs/sdks/hubs/README.md)
|
||||
|
||||
@@ -97,17 +170,21 @@ if res.object is not None:
|
||||
|
||||
* [get_file_hash](docs/sdks/library/README.md#get_file_hash) - Get Hash Value
|
||||
* [get_recently_added](docs/sdks/library/README.md#get_recently_added) - Get Recently Added
|
||||
* [get_libraries](docs/sdks/library/README.md#get_libraries) - Get All Libraries
|
||||
* [get_library](docs/sdks/library/README.md#get_library) - Get Library Details
|
||||
* [get_all_libraries](docs/sdks/library/README.md#get_all_libraries) - Get All Libraries
|
||||
* [get_library_details](docs/sdks/library/README.md#get_library_details) - Get Library Details
|
||||
* [delete_library](docs/sdks/library/README.md#delete_library) - Delete Library Section
|
||||
* [get_library_items](docs/sdks/library/README.md#get_library_items) - Get Library Items
|
||||
* [refresh_library](docs/sdks/library/README.md#refresh_library) - Refresh Library
|
||||
* [search_library](docs/sdks/library/README.md#search_library) - Search Library
|
||||
* [get_metadata](docs/sdks/library/README.md#get_metadata) - Get Items Metadata
|
||||
* [get_refresh_library_metadata](docs/sdks/library/README.md#get_refresh_library_metadata) - Refresh Metadata Of The Library
|
||||
* [get_search_library](docs/sdks/library/README.md#get_search_library) - Search Library
|
||||
* [get_meta_data_by_rating_key](docs/sdks/library/README.md#get_meta_data_by_rating_key) - Get Metadata by RatingKey
|
||||
* [get_metadata_children](docs/sdks/library/README.md#get_metadata_children) - Get Items Children
|
||||
* [get_top_watched_content](docs/sdks/library/README.md#get_top_watched_content) - Get Top Watched Content
|
||||
* [get_on_deck](docs/sdks/library/README.md#get_on_deck) - Get On Deck
|
||||
|
||||
### [watchlist](docs/sdks/watchlist/README.md)
|
||||
|
||||
* [get_watch_list](docs/sdks/watchlist/README.md#get_watch_list) - Get User Watchlist
|
||||
|
||||
### [log](docs/sdks/log/README.md)
|
||||
|
||||
* [log_line](docs/sdks/log/README.md#log_line) - Logging a single line message.
|
||||
@@ -130,6 +207,8 @@ if res.object is not None:
|
||||
|
||||
* [get_transient_token](docs/sdks/authentication/README.md#get_transient_token) - Get a Transient Token.
|
||||
* [get_source_connection_information](docs/sdks/authentication/README.md#get_source_connection_information) - Get Source Connection Information
|
||||
* [get_user_details](docs/sdks/authentication/README.md#get_user_details) - Get User Data By Token
|
||||
* [post_users_sign_in_data](docs/sdks/authentication/README.md#post_users_sign_in_data) - Get User Sign In Data
|
||||
|
||||
### [statistics](docs/sdks/statistics/README.md)
|
||||
|
||||
@@ -149,48 +228,91 @@ if res.object is not None:
|
||||
* [get_update_status](docs/sdks/updater/README.md#get_update_status) - Querying status of updates
|
||||
* [check_for_updates](docs/sdks/updater/README.md#check_for_updates) - Checking for updates
|
||||
* [apply_updates](docs/sdks/updater/README.md#apply_updates) - Apply Updates
|
||||
|
||||
### [watchlist](docs/sdks/watchlist/README.md)
|
||||
|
||||
* [get_watchlist](docs/sdks/watchlist/README.md#get_watchlist) - Get User Watchlist
|
||||
<!-- End Available Resources and Operations [operations] -->
|
||||
|
||||
<!-- Start Retries [retries] -->
|
||||
## Retries
|
||||
|
||||
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
|
||||
|
||||
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
|
||||
```python
|
||||
from plex_api.utils import BackoffStrategy, RetryConfig
|
||||
from plex_api_client import PlexAPI
|
||||
|
||||
s = PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
|
||||
res = s.server.get_server_capabilities(,
|
||||
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
```
|
||||
|
||||
If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
|
||||
```python
|
||||
from plex_api.utils import BackoffStrategy, RetryConfig
|
||||
from plex_api_client import PlexAPI
|
||||
|
||||
s = PlexAPI(
|
||||
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
|
||||
res = s.server.get_server_capabilities()
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
```
|
||||
<!-- End Retries [retries] -->
|
||||
|
||||
<!-- Start Error Handling [errors] -->
|
||||
## Error Handling
|
||||
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| errors.GetServerCapabilitiesResponseBody | 401 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
| Error Object | Status Code | Content Type |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| errors.GetServerCapabilitiesResponseBody | 400 | application/json |
|
||||
| errors.GetServerCapabilitiesServerResponseBody | 401 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import plex_api
|
||||
from plex_api.models import errors
|
||||
from plex_api_client import PlexAPI
|
||||
from plex_api_client.models import errors
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
s = PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier='Postman',
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
|
||||
res = None
|
||||
try:
|
||||
res = s.server.get_server_capabilities()
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
except errors.GetServerCapabilitiesResponseBody as e:
|
||||
# handle exception
|
||||
# handle e.data: errors.GetServerCapabilitiesResponseBodyData
|
||||
raise(e)
|
||||
except errors.GetServerCapabilitiesServerResponseBody as e:
|
||||
# handle e.data: errors.GetServerCapabilitiesServerResponseBodyData
|
||||
raise(e)
|
||||
except errors.SDKError as e:
|
||||
# handle exception
|
||||
raise(e)
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
```
|
||||
<!-- End Error Handling [errors] -->
|
||||
|
||||
@@ -203,20 +325,19 @@ You can override the default server globally by passing a server index to the `s
|
||||
|
||||
| # | Server | Variables |
|
||||
| - | ------ | --------- |
|
||||
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
|
||||
|
||||
#### Example
|
||||
|
||||
```python
|
||||
import plex_api
|
||||
from plex_api_client import PlexAPI
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
s = PlexAPI(
|
||||
server_idx=0,
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier='Postman',
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
|
||||
|
||||
res = s.server.get_server_capabilities()
|
||||
|
||||
if res.object is not None:
|
||||
@@ -236,15 +357,14 @@ Some of the server options above contain variables. If you want to set the value
|
||||
|
||||
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
|
||||
```python
|
||||
import plex_api
|
||||
from plex_api_client import PlexAPI
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
s = PlexAPI(
|
||||
server_url="{protocol}://{ip}:{port}",
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier='Postman',
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
|
||||
|
||||
res = s.server.get_server_capabilities()
|
||||
|
||||
if res.object is not None:
|
||||
@@ -257,16 +377,16 @@ if res.object is not None:
|
||||
|
||||
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
|
||||
```python
|
||||
import plex_api
|
||||
from plex_api_client import PlexAPI
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
x_plex_client_identifier='Postman',
|
||||
s = PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
|
||||
res = s.plex.get_companions_data(server_url="https://plex.tv/api/v2/")
|
||||
|
||||
res = s.plex.get_pin(x_plex_product='Postman', strong=False, x_plex_client_identifier='Postman', server_url="https://plex.tv/api/v2")
|
||||
|
||||
if res.object is not None:
|
||||
if res.response_bodies is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
@@ -276,16 +396,81 @@ if res.object is not None:
|
||||
<!-- Start Custom HTTP Client [http-client] -->
|
||||
## Custom HTTP Client
|
||||
|
||||
The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
|
||||
The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
|
||||
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
|
||||
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.
|
||||
|
||||
For example, you could specify a header for every request that this sdk makes as follows:
|
||||
```python
|
||||
import plex_api
|
||||
import requests
|
||||
from plex_api_client import PlexAPI
|
||||
import httpx
|
||||
|
||||
http_client = requests.Session()
|
||||
http_client.headers.update({'x-custom-header': 'someValue'})
|
||||
s = plex_api.PlexAPI(client=http_client)
|
||||
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
|
||||
s = PlexAPI(client=http_client)
|
||||
```
|
||||
|
||||
or you could wrap the client with your own custom logic:
|
||||
```python
|
||||
from plex_api_client import PlexAPI
|
||||
from plex_api_client.httpclient import AsyncHttpClient
|
||||
import httpx
|
||||
|
||||
class CustomClient(AsyncHttpClient):
|
||||
client: AsyncHttpClient
|
||||
|
||||
def __init__(self, client: AsyncHttpClient):
|
||||
self.client = client
|
||||
|
||||
async def send(
|
||||
self,
|
||||
request: httpx.Request,
|
||||
*,
|
||||
stream: bool = False,
|
||||
auth: Union[
|
||||
httpx._types.AuthTypes, httpx._client.UseClientDefault, None
|
||||
] = httpx.USE_CLIENT_DEFAULT,
|
||||
follow_redirects: Union[
|
||||
bool, httpx._client.UseClientDefault
|
||||
] = httpx.USE_CLIENT_DEFAULT,
|
||||
) -> httpx.Response:
|
||||
request.headers["Client-Level-Header"] = "added by client"
|
||||
|
||||
return await self.client.send(
|
||||
request, stream=stream, auth=auth, follow_redirects=follow_redirects
|
||||
)
|
||||
|
||||
def build_request(
|
||||
self,
|
||||
method: str,
|
||||
url: httpx._types.URLTypes,
|
||||
*,
|
||||
content: Optional[httpx._types.RequestContent] = None,
|
||||
data: Optional[httpx._types.RequestData] = None,
|
||||
files: Optional[httpx._types.RequestFiles] = None,
|
||||
json: Optional[Any] = None,
|
||||
params: Optional[httpx._types.QueryParamTypes] = None,
|
||||
headers: Optional[httpx._types.HeaderTypes] = None,
|
||||
cookies: Optional[httpx._types.CookieTypes] = None,
|
||||
timeout: Union[
|
||||
httpx._types.TimeoutTypes, httpx._client.UseClientDefault
|
||||
] = httpx.USE_CLIENT_DEFAULT,
|
||||
extensions: Optional[httpx._types.RequestExtensions] = None,
|
||||
) -> httpx.Request:
|
||||
return self.client.build_request(
|
||||
method,
|
||||
url,
|
||||
content=content,
|
||||
data=data,
|
||||
files=files,
|
||||
json=json,
|
||||
params=params,
|
||||
headers=headers,
|
||||
cookies=cookies,
|
||||
timeout=timeout,
|
||||
extensions=extensions,
|
||||
)
|
||||
|
||||
s = PlexAPI(async_client=CustomClient(httpx.AsyncClient()))
|
||||
```
|
||||
<!-- End Custom HTTP Client [http-client] -->
|
||||
|
||||
@@ -302,14 +487,13 @@ This SDK supports the following security scheme globally:
|
||||
|
||||
To authenticate with the API the `access_token` parameter must be set when initializing the SDK client instance. For example:
|
||||
```python
|
||||
import plex_api
|
||||
from plex_api_client import PlexAPI
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
s = PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier='Postman',
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
|
||||
|
||||
res = s.server.get_server_capabilities()
|
||||
|
||||
if res.object is not None:
|
||||
@@ -324,7 +508,7 @@ if res.object is not None:
|
||||
|
||||
A parameter is configured globally. This parameter may 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 `'Postman'` 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.
|
||||
For example, you can set `X-Plex-Client-Identifier` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_server_resources`. 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
|
||||
@@ -342,22 +526,43 @@ This is used to track the client application and its usage
|
||||
### Example
|
||||
|
||||
```python
|
||||
import plex_api
|
||||
from plex_api_client import PlexAPI
|
||||
from plex_api_client.models import operations
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
x_plex_client_identifier='Postman',
|
||||
s = PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
|
||||
res = s.plex.get_server_resources(request={
|
||||
"x_plex_token": "CV5xoxjTpFKUzBTShsaf",
|
||||
"include_https": operations.IncludeHTTPS.ONE,
|
||||
"include_relay": operations.IncludeRelay.ONE,
|
||||
"include_i_pv6": operations.IncludeIPv6.ONE,
|
||||
})
|
||||
|
||||
res = s.plex.get_pin(x_plex_product='Postman', strong=False, x_plex_client_identifier='Postman')
|
||||
|
||||
if res.object is not None:
|
||||
if res.plex_devices is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
```
|
||||
<!-- End Global Parameters [global-parameters] -->
|
||||
|
||||
<!-- Start Debugging [debug] -->
|
||||
## Debugging
|
||||
|
||||
You can setup your SDK to emit debug logs for SDK requests and responses.
|
||||
|
||||
You can pass your own logger class directly into your SDK.
|
||||
```python
|
||||
from plex_api_client import PlexAPI
|
||||
import logging
|
||||
|
||||
logging.basicConfig(level=logging.DEBUG)
|
||||
s = PlexAPI(debug_logger=logging.getLogger("plex_api_client"))
|
||||
```
|
||||
<!-- End Debugging [debug] -->
|
||||
|
||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||
|
||||
# Development
|
||||
|
||||
28
USAGE.md
28
USAGE.md
@@ -1,18 +1,38 @@
|
||||
<!-- Start SDK Example Usage [usage] -->
|
||||
```python
|
||||
import plex_api
|
||||
# Synchronous Example
|
||||
from plex_api_client import PlexAPI
|
||||
|
||||
s = plex_api.PlexAPI(
|
||||
s = PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier='Postman',
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
|
||||
|
||||
res = s.server.get_server_capabilities()
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
|
||||
</br>
|
||||
|
||||
The same SDK client can also be used to make asychronous requests by importing asyncio.
|
||||
```python
|
||||
# Asynchronous Example
|
||||
import asyncio
|
||||
from plex_api_client import PlexAPI
|
||||
|
||||
async def main():
|
||||
s = PlexAPI(
|
||||
access_token="<YOUR_API_KEY_HERE>",
|
||||
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40",
|
||||
)
|
||||
res = await s.server.get_server_capabilities_async()
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
asyncio.run(main())
|
||||
```
|
||||
<!-- End SDK Example Usage [usage] -->
|
||||
2149
codeSamples.yaml
2149
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
@@ -5,4 +5,4 @@
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `access_token` | *str* | :heavy_check_mark: | N/A |
|
||||
| `access_token` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/addplaylistcontentsplaylistserrors.md
Normal file
10
docs/models/errors/addplaylistcontentsplaylistserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# AddPlaylistContentsPlaylistsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -0,0 +1,11 @@
|
||||
# AddPlaylistContentsPlaylistsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.AddPlaylistContentsPlaylistsErrors](../../models/errors/addplaylistcontentsplaylistserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,6 +1,6 @@
|
||||
# AddPlaylistContentsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -8,4 +8,4 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.AddPlaylistContentsErrors](../../models/errors/addplaylistcontentserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# ApplyUpdatesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.ApplyUpdatesErrors](../../models/errors/applyupdateserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.ApplyUpdatesErrors](../../models/errors/applyupdateserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/applyupdatesupdatererrors.md
Normal file
10
docs/models/errors/applyupdatesupdatererrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ApplyUpdatesUpdaterErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/applyupdatesupdaterresponsebody.md
Normal file
11
docs/models/errors/applyupdatesupdaterresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# ApplyUpdatesUpdaterResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.ApplyUpdatesUpdaterErrors](../../models/errors/applyupdatesupdatererrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/cancelserveractivitiesactivitieserrors.md
Normal file
10
docs/models/errors/cancelserveractivitiesactivitieserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CancelServerActivitiesActivitiesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -0,0 +1,11 @@
|
||||
# CancelServerActivitiesActivitiesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.CancelServerActivitiesActivitiesErrors](../../models/errors/cancelserveractivitiesactivitieserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# CancelServerActivitiesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -8,4 +8,4 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.CancelServerActivitiesErrors](../../models/errors/cancelserveractivitieserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# CheckForUpdatesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.CheckForUpdatesErrors](../../models/errors/checkforupdateserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.CheckForUpdatesErrors](../../models/errors/checkforupdateserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/checkforupdatesupdatererrors.md
Normal file
10
docs/models/errors/checkforupdatesupdatererrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CheckForUpdatesUpdaterErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/checkforupdatesupdaterresponsebody.md
Normal file
11
docs/models/errors/checkforupdatesupdaterresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CheckForUpdatesUpdaterResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.CheckForUpdatesUpdaterErrors](../../models/errors/checkforupdatesupdatererrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/clearplaylistcontentsplaylistserrors.md
Normal file
10
docs/models/errors/clearplaylistcontentsplaylistserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# ClearPlaylistContentsPlaylistsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -0,0 +1,11 @@
|
||||
# ClearPlaylistContentsPlaylistsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.ClearPlaylistContentsPlaylistsErrors](../../models/errors/clearplaylistcontentsplaylistserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,6 +1,6 @@
|
||||
# ClearPlaylistContentsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -8,4 +8,4 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.ClearPlaylistContentsErrors](../../models/errors/clearplaylistcontentserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/createplaylistplaylistserrors.md
Normal file
10
docs/models/errors/createplaylistplaylistserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CreatePlaylistPlaylistsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/createplaylistplaylistsresponsebody.md
Normal file
11
docs/models/errors/createplaylistplaylistsresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CreatePlaylistPlaylistsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.CreatePlaylistPlaylistsErrors](../../models/errors/createplaylistplaylistserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# CreatePlaylistResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.CreatePlaylistErrors](../../models/errors/createplaylisterrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.CreatePlaylistErrors](../../models/errors/createplaylisterrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/deletelibrarylibraryerrors.md
Normal file
10
docs/models/errors/deletelibrarylibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DeleteLibraryLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/deletelibrarylibraryresponsebody.md
Normal file
11
docs/models/errors/deletelibrarylibraryresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# DeleteLibraryLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.DeleteLibraryLibraryErrors](../../models/errors/deletelibrarylibraryerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# DeleteLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.DeleteLibraryErrors](../../models/errors/deletelibraryerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.DeleteLibraryErrors](../../models/errors/deletelibraryerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/deleteplaylistplaylistserrors.md
Normal file
10
docs/models/errors/deleteplaylistplaylistserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DeletePlaylistPlaylistsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/deleteplaylistplaylistsresponsebody.md
Normal file
11
docs/models/errors/deleteplaylistplaylistsresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# DeletePlaylistPlaylistsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.DeletePlaylistPlaylistsErrors](../../models/errors/deleteplaylistplaylistserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# DeletePlaylistResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.DeletePlaylistErrors](../../models/errors/deleteplaylisterrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.DeletePlaylistErrors](../../models/errors/deleteplaylisterrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/enablepapertraillogerrors.md
Normal file
10
docs/models/errors/enablepapertraillogerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# EnablePaperTrailLogErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/enablepapertraillogresponsebody.md
Normal file
11
docs/models/errors/enablepapertraillogresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# EnablePaperTrailLogResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.EnablePaperTrailLogErrors](../../models/errors/enablepapertraillogerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# EnablePaperTrailResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.EnablePaperTrailErrors](../../models/errors/enablepapertrailerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.EnablePaperTrailErrors](../../models/errors/enablepapertrailerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/getalllibrarieserrors.md
Normal file
10
docs/models/errors/getalllibrarieserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetAllLibrariesErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/getalllibrarieslibraryerrors.md
Normal file
10
docs/models/errors/getalllibrarieslibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetAllLibrariesLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/getalllibrarieslibraryresponsebody.md
Normal file
11
docs/models/errors/getalllibrarieslibraryresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetAllLibrariesLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetAllLibrariesLibraryErrors](../../models/errors/getalllibrarieslibraryerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
11
docs/models/errors/getalllibrariesresponsebody.md
Normal file
11
docs/models/errors/getalllibrariesresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetAllLibrariesResponseBody
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetAllLibrariesErrors](../../models/errors/getalllibrarieserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetAvailableClientsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -8,4 +8,4 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetAvailableClientsErrors](../../models/errors/getavailableclientserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/getavailableclientsservererrors.md
Normal file
10
docs/models/errors/getavailableclientsservererrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetAvailableClientsServerErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/getavailableclientsserverresponsebody.md
Normal file
11
docs/models/errors/getavailableclientsserverresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetAvailableClientsServerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetAvailableClientsServerErrors](../../models/errors/getavailableclientsservererrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,6 +1,6 @@
|
||||
# GetBandwidthStatisticsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
@@ -8,4 +8,4 @@ Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetBandwidthStatisticsErrors](../../models/errors/getbandwidthstatisticserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/getbandwidthstatisticsstatisticserrors.md
Normal file
10
docs/models/errors/getbandwidthstatisticsstatisticserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetBandwidthStatisticsStatisticsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -0,0 +1,11 @@
|
||||
# GetBandwidthStatisticsStatisticsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetBandwidthStatisticsStatisticsErrors](../../models/errors/getbandwidthstatisticsstatisticserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/getbannerimageerrors.md
Normal file
10
docs/models/errors/getbannerimageerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetBannerImageErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/getbannerimagemediaerrors.md
Normal file
10
docs/models/errors/getbannerimagemediaerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetBannerImageMediaErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/getbannerimagemediaresponsebody.md
Normal file
11
docs/models/errors/getbannerimagemediaresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetBannerImageMediaResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetBannerImageMediaErrors](../../models/errors/getbannerimagemediaerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
11
docs/models/errors/getbannerimageresponsebody.md
Normal file
11
docs/models/errors/getbannerimageresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetBannerImageResponseBody
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetBannerImageErrors](../../models/errors/getbannerimageerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/getbutlertasksbutlererrors.md
Normal file
10
docs/models/errors/getbutlertasksbutlererrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetButlerTasksButlerErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/getbutlertasksbutlerresponsebody.md
Normal file
11
docs/models/errors/getbutlertasksbutlerresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetButlerTasksButlerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetButlerTasksButlerErrors](../../models/errors/getbutlertasksbutlererrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetButlerTasksResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetButlerTasksErrors](../../models/errors/getbutlertaskserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetButlerTasksErrors](../../models/errors/getbutlertaskserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/getcompanionsdataerrors.md
Normal file
10
docs/models/errors/getcompanionsdataerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetCompanionsDataErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/getcompanionsdataplexerrors.md
Normal file
10
docs/models/errors/getcompanionsdataplexerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetCompanionsDataPlexErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/getcompanionsdataplexresponsebody.md
Normal file
11
docs/models/errors/getcompanionsdataplexresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetCompanionsDataPlexResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetCompanionsDataPlexErrors](../../models/errors/getcompanionsdataplexerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
11
docs/models/errors/getcompanionsdataresponsebody.md
Normal file
11
docs/models/errors/getcompanionsdataresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetCompanionsDataResponseBody
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetCompanionsDataErrors](../../models/errors/getcompanionsdataerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetDevicesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetDevicesErrors](../../models/errors/getdeviceserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetDevicesErrors](../../models/errors/getdeviceserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/getdevicesservererrors.md
Normal file
10
docs/models/errors/getdevicesservererrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetDevicesServerErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/getdevicesserverresponsebody.md
Normal file
11
docs/models/errors/getdevicesserverresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetDevicesServerResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetDevicesServerErrors](../../models/errors/getdevicesservererrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/getfilehashlibraryerrors.md
Normal file
10
docs/models/errors/getfilehashlibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetFileHashLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/getfilehashlibraryresponsebody.md
Normal file
11
docs/models/errors/getfilehashlibraryresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetFileHashLibraryResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetFileHashLibraryErrors](../../models/errors/getfilehashlibraryerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetFileHashResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetFileHashErrors](../../models/errors/getfilehasherrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetFileHashErrors](../../models/errors/getfilehasherrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,10 +1,10 @@
|
||||
# GetTokenErrors
|
||||
# GetGeoDataErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 400 |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +1,10 @@
|
||||
# RefreshLibraryErrors
|
||||
# GetGeoDataPlexErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/getgeodataplexresponsebody.md
Normal file
11
docs/models/errors/getgeodataplexresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetGeoDataPlexResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetGeoDataPlexErrors](../../models/errors/getgeodataplexerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
11
docs/models/errors/getgeodataresponsebody.md
Normal file
11
docs/models/errors/getgeodataresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetGeoDataResponseBody
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetGeoDataErrors](../../models/errors/getgeodataerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +1,10 @@
|
||||
# GetServerIdentityErrors
|
||||
# GetGlobalHubsHubsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/getglobalhubshubsresponsebody.md
Normal file
11
docs/models/errors/getglobalhubshubsresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetGlobalHubsHubsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetGlobalHubsHubsErrors](../../models/errors/getglobalhubshubserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetGlobalHubsResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetGlobalHubsErrors](../../models/errors/getglobalhubserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
|
||||
| `errors` | List[[errors.GetGlobalHubsErrors](../../models/errors/getglobalhubserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,10 +1,10 @@
|
||||
# GetLibrariesErrors
|
||||
# GetHomeDataPlexErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[float]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[float]* | :heavy_minus_sign: | N/A | 401 |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
11
docs/models/errors/gethomedataplexresponsebody.md
Normal file
11
docs/models/errors/gethomedataplexresponsebody.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetHomeDataPlexResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetHomeDataPlexErrors](../../models/errors/gethomedataplexerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetHomeDataResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetHomeDataErrors](../../models/errors/gethomedataerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetHomeDataErrors](../../models/errors/gethomedataerrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibrariesResponseBody
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `errors` | List[[errors.GetLibrariesErrors](../../models/errors/getlibrarieserrors.md)] | :heavy_minus_sign: | N/A |
|
||||
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
10
docs/models/errors/getlibrarydetailserrors.md
Normal file
10
docs/models/errors/getlibrarydetailserrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryDetailsErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 400 |
|
||||
10
docs/models/errors/getlibrarydetailslibraryerrors.md
Normal file
10
docs/models/errors/getlibrarydetailslibraryerrors.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryDetailsLibraryErrors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *Optional[int]* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *Optional[str]* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *Optional[int]* | :heavy_minus_sign: | N/A | 401 |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user