ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.399.2

This commit is contained in:
speakeasybot
2024-09-19 05:59:37 +00:00
parent 351d72a1de
commit 22a6122280
48 changed files with 1076 additions and 315 deletions

View File

@@ -1,12 +1,12 @@
lockVersion: 2.0.0 lockVersion: 2.0.0
id: 3eeea668-4ef4-464e-a888-bdfa023bedf5 id: 3eeea668-4ef4-464e-a888-bdfa023bedf5
management: management:
docChecksum: a6fee1797b2da7ccbaf7743772a40b56 docChecksum: 5bf578a672589649d8ed83c3927c50a6
docVersion: 0.0.3 docVersion: 0.0.3
speakeasyVersion: 1.397.2 speakeasyVersion: 1.399.2
generationVersion: 2.415.8 generationVersion: 2.416.6
releaseVersion: 0.12.1 releaseVersion: 0.12.2
configChecksum: 3542b6f5ca69dd1c3224d6a740605f19 configChecksum: e97273a9df53b29f237a8eb3fabb7b6d
repoURL: https://github.com/LukeHagar/plexpy.git repoURL: https://github.com/LukeHagar/plexpy.git
repoSubDirectory: . repoSubDirectory: .
installationURL: https://github.com/LukeHagar/plexpy.git installationURL: https://github.com/LukeHagar/plexpy.git
@@ -1235,7 +1235,7 @@ examples:
speakeasy-default-get-geo-data: speakeasy-default-get-geo-data:
responses: responses:
"200": "200":
application/json: {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": 802, "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"} application/json: {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": "802", "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}
"400": "400":
application/json: {"errors": []} application/json: {"errors": []}
"401": "401":
@@ -1268,12 +1268,17 @@ examples:
"": "":
parameters: parameters:
query: query:
X-Plex-Product: "Plex Web" X-Plex-Product: Plex Web
X-Plex-Device: Linux
X-Plex-Version: 4.133.0
X-Plex-Platform: Chrome
responses: responses:
"200": "200":
application/json: {"id": 308667304, "code": "7RQZ", "product": "0", "trusted": false, "qr": "https://plex.tv/api/v2/pins/qr/7RQZ", "clientIdentifier": "string", "location": {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": 802, "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}, "expiresIn": 876, "createdAt": "2024-07-16T17:03:05Z", "expiresAt": "2024-07-16T17:18:05Z", "authToken": null, "newRegistration": null} application/json: {"id": 308667304, "code": "7RQZ", "product": "0", "trusted": false, "qr": "https://plex.tv/api/v2/pins/qr/7RQZ", "clientIdentifier": "string", "location": {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": 802, "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}, "expiresIn": 876, "createdAt": "2024-07-16T17:03:05Z", "expiresAt": "2024-07-16T17:18:05Z", "authToken": null, "newRegistration": null}
"400": "400":
application/json: {"errors": []} application/json: {"errors": []}
"201":
application/json: {"id": 308667304, "code": "7RQZ", "product": "0", "trusted": false, "qr": "https://plex.tv/api/v2/pins/qr/7RQZ", "clientIdentifier": "string", "location": {"code": "VI", "continent_code": "NA", "country": "United States Virgin Islands", "city": "Amsterdam", "european_union_member": true, "time_zone": "America/St_Thomas", "postal_code": "802", "in_privacy_restricted_country": true, "in_privacy_restricted_region": true, "subdivisions": "Saint Thomas", "coordinates": "18.3381, -64.8941"}, "expiresIn": 876, "createdAt": "2024-07-16T17:03:05Z", "expiresAt": "2024-07-16T17:18:05Z", "authToken": null, "newRegistration": null}
getTokenByPinId: getTokenByPinId:
"": "":
parameters: parameters:

View File

@@ -12,7 +12,7 @@ generation:
auth: auth:
oAuth2ClientCredentialsEnabled: true oAuth2ClientCredentialsEnabled: true
python: python:
version: 0.12.1 version: 0.12.2
additionalDependencies: additionalDependencies:
dev: {} dev: {}
main: {} main: {}

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.396.2 speakeasyVersion: 1.399.2
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -6,30 +6,36 @@ sources:
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9 sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9
tags: tags:
- latest - latest
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:31e943dab53dd0133fcd12a24e04d511637bd7f37b78fd71efded53c650bf729
sourceBlobDigest: sha256:a652fa39754f0c22a1454f628fe84983b34662ee8a153a3461d50b833f8bc5c2
tags:
- latest
- main
targets: targets:
plexpy: plexpy:
source: my-source source: plexapi
sourceNamespace: my-source sourceNamespace: plexapi
sourceRevisionDigest: sha256:1f43c28112982f7603d8fed99ad5b2d14de397325c20863fb693a4f89f96e3c6 sourceRevisionDigest: sha256:31e943dab53dd0133fcd12a24e04d511637bd7f37b78fd71efded53c650bf729
sourceBlobDigest: sha256:f7e2709f52370dff16c1851a7a4e44a89f2e978e9cae335bffc10625950b3bd9 sourceBlobDigest: sha256:a652fa39754f0c22a1454f628fe84983b34662ee8a153a3461d50b833f8bc5c2
codeSamplesNamespace: code-samples-python-plexpy codeSamplesNamespace: code-samples-python-plexpy
codeSamplesRevisionDigest: sha256:5c0a53ca21a99c2994ba26c54e14064b54d690b13cfa1e7d52bd9fd763224a4d codeSamplesRevisionDigest: sha256:7236102512b931660216bc761cbbcfc8cade2483a024a2fc0af94c4dadd73c1d
outLocation: /home/luke/github/plexpy
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest
sources: sources:
my-source: plexapi:
inputs: inputs:
- location: registry.speakeasyapi.dev/lukehagar/lukehagar/plex-api:main - location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main
targets: targets:
plexpy: plexpy:
target: python target: python
source: my-source source: plexapi
publish: publish:
pypi: pypi:
token: $pypi_token token: $pypi_token
codeSamples: codeSamples:
output: codeSamples.yaml output: codeSamples.yaml
registry: registry:
location: registry.speakeasyapi.dev/lukehagar/lukehagar/code-samples-python-plexpy location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-python-plexpy

View File

@@ -72,7 +72,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -93,7 +97,11 @@ from plex_api_client import PlexAPI
async def main(): async def main():
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = await s.server.get_server_capabilities_async() res = await s.server.get_server_capabilities_async()
if res.object is not None: if res.object is not None:
@@ -248,7 +256,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_capabilities(, res = s.server.get_server_capabilities(,
@@ -268,7 +280,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False), retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -299,7 +315,11 @@ from plex_api_client.models import errors
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = None res = None
@@ -341,7 +361,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
server_idx=0, server_idx=0,
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -368,7 +392,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
server_url="{protocol}://{ip}:{port}", server_url="{protocol}://{ip}:{port}",
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -387,7 +415,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_companions_data(server_url="https://plex.tv/api/v2/") res = s.plex.get_companions_data(server_url="https://plex.tv/api/v2/")
@@ -497,7 +529,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -512,21 +548,25 @@ if res.object is not None:
<!-- Start Global Parameters [global-parameters] --> <!-- Start Global Parameters [global-parameters] -->
## Global Parameters ## Global Parameters
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. Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. 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 `"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. For example, you can set `ClientID` 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 ### Available Globals
The following global parameter is available. The following global parameters are available.
| Name | Type | Required | Description | | Name | Type | Required | Description |
| ---- | ---- |:--------:| ----------- | | ---- | ---- |:--------:| ----------- |
| x_plex_client_identifier | str | | The unique identifier for the client application | client_id | str | | The unique identifier for the client application
This is used to track the client application and its usage This is used to track the client application and its usage
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
| |
| client_name | str | | The client_name parameter. |
| client_version | str | | The client_version parameter. |
| client_platform | str | | The client_platform parameter. |
| device_name | str | | The device_name parameter. |
### Example ### Example
@@ -537,10 +577,14 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_server_resources(x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", include_https=operations.IncludeHTTPS.ONE, include_relay=operations.IncludeRelay.ONE, include_i_pv6=operations.IncludeIPv6.ONE) res = s.plex.get_server_resources(client_id="gcgzw5rz2xovp84b4vha3a40", include_https=operations.IncludeHTTPS.ONE, include_relay=operations.IncludeRelay.ONE, include_i_pv6=operations.IncludeIPv6.ONE)
if res.plex_devices is not None: if res.plex_devices is not None:
# handle response # handle response

View File

@@ -738,4 +738,14 @@ Based on:
### Generated ### Generated
- [python v0.12.1] . - [python v0.12.1] .
### Releases ### Releases
- [PyPI v0.12.1] https://pypi.org/project/plex-api-client/0.12.1 - . - [PyPI v0.12.1] https://pypi.org/project/plex-api-client/0.12.1 - .
## 2024-09-19 05:57:27
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.399.2 (2.416.6) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.12.2] .
### Releases
- [PyPI v0.12.2] https://pypi.org/project/plex-api-client/0.12.2 - .

View File

@@ -5,7 +5,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -26,7 +30,11 @@ from plex_api_client import PlexAPI
async def main(): async def main():
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = await s.server.get_server_capabilities_async() res = await s.server.get_server_capabilities_async()
if res.object is not None: if res.object is not None:

View File

@@ -13,7 +13,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -31,7 +35,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_preferences() res = s.server.get_server_preferences()
@@ -49,7 +57,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.media.update_play_progress(key="<key>", time=90000, state="played") res = s.media.update_play_progress(key="<key>", time=90000, state="played")
@@ -67,7 +79,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.media.mark_played(key=59398) res = s.media.mark_played(key=59398)
@@ -86,7 +102,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.video.get_timeline(request={ res = s.video.get_timeline(request={
@@ -115,7 +135,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.media.mark_unplayed(key=59398) res = s.media.mark_unplayed(key=59398)
@@ -133,7 +157,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.activities.get_server_activities() res = s.activities.get_server_activities()
@@ -151,7 +179,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.activities.cancel_server_activities(activity_uuid="25b71ed5-0f9d-461c-baa7-d404e9e10d3e") res = s.activities.cancel_server_activities(activity_uuid="25b71ed5-0f9d-461c-baa7-d404e9e10d3e")
@@ -169,7 +201,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.butler.stop_all_tasks() res = s.butler.stop_all_tasks()
@@ -187,7 +223,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.butler.get_butler_tasks() res = s.butler.get_butler_tasks()
@@ -205,7 +245,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.butler.start_all_tasks() res = s.butler.start_all_tasks()
@@ -224,7 +268,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.butler.stop_task(task_name=operations.PathParamTaskName.BACKUP_DATABASE) res = s.butler.stop_task(task_name=operations.PathParamTaskName.BACKUP_DATABASE)
@@ -243,7 +291,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.butler.start_task(task_name=operations.TaskName.CLEAN_OLD_BUNDLES) res = s.butler.start_task(task_name=operations.TaskName.CLEAN_OLD_BUNDLES)
@@ -261,7 +313,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_available_clients() res = s.server.get_available_clients()
@@ -279,7 +335,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_companions_data() res = s.plex.get_companions_data()
@@ -297,7 +357,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_devices() res = s.server.get_devices()
@@ -315,7 +379,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_user_friends() res = s.plex.get_user_friends()
@@ -332,7 +400,11 @@ actions:
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_geo_data() res = s.plex.get_geo_data()
@@ -350,7 +422,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_home_data() res = s.plex.get_home_data()
@@ -368,7 +444,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.hubs.get_global_hubs() res = s.hubs.get_global_hubs()
@@ -386,7 +466,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.search.perform_search(query="dylan", limit=5) res = s.search.perform_search(query="dylan", limit=5)
@@ -404,7 +488,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.search.perform_voice_search(query="dead+poop", limit=5) res = s.search.perform_voice_search(query="dead+poop", limit=5)
@@ -422,7 +510,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.hubs.get_library_hubs(section_id=6728.76) res = s.hubs.get_library_hubs(section_id=6728.76)
@@ -439,7 +531,11 @@ actions:
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_identity() res = s.server.get_server_identity()
@@ -458,7 +554,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.TWO, include_guids=1) res = s.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.TWO, include_guids=1)
@@ -476,7 +576,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_file_hash(url="file://C:\Image.png&type=13") res = s.library.get_file_hash(url="file://C:\Image.png&type=13")
@@ -494,7 +598,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_meta_data_by_rating_key(rating_key=9518) res = s.library.get_meta_data_by_rating_key(rating_key=9518)
@@ -512,7 +620,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.media.get_banner_image(request={ res = s.media.get_banner_image(request={
@@ -537,7 +649,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_metadata_children(rating_key=1539.14, include_elements="Stream") res = s.library.get_metadata_children(rating_key=1539.14, include_elements="Stream")
@@ -555,7 +671,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.media.get_thumb_image(request={ res = s.media.get_thumb_image(request={
@@ -580,7 +700,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_on_deck() res = s.library.get_on_deck()
@@ -598,7 +722,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_recently_added(x_plex_container_start=0, x_plex_container_size=50) res = s.library.get_recently_added(x_plex_container_start=0, x_plex_container_size=50)
@@ -616,7 +744,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_all_libraries() res = s.library.get_all_libraries()
@@ -635,7 +767,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.watchlist.get_watch_list(request={ res = s.watchlist.get_watch_list(request={
@@ -658,7 +794,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.delete_library(section_key=9518) res = s.library.delete_library(section_key=9518)
@@ -676,7 +816,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_library_details(section_key=9518) res = s.library.get_library_details(section_key=9518)
@@ -695,7 +839,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_refresh_library_metadata(section_key=9518, force=operations.Force.ONE) res = s.library.get_refresh_library_metadata(section_key=9518, force=operations.Force.ONE)
@@ -714,7 +862,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_search_library(section_key=9518, type_=operations.QueryParamType.TWO) res = s.library.get_search_library(section_key=9518, type_=operations.QueryParamType.TWO)
@@ -733,7 +885,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_library_items(request={ res = s.library.get_library_items(request={
@@ -760,7 +916,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.log.log_line(level=operations.Level.THREE, message="Test log message", source="Postman") res = s.log.log_line(level=operations.Level.THREE, message="Test log message", source="Postman")
@@ -778,7 +938,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.log.log_multi_line(request="level=4&message=Test%20message%201&source=postman\n" + res = s.log.log_multi_line(request="level=4&message=Test%20message%201&source=postman\n" +
@@ -798,7 +962,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.log.enable_paper_trail() res = s.log.enable_paper_trail()
@@ -816,7 +984,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_media_providers(x_plex_token="CV5xoxjTpFKUzBTShsaf") res = s.server.get_media_providers(x_plex_token="CV5xoxjTpFKUzBTShsaf")
@@ -834,7 +1006,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_my_plex_account() res = s.server.get_my_plex_account()
@@ -853,7 +1029,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_resized_photo(request={ res = s.server.get_resized_photo(request={
@@ -878,10 +1058,14 @@ actions:
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_pin(x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", x_plex_product="Plex Web") res = s.plex.get_pin(request={})
if res.auth_pin_container is not None: if res.auth_pin_container is not None:
# handle response # handle response
@@ -895,10 +1079,14 @@ actions:
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_token_by_pin_id(pin_id=408895, x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40") res = s.plex.get_token_by_pin_id(pin_id=408895, client_id="gcgzw5rz2xovp84b4vha3a40")
if res.auth_pin_container is not None: if res.auth_pin_container is not None:
# handle response # handle response
@@ -913,7 +1101,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.get_playlists() res = s.playlists.get_playlists()
@@ -932,7 +1124,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.create_playlist(request={ res = s.playlists.create_playlist(request={
@@ -956,7 +1152,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.upload_playlist(path="/home/barkley/playlist.m3u", force=operations.QueryParamForce.ZERO) res = s.playlists.upload_playlist(path="/home/barkley/playlist.m3u", force=operations.QueryParamForce.ZERO)
@@ -974,7 +1174,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.delete_playlist(playlist_id=216.22) res = s.playlists.delete_playlist(playlist_id=216.22)
@@ -992,7 +1196,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.get_playlist(playlist_id=4109.48) res = s.playlists.get_playlist(playlist_id=4109.48)
@@ -1010,7 +1218,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.update_playlist(playlist_id=3915) res = s.playlists.update_playlist(playlist_id=3915)
@@ -1028,7 +1240,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.clear_playlist_contents(playlist_id=1893.18) res = s.playlists.clear_playlist_contents(playlist_id=1893.18)
@@ -1047,7 +1263,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.get_playlist_contents(playlist_id=5004.46, type_=operations.GetPlaylistContentsQueryParamType.TWO) res = s.playlists.get_playlist_contents(playlist_id=5004.46, type_=operations.GetPlaylistContentsQueryParamType.TWO)
@@ -1065,7 +1285,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.add_playlist_contents(playlist_id=8502.01, uri="server://12345/com.plexapp.plugins.library/library/metadata/1", play_queue_id=123) res = s.playlists.add_playlist_contents(playlist_id=8502.01, uri="server://12345/com.plexapp.plugins.library/library/metadata/1", play_queue_id=123)
@@ -1084,10 +1308,14 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_server_resources(x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", include_https=operations.IncludeHTTPS.ONE, include_relay=operations.IncludeRelay.ONE, include_i_pv6=operations.IncludeIPv6.ONE) res = s.plex.get_server_resources(client_id="gcgzw5rz2xovp84b4vha3a40", include_https=operations.IncludeHTTPS.ONE, include_relay=operations.IncludeRelay.ONE, include_i_pv6=operations.IncludeIPv6.ONE)
if res.plex_devices is not None: if res.plex_devices is not None:
# handle response # handle response
@@ -1102,7 +1330,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.search.get_search_results(query="110") res = s.search.get_search_results(query="110")
@@ -1120,7 +1352,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.authentication.get_source_connection_information(source="server://client-identifier") res = s.authentication.get_source_connection_information(source="server://client-identifier")
@@ -1139,7 +1375,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.authentication.get_transient_token(type_=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL) res = s.authentication.get_transient_token(type_=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL)
@@ -1157,7 +1397,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_list() res = s.server.get_server_list()
@@ -1175,7 +1419,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.statistics.get_bandwidth_statistics(timespan=4) res = s.statistics.get_bandwidth_statistics(timespan=4)
@@ -1193,7 +1441,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.statistics.get_statistics(timespan=4) res = s.statistics.get_statistics(timespan=4)
@@ -1211,7 +1463,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.statistics.get_resources_statistics(timespan=4) res = s.statistics.get_resources_statistics(timespan=4)
@@ -1229,7 +1485,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.sessions.get_sessions() res = s.sessions.get_sessions()
@@ -1247,7 +1507,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.sessions.get_session_history(sort="viewedAt:desc", account_id=1, filter_={}, library_section_id=12) res = s.sessions.get_session_history(sort="viewedAt:desc", account_id=1, filter_={}, library_section_id=12)
@@ -1265,7 +1529,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.sessions.get_transcode_sessions() res = s.sessions.get_transcode_sessions()
@@ -1283,7 +1551,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.sessions.stop_transcode_session(session_key="zz7llzqlx8w9vnrsbnwhbmep") res = s.sessions.stop_transcode_session(session_key="zz7llzqlx8w9vnrsbnwhbmep")
@@ -1302,7 +1574,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ONE) res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ONE)
@@ -1321,7 +1597,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.updater.check_for_updates(download=operations.Download.ONE) res = s.updater.check_for_updates(download=operations.Download.ONE)
@@ -1339,7 +1619,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.updater.get_update_status() res = s.updater.get_update_status()
@@ -1357,7 +1641,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.authentication.get_token_details() res = s.authentication.get_token_details()
@@ -1374,10 +1662,14 @@ actions:
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.authentication.post_users_sign_in_data(x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", request_body={ res = s.authentication.post_users_sign_in_data(client_id="gcgzw5rz2xovp84b4vha3a40", request_body={
"login": "username@email.com", "login": "username@email.com",
"password": "password123", "password": "password123",
"verification_code": "123456", "verification_code": "123456",
@@ -1396,7 +1688,11 @@ actions:
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.video.start_universal_transcode(request={ res = s.video.start_universal_transcode(request={

View File

@@ -5,4 +5,8 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 |
| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux |

View File

@@ -12,7 +12,7 @@ Geo location data
| `country` | *str* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands | | `country` | *str* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `city` | *str* | :heavy_check_mark: | The name of the city. | Amsterdam | | `city` | *str* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `time_zone` | *str* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas | | `time_zone` | *str* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *int* | :heavy_check_mark: | The postal code of the location. | 802 | | `postal_code` | *str* | :heavy_check_mark: | The postal code of the location. | 802 |
| `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas | | `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 | | `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |
| `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true | | `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |

View File

@@ -12,7 +12,7 @@ Geo location data
| `country` | *str* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands | | `country` | *str* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `city` | *str* | :heavy_check_mark: | The name of the city. | Amsterdam | | `city` | *str* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `time_zone` | *str* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas | | `time_zone` | *str* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *int* | :heavy_check_mark: | The postal code of the location. | 802 | | `postal_code` | *str* | :heavy_check_mark: | The postal code of the location. | 802 |
| `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas | | `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 | | `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |
| `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true | | `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |

View File

@@ -9,13 +9,13 @@ Requests a new pin id used in the authentication flow
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 308667304 | | `id` | *int* | :heavy_check_mark: | N/A | 308667304 |
| `code` | *str* | :heavy_check_mark: | N/A | 7RQZ | | `code` | *str* | :heavy_check_mark: | N/A | 7RQZ |
| `product` | *str* | :heavy_check_mark: | N/A | 0 | | `product` | *str* | :heavy_check_mark: | N/A | Tautulli |
| `qr` | *str* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ | | `qr` | *str* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
| `client_identifier` | *str* | :heavy_check_mark: | The X-Client-Identifier used in the request | | | `client_identifier` | *str* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
| `location` | [operations.GeoData](../../models/operations/geodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} | | `location` | [operations.GeoData](../../models/operations/geodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z | | `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z | | `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `trusted` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `trusted` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `expires_in` | *Optional[int]* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 | | `expires_in` | *Optional[int]* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `auth_token` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | | | `auth_token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
| `new_registration` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | | | `new_registration` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | |

View File

@@ -5,4 +5,8 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 |
| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome |

View File

@@ -6,5 +6,8 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `strong` | *Optional[bool]* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | | | `strong` | *Optional[bool]* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `x_plex_product` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | | `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web |
| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux |
| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 |
| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome |

View File

@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |

View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `include_https` | [Optional[operations.IncludeHTTPS]](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | | `include_https` | [Optional[operations.IncludeHTTPS]](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [Optional[operations.IncludeRelay]](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 | | `include_relay` | [Optional[operations.IncludeRelay]](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | | `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |

View File

@@ -9,13 +9,13 @@ The Pin with a non-null authToken when it has been verified by the user
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *int* | :heavy_check_mark: | N/A | 308667304 | | `id` | *int* | :heavy_check_mark: | N/A | 308667304 |
| `code` | *str* | :heavy_check_mark: | N/A | 7RQZ | | `code` | *str* | :heavy_check_mark: | N/A | 7RQZ |
| `product` | *str* | :heavy_check_mark: | N/A | 0 | | `product` | *str* | :heavy_check_mark: | N/A | Tautulli |
| `qr` | *str* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ | | `qr` | *str* | :heavy_check_mark: | N/A | https://plex.tv/api/v2/pins/qr/7RQZ |
| `client_identifier` | *str* | :heavy_check_mark: | The X-Client-Identifier used in the request | | | `client_identifier` | *str* | :heavy_check_mark: | The X-Client-Identifier used in the request | Tautulli |
| `location` | [operations.GetTokenByPinIDGeoData](../../models/operations/gettokenbypinidgeodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} | | `location` | [operations.GetTokenByPinIDGeoData](../../models/operations/gettokenbypinidgeodata.md) | :heavy_check_mark: | Geo location data | {<br/>"code": "VI",<br/>"continent_code": "NA",<br/>"country": "United States Virgin Islands",<br/>"city": "Amsterdam",<br/>"european_union_member": true,<br/>"time_zone": "America/St_Thomas",<br/>"postal_code": 802,<br/>"in_privacy_restricted_country": true,<br/>"in_privacy_restricted_region": true,<br/>"subdivisions": "Saint Thomas",<br/>"coordinates": "18.3381, -64.8941"<br/>} |
| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z | | `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:03:05Z |
| `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z | | `expires_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | 2024-07-16T17:18:05Z |
| `trusted` | *Optional[bool]* | :heavy_minus_sign: | N/A | | | `trusted` | *Optional[bool]* | :heavy_minus_sign: | N/A | |
| `expires_in` | *Optional[int]* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 | | `expires_in` | *Optional[int]* | :heavy_minus_sign: | The number of seconds this pin expires, by default 900 seconds | 876 |
| `auth_token` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | | | `auth_token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | gcgzw5rz2xovp84b4vha3a40 |
| `new_registration` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | | | `new_registration` | *OptionalNullable[Any]* | :heavy_minus_sign: | N/A | |

View File

@@ -12,7 +12,7 @@ Geo location data
| `country` | *str* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands | | `country` | *str* | :heavy_check_mark: | The official name of the country. | United States Virgin Islands |
| `city` | *str* | :heavy_check_mark: | The name of the city. | Amsterdam | | `city` | *str* | :heavy_check_mark: | The name of the city. | Amsterdam |
| `time_zone` | *str* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas | | `time_zone` | *str* | :heavy_check_mark: | The time zone of the country. | America/St_Thomas |
| `postal_code` | *int* | :heavy_check_mark: | The postal code of the location. | 802 | | `postal_code` | *str* | :heavy_check_mark: | The postal code of the location. | 802 |
| `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas | | `subdivisions` | *str* | :heavy_check_mark: | The name of the primary administrative subdivision. | Saint Thomas |
| `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 | | `coordinates` | *str* | :heavy_check_mark: | The geographical coordinates (latitude, longitude) of the location. | 18.3381, -64.8941 |
| `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true | | `european_union_member` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the country is a member of the European Union. | true |

View File

@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |

View File

@@ -6,4 +6,4 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for | | | `pin_id` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |

View File

@@ -5,4 +5,4 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |

View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `request_body` | [Optional[operations.PostUsersSignInDataRequestBody]](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | | `request_body` | [Optional[operations.PostUsersSignInDataRequestBody]](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |

View File

@@ -28,7 +28,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.activities.get_server_activities() res = s.activities.get_server_activities()
@@ -69,7 +73,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.activities.cancel_server_activities(activity_uuid="25b71ed5-0f9d-461c-baa7-d404e9e10d3e") res = s.activities.cancel_server_activities(activity_uuid="25b71ed5-0f9d-461c-baa7-d404e9e10d3e")

View File

@@ -26,7 +26,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.authentication.get_transient_token(type_=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL) res = s.authentication.get_transient_token(type_=operations.GetTransientTokenQueryParamType.DELEGATION, scope=operations.Scope.ALL)
@@ -71,7 +75,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.authentication.get_source_connection_information(source="server://client-identifier") res = s.authentication.get_source_connection_information(source="server://client-identifier")
@@ -113,7 +121,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.authentication.get_token_details() res = s.authentication.get_token_details()
@@ -154,10 +166,14 @@ Sign in user with username and password and return user data with Plex authentic
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.authentication.post_users_sign_in_data(x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", request_body={ res = s.authentication.post_users_sign_in_data(client_id="gcgzw5rz2xovp84b4vha3a40", request_body={
"login": "username@email.com", "login": "username@email.com",
"password": "password123", "password": "password123",
"verification_code": "123456", "verification_code": "123456",
@@ -173,7 +189,7 @@ if res.user_plex_account is not None:
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `request_body` | [Optional[operations.PostUsersSignInDataRequestBody]](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | | `request_body` | [Optional[operations.PostUsersSignInDataRequestBody]](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 | | `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |

View File

@@ -25,7 +25,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.butler.get_butler_tasks() res = s.butler.get_butler_tasks()
@@ -71,7 +75,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.butler.start_all_tasks() res = s.butler.start_all_tasks()
@@ -113,7 +121,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.butler.stop_all_tasks() res = s.butler.stop_all_tasks()
@@ -160,7 +172,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.butler.start_task(task_name=operations.TaskName.CLEAN_OLD_BUNDLES) res = s.butler.start_task(task_name=operations.TaskName.CLEAN_OLD_BUNDLES)
@@ -204,7 +220,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.butler.stop_task(task_name=operations.PathParamTaskName.BACKUP_DATABASE) res = s.butler.stop_task(task_name=operations.PathParamTaskName.BACKUP_DATABASE)

View File

@@ -22,7 +22,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.hubs.get_global_hubs() res = s.hubs.get_global_hubs()
@@ -66,7 +70,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.hubs.get_library_hubs(section_id=6728.76) res = s.hubs.get_library_hubs(section_id=6728.76)

View File

@@ -32,7 +32,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_file_hash(url="file://C:\Image.png&type=13") res = s.library.get_file_hash(url="file://C:\Image.png&type=13")
@@ -76,7 +80,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_recently_added(x_plex_container_start=0, x_plex_container_size=50) res = s.library.get_recently_added(x_plex_container_start=0, x_plex_container_size=50)
@@ -125,7 +133,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_all_libraries() res = s.library.get_all_libraries()
@@ -205,7 +217,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_library_details(section_key=9518) res = s.library.get_library_details(section_key=9518)
@@ -248,7 +264,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.delete_library(section_key=9518) res = s.library.delete_library(section_key=9518)
@@ -311,7 +331,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_library_items(request={ res = s.library.get_library_items(request={
@@ -363,7 +387,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_refresh_library_metadata(section_key=9518, force=operations.Force.ONE) res = s.library.get_refresh_library_metadata(section_key=9518, force=operations.Force.ONE)
@@ -425,7 +453,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_search_library(section_key=9518, type_=operations.QueryParamType.TWO) res = s.library.get_search_library(section_key=9518, type_=operations.QueryParamType.TWO)
@@ -469,7 +501,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_meta_data_by_rating_key(rating_key=9518) res = s.library.get_meta_data_by_rating_key(rating_key=9518)
@@ -512,7 +548,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_metadata_children(rating_key=1539.14, include_elements="Stream") res = s.library.get_metadata_children(rating_key=1539.14, include_elements="Stream")
@@ -557,7 +597,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.TWO, include_guids=1) res = s.library.get_top_watched_content(type_=operations.GetTopWatchedContentQueryParamType.TWO, include_guids=1)
@@ -601,7 +645,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.library.get_on_deck() res = s.library.get_on_deck()

View File

@@ -25,7 +25,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.log.log_line(level=operations.Level.THREE, message="Test log message", source="Postman") res = s.log.log_line(level=operations.Level.THREE, message="Test log message", source="Postman")
@@ -90,7 +94,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.log.log_multi_line(request="level=4&message=Test%20message%201&source=postman\n" + res = s.log.log_multi_line(request="level=4&message=Test%20message%201&source=postman\n" +
@@ -135,7 +143,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.log.enable_paper_trail() res = s.log.enable_paper_trail()

View File

@@ -25,7 +25,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.media.mark_played(key=59398) res = s.media.mark_played(key=59398)
@@ -67,7 +71,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.media.mark_unplayed(key=59398) res = s.media.mark_unplayed(key=59398)
@@ -110,7 +118,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.media.update_play_progress(key="<key>", time=90000, state="played") res = s.media.update_play_progress(key="<key>", time=90000, state="played")
@@ -154,7 +166,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.media.get_banner_image(request={ res = s.media.get_banner_image(request={
@@ -203,7 +219,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.media.get_thumb_image(request={ res = s.media.get_thumb_image(request={

View File

@@ -36,7 +36,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.create_playlist(request={ res = s.playlists.create_playlist(request={
@@ -83,7 +87,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.get_playlists() res = s.playlists.get_playlists()
@@ -128,7 +136,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.get_playlist(playlist_id=4109.48) res = s.playlists.get_playlist(playlist_id=4109.48)
@@ -171,7 +183,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.delete_playlist(playlist_id=216.22) res = s.playlists.delete_playlist(playlist_id=216.22)
@@ -214,7 +230,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.update_playlist(playlist_id=3915) res = s.playlists.update_playlist(playlist_id=3915)
@@ -263,7 +283,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.get_playlist_contents(playlist_id=5004.46, type_=operations.GetPlaylistContentsQueryParamType.TWO) res = s.playlists.get_playlist_contents(playlist_id=5004.46, type_=operations.GetPlaylistContentsQueryParamType.TWO)
@@ -307,7 +331,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.clear_playlist_contents(playlist_id=1893.18) res = s.playlists.clear_playlist_contents(playlist_id=1893.18)
@@ -351,7 +379,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.add_playlist_contents(playlist_id=8502.01, uri="server://12345/com.plexapp.plugins.library/library/metadata/1", play_queue_id=123) res = s.playlists.add_playlist_contents(playlist_id=8502.01, uri="server://12345/com.plexapp.plugins.library/library/metadata/1", play_queue_id=123)
@@ -397,7 +429,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.playlists.upload_playlist(path="/home/barkley/playlist.m3u", force=operations.QueryParamForce.ZERO) res = s.playlists.upload_playlist(path="/home/barkley/playlist.m3u", force=operations.QueryParamForce.ZERO)

View File

@@ -27,7 +27,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_companions_data() res = s.plex.get_companions_data()
@@ -69,7 +73,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_user_friends() res = s.plex.get_user_friends()
@@ -110,7 +118,11 @@ Returns the geolocation and locale data of the caller
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_geo_data() res = s.plex.get_geo_data()
@@ -152,7 +164,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_home_data() res = s.plex.get_home_data()
@@ -194,10 +210,14 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_server_resources(x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", include_https=operations.IncludeHTTPS.ONE, include_relay=operations.IncludeRelay.ONE, include_i_pv6=operations.IncludeIPv6.ONE) res = s.plex.get_server_resources(client_id="gcgzw5rz2xovp84b4vha3a40", include_https=operations.IncludeHTTPS.ONE, include_relay=operations.IncludeRelay.ONE, include_i_pv6=operations.IncludeIPv6.ONE)
if res.plex_devices is not None: if res.plex_devices is not None:
# handle response # handle response
@@ -209,7 +229,7 @@ if res.plex_devices is not None:
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `include_https` | [Optional[operations.IncludeHTTPS]](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | | `include_https` | [Optional[operations.IncludeHTTPS]](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `include_relay` | [Optional[operations.IncludeRelay]](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 | | `include_relay` | [Optional[operations.IncludeRelay]](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | | `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
@@ -231,7 +251,7 @@ if res.plex_devices is not None:
## get_pin ## get_pin
Retrieve a Pin from Plex.tv for authentication flows Retrieve a Pin ID from Plex.tv to use for authentication flows
### Example Usage ### Example Usage
@@ -239,10 +259,14 @@ Retrieve a Pin from Plex.tv for authentication flows
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_pin(x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", x_plex_product="Plex Web") res = s.plex.get_pin(request={})
if res.auth_pin_container is not None: if res.auth_pin_container is not None:
# handle response # handle response
@@ -252,13 +276,11 @@ if res.auth_pin_container is not None:
### Parameters ### Parameters
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `strong` | *Optional[bool]* | :heavy_minus_sign: | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/> | | | `request` | [operations.GetPinRequest](../../models/operations/getpinrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
| `x_plex_product` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | | `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response ### Response
@@ -282,10 +304,14 @@ Retrieve an Access Token from Plex.tv after the Pin has been authenticated
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.plex.get_token_by_pin_id(pin_id=408895, x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40") res = s.plex.get_token_by_pin_id(pin_id=408895, client_id="gcgzw5rz2xovp84b4vha3a40")
if res.auth_pin_container is not None: if res.auth_pin_container is not None:
# handle response # handle response
@@ -298,7 +324,7 @@ if res.auth_pin_container is not None:
| Parameter | Type | Required | Description | Example | | Parameter | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for | | | `pin_id` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `x_plex_client_identifier` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | gcgzw5rz2xovp84b4vha3a40 |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 | | `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |

View File

@@ -35,7 +35,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.search.perform_search(query="dylan", limit=5) res = s.search.perform_search(query="dylan", limit=5)
@@ -83,7 +87,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.search.perform_voice_search(query="dead+poop", limit=5) res = s.search.perform_voice_search(query="dead+poop", limit=5)
@@ -127,7 +135,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.search.get_search_results(query="110") res = s.search.get_search_results(query="110")

View File

@@ -29,7 +29,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_capabilities() res = s.server.get_server_capabilities()
@@ -70,7 +74,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_preferences() res = s.server.get_server_preferences()
@@ -111,7 +119,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_available_clients() res = s.server.get_available_clients()
@@ -152,7 +164,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_devices() res = s.server.get_devices()
@@ -192,7 +208,11 @@ This request is useful to determine if the server is online or offline
from plex_api_client import PlexAPI from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_identity() res = s.server.get_server_identity()
@@ -232,7 +252,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_my_plex_account() res = s.server.get_my_plex_account()
@@ -275,7 +299,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_resized_photo(request={ res = s.server.get_resized_photo(request={
@@ -325,7 +353,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_media_providers(x_plex_token="CV5xoxjTpFKUzBTShsaf") res = s.server.get_media_providers(x_plex_token="CV5xoxjTpFKUzBTShsaf")
@@ -367,7 +399,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.server.get_server_list() res = s.server.get_server_list()

View File

@@ -24,7 +24,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.sessions.get_sessions() res = s.sessions.get_sessions()
@@ -65,7 +69,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.sessions.get_session_history(sort="viewedAt:desc", account_id=1, filter_={}, library_section_id=12) res = s.sessions.get_session_history(sort="viewedAt:desc", account_id=1, filter_={}, library_section_id=12)
@@ -110,7 +118,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.sessions.get_transcode_sessions() res = s.sessions.get_transcode_sessions()
@@ -151,7 +163,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.sessions.stop_transcode_session(session_key="zz7llzqlx8w9vnrsbnwhbmep") res = s.sessions.stop_transcode_session(session_key="zz7llzqlx8w9vnrsbnwhbmep")

View File

@@ -23,7 +23,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.statistics.get_statistics(timespan=4) res = s.statistics.get_statistics(timespan=4)
@@ -65,7 +69,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.statistics.get_resources_statistics(timespan=4) res = s.statistics.get_resources_statistics(timespan=4)
@@ -107,7 +115,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.statistics.get_bandwidth_statistics(timespan=4) res = s.statistics.get_bandwidth_statistics(timespan=4)

View File

@@ -24,7 +24,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.updater.get_update_status() res = s.updater.get_update_status()
@@ -66,7 +70,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.updater.check_for_updates(download=operations.Download.ONE) res = s.updater.check_for_updates(download=operations.Download.ONE)
@@ -110,7 +118,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ONE) res = s.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ONE)

View File

@@ -23,7 +23,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.video.get_timeline(request={ res = s.video.get_timeline(request={
@@ -76,7 +80,11 @@ from plex_api_client import PlexAPI
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.video.start_universal_transcode(request={ res = s.video.start_universal_transcode(request={

View File

@@ -22,7 +22,11 @@ from plex_api_client.models import operations
s = PlexAPI( s = PlexAPI(
access_token="<YOUR_API_KEY_HERE>", access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier="gcgzw5rz2xovp84b4vha3a40", client_id="gcgzw5rz2xovp84b4vha3a40",
client_name="Plex Web",
client_version="4.133.0",
client_platform="Chrome",
device_name="Linux",
) )
res = s.watchlist.get_watch_list(request={ res = s.watchlist.get_watch_list(request={

View File

@@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "plex-api-client" name = "plex-api-client"
version = "0.12.1" version = "0.12.2"
description = "Python Client SDK Generated by Speakeasy" description = "Python Client SDK Generated by Speakeasy"
authors = ["Speakeasy",] authors = ["Speakeasy",]
readme = "README-PYPI.md" readme = "README-PYPI.md"

View File

@@ -592,7 +592,7 @@ class Authentication(BaseSDK):
def post_users_sign_in_data( def post_users_sign_in_data(
self, self,
*, *,
x_plex_client_identifier: Optional[str] = None, client_id: Optional[str] = None,
request_body: Optional[ request_body: Optional[
Union[ Union[
operations.PostUsersSignInDataRequestBody, operations.PostUsersSignInDataRequestBody,
@@ -607,7 +607,7 @@ class Authentication(BaseSDK):
Sign in user with username and password and return user data with Plex authentication token Sign in user with username and password and return user data with Plex authentication token
:param x_plex_client_identifier: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) :param client_id: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device)
:param request_body: Login credentials :param request_body: Login credentials
:param retries: Override the default retry configuration for this method :param retries: Override the default retry configuration for this method
:param server_url: Override the default server URL for this method :param server_url: Override the default server URL for this method
@@ -624,7 +624,7 @@ class Authentication(BaseSDK):
base_url = operations.POST_USERS_SIGN_IN_DATA_SERVERS[0] base_url = operations.POST_USERS_SIGN_IN_DATA_SERVERS[0]
request = operations.PostUsersSignInDataRequest( request = operations.PostUsersSignInDataRequest(
x_plex_client_identifier=x_plex_client_identifier, client_id=client_id,
request_body=utils.get_pydantic_model( request_body=utils.get_pydantic_model(
request_body, Optional[operations.PostUsersSignInDataRequestBody] request_body, Optional[operations.PostUsersSignInDataRequestBody]
), ),
@@ -642,7 +642,7 @@ class Authentication(BaseSDK):
user_agent_header="user-agent", user_agent_header="user-agent",
accept_header_value="application/json", accept_header_value="application/json",
_globals=operations.PostUsersSignInDataGlobals( _globals=operations.PostUsersSignInDataGlobals(
x_plex_client_identifier=self.sdk_configuration.globals.x_plex_client_identifier, client_id=self.sdk_configuration.globals.client_id,
), ),
get_serialized_body=lambda: utils.serialize_request_body( get_serialized_body=lambda: utils.serialize_request_body(
request.request_body, request.request_body,
@@ -712,7 +712,7 @@ class Authentication(BaseSDK):
async def post_users_sign_in_data_async( async def post_users_sign_in_data_async(
self, self,
*, *,
x_plex_client_identifier: Optional[str] = None, client_id: Optional[str] = None,
request_body: Optional[ request_body: Optional[
Union[ Union[
operations.PostUsersSignInDataRequestBody, operations.PostUsersSignInDataRequestBody,
@@ -727,7 +727,7 @@ class Authentication(BaseSDK):
Sign in user with username and password and return user data with Plex authentication token Sign in user with username and password and return user data with Plex authentication token
:param x_plex_client_identifier: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) :param client_id: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device)
:param request_body: Login credentials :param request_body: Login credentials
:param retries: Override the default retry configuration for this method :param retries: Override the default retry configuration for this method
:param server_url: Override the default server URL for this method :param server_url: Override the default server URL for this method
@@ -744,7 +744,7 @@ class Authentication(BaseSDK):
base_url = operations.POST_USERS_SIGN_IN_DATA_SERVERS[0] base_url = operations.POST_USERS_SIGN_IN_DATA_SERVERS[0]
request = operations.PostUsersSignInDataRequest( request = operations.PostUsersSignInDataRequest(
x_plex_client_identifier=x_plex_client_identifier, client_id=client_id,
request_body=utils.get_pydantic_model( request_body=utils.get_pydantic_model(
request_body, Optional[operations.PostUsersSignInDataRequestBody] request_body, Optional[operations.PostUsersSignInDataRequestBody]
), ),
@@ -762,7 +762,7 @@ class Authentication(BaseSDK):
user_agent_header="user-agent", user_agent_header="user-agent",
accept_header_value="application/json", accept_header_value="application/json",
_globals=operations.PostUsersSignInDataGlobals( _globals=operations.PostUsersSignInDataGlobals(
x_plex_client_identifier=self.sdk_configuration.globals.x_plex_client_identifier, client_id=self.sdk_configuration.globals.client_id,
), ),
get_serialized_body=lambda: utils.serialize_request_body( get_serialized_body=lambda: utils.serialize_request_body(
request.request_body, request.request_body,

View File

@@ -9,16 +9,20 @@ from typing_extensions import Annotated, NotRequired
class GlobalsTypedDict(TypedDict): class GlobalsTypedDict(TypedDict):
x_plex_client_identifier: NotRequired[str] client_id: NotRequired[str]
r"""The unique identifier for the client application r"""The unique identifier for the client application
This is used to track the client application and its usage This is used to track the client application and its usage
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
""" """
client_name: NotRequired[str]
client_version: NotRequired[str]
client_platform: NotRequired[str]
device_name: NotRequired[str]
class Globals(BaseModel): class Globals(BaseModel):
x_plex_client_identifier: Annotated[ client_id: Annotated[
Optional[str], Optional[str],
pydantic.Field(alias="X-Plex-Client-Identifier"), pydantic.Field(alias="X-Plex-Client-Identifier"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -28,3 +32,27 @@ class Globals(BaseModel):
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
""" """
client_name: Annotated[
Optional[str],
pydantic.Field(alias="X-Plex-Product"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None
client_version: Annotated[
Optional[str],
pydantic.Field(alias="X-Plex-Version"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None
client_platform: Annotated[
Optional[str],
pydantic.Field(alias="X-Plex-Platform"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None
device_name: Annotated[
Optional[str],
pydantic.Field(alias="X-Plex-Device"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None

View File

@@ -17,7 +17,7 @@ GET_SERVER_RESOURCES_SERVERS = [
class GetServerResourcesGlobalsTypedDict(TypedDict): class GetServerResourcesGlobalsTypedDict(TypedDict):
x_plex_client_identifier: NotRequired[str] client_id: NotRequired[str]
r"""The unique identifier for the client application r"""The unique identifier for the client application
This is used to track the client application and its usage This is used to track the client application and its usage
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
@@ -26,7 +26,7 @@ class GetServerResourcesGlobalsTypedDict(TypedDict):
class GetServerResourcesGlobals(BaseModel): class GetServerResourcesGlobals(BaseModel):
x_plex_client_identifier: Annotated[ client_id: Annotated[
Optional[str], Optional[str],
pydantic.Field(alias="X-Plex-Client-Identifier"), pydantic.Field(alias="X-Plex-Client-Identifier"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -63,7 +63,7 @@ class IncludeIPv6(int, Enum):
class GetServerResourcesRequestTypedDict(TypedDict): class GetServerResourcesRequestTypedDict(TypedDict):
x_plex_client_identifier: NotRequired[str] client_id: NotRequired[str]
r"""The unique identifier for the client application r"""The unique identifier for the client application
This is used to track the client application and its usage This is used to track the client application and its usage
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
@@ -81,7 +81,7 @@ class GetServerResourcesRequestTypedDict(TypedDict):
class GetServerResourcesRequest(BaseModel): class GetServerResourcesRequest(BaseModel):
x_plex_client_identifier: Annotated[ client_id: Annotated[
Optional[str], Optional[str],
pydantic.Field(alias="X-Plex-Client-Identifier"), pydantic.Field(alias="X-Plex-Client-Identifier"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),

View File

@@ -24,7 +24,7 @@ class GetGeoDataGeoDataTypedDict(TypedDict):
r"""The name of the city.""" r"""The name of the city."""
time_zone: str time_zone: str
r"""The time zone of the country.""" r"""The time zone of the country."""
postal_code: int postal_code: str
r"""The postal code of the location.""" r"""The postal code of the location."""
subdivisions: str subdivisions: str
r"""The name of the primary administrative subdivision.""" r"""The name of the primary administrative subdivision."""
@@ -56,7 +56,7 @@ class GetGeoDataGeoData(BaseModel):
time_zone: str time_zone: str
r"""The time zone of the country.""" r"""The time zone of the country."""
postal_code: int postal_code: str
r"""The postal code of the location.""" r"""The postal code of the location."""
subdivisions: str subdivisions: str

View File

@@ -22,16 +22,20 @@ GET_PIN_SERVERS = [
class GetPinGlobalsTypedDict(TypedDict): class GetPinGlobalsTypedDict(TypedDict):
x_plex_client_identifier: NotRequired[str] client_id: NotRequired[str]
r"""The unique identifier for the client application r"""The unique identifier for the client application
This is used to track the client application and its usage This is used to track the client application and its usage
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
""" """
client_name: NotRequired[str]
device_name: NotRequired[str]
client_version: NotRequired[str]
client_platform: NotRequired[str]
class GetPinGlobals(BaseModel): class GetPinGlobals(BaseModel):
x_plex_client_identifier: Annotated[ client_id: Annotated[
Optional[str], Optional[str],
pydantic.Field(alias="X-Plex-Client-Identifier"), pydantic.Field(alias="X-Plex-Client-Identifier"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -42,6 +46,30 @@ class GetPinGlobals(BaseModel):
""" """
client_name: Annotated[
Optional[str],
pydantic.Field(alias="X-Plex-Product"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None
device_name: Annotated[
Optional[str],
pydantic.Field(alias="X-Plex-Device"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None
client_version: Annotated[
Optional[str],
pydantic.Field(alias="X-Plex-Version"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None
client_platform: Annotated[
Optional[str],
pydantic.Field(alias="X-Plex-Platform"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None
class GetPinRequestTypedDict(TypedDict): class GetPinRequestTypedDict(TypedDict):
strong: NotRequired[bool] strong: NotRequired[bool]
@@ -50,13 +78,16 @@ class GetPinRequestTypedDict(TypedDict):
Non-Strong codes are used for `Plex.tv/link` Non-Strong codes are used for `Plex.tv/link`
""" """
x_plex_client_identifier: NotRequired[str] client_id: NotRequired[str]
r"""The unique identifier for the client application r"""The unique identifier for the client application
This is used to track the client application and its usage This is used to track the client application and its usage
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
""" """
x_plex_product: NotRequired[str] client_name: NotRequired[str]
device_name: NotRequired[str]
client_version: NotRequired[str]
client_platform: NotRequired[str]
class GetPinRequest(BaseModel): class GetPinRequest(BaseModel):
@@ -70,7 +101,7 @@ class GetPinRequest(BaseModel):
""" """
x_plex_client_identifier: Annotated[ client_id: Annotated[
Optional[str], Optional[str],
pydantic.Field(alias="X-Plex-Client-Identifier"), pydantic.Field(alias="X-Plex-Client-Identifier"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -81,12 +112,30 @@ class GetPinRequest(BaseModel):
""" """
x_plex_product: Annotated[ client_name: Annotated[
Optional[str], Optional[str],
pydantic.Field(alias="X-Plex-Product"), pydantic.Field(alias="X-Plex-Product"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None ] = None
device_name: Annotated[
Optional[str],
pydantic.Field(alias="X-Plex-Device"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None
client_version: Annotated[
Optional[str],
pydantic.Field(alias="X-Plex-Version"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None
client_platform: Annotated[
Optional[str],
pydantic.Field(alias="X-Plex-Platform"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
] = None
class GeoDataTypedDict(TypedDict): class GeoDataTypedDict(TypedDict):
r"""Geo location data""" r"""Geo location data"""
@@ -101,7 +150,7 @@ class GeoDataTypedDict(TypedDict):
r"""The name of the city.""" r"""The name of the city."""
time_zone: str time_zone: str
r"""The time zone of the country.""" r"""The time zone of the country."""
postal_code: int postal_code: str
r"""The postal code of the location.""" r"""The postal code of the location."""
subdivisions: str subdivisions: str
r"""The name of the primary administrative subdivision.""" r"""The name of the primary administrative subdivision."""
@@ -133,7 +182,7 @@ class GeoData(BaseModel):
time_zone: str time_zone: str
r"""The time zone of the country.""" r"""The time zone of the country."""
postal_code: int postal_code: str
r"""The postal code of the location.""" r"""The postal code of the location."""
subdivisions: str subdivisions: str
@@ -168,7 +217,7 @@ class GetPinAuthPinContainerTypedDict(TypedDict):
trusted: NotRequired[bool] trusted: NotRequired[bool]
expires_in: NotRequired[int] expires_in: NotRequired[int]
r"""The number of seconds this pin expires, by default 900 seconds""" r"""The number of seconds this pin expires, by default 900 seconds"""
auth_token: NotRequired[Nullable[Any]] auth_token: NotRequired[Nullable[str]]
new_registration: NotRequired[Nullable[Any]] new_registration: NotRequired[Nullable[Any]]
@@ -198,7 +247,7 @@ class GetPinAuthPinContainer(BaseModel):
expires_in: Annotated[Optional[int], pydantic.Field(alias="expiresIn")] = 900 expires_in: Annotated[Optional[int], pydantic.Field(alias="expiresIn")] = 900
r"""The number of seconds this pin expires, by default 900 seconds""" r"""The number of seconds this pin expires, by default 900 seconds"""
auth_token: Annotated[OptionalNullable[Any], pydantic.Field(alias="authToken")] = ( auth_token: Annotated[OptionalNullable[str], pydantic.Field(alias="authToken")] = (
UNSET UNSET
) )

View File

@@ -22,7 +22,7 @@ GET_TOKEN_BY_PIN_ID_SERVERS = [
class GetTokenByPinIDGlobalsTypedDict(TypedDict): class GetTokenByPinIDGlobalsTypedDict(TypedDict):
x_plex_client_identifier: NotRequired[str] client_id: NotRequired[str]
r"""The unique identifier for the client application r"""The unique identifier for the client application
This is used to track the client application and its usage This is used to track the client application and its usage
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
@@ -31,7 +31,7 @@ class GetTokenByPinIDGlobalsTypedDict(TypedDict):
class GetTokenByPinIDGlobals(BaseModel): class GetTokenByPinIDGlobals(BaseModel):
x_plex_client_identifier: Annotated[ client_id: Annotated[
Optional[str], Optional[str],
pydantic.Field(alias="X-Plex-Client-Identifier"), pydantic.Field(alias="X-Plex-Client-Identifier"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -46,7 +46,7 @@ class GetTokenByPinIDGlobals(BaseModel):
class GetTokenByPinIDRequestTypedDict(TypedDict): class GetTokenByPinIDRequestTypedDict(TypedDict):
pin_id: int pin_id: int
r"""The PinID to retrieve an access token for""" r"""The PinID to retrieve an access token for"""
x_plex_client_identifier: NotRequired[str] client_id: NotRequired[str]
r"""The unique identifier for the client application r"""The unique identifier for the client application
This is used to track the client application and its usage This is used to track the client application and its usage
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
@@ -62,7 +62,7 @@ class GetTokenByPinIDRequest(BaseModel):
] ]
r"""The PinID to retrieve an access token for""" r"""The PinID to retrieve an access token for"""
x_plex_client_identifier: Annotated[ client_id: Annotated[
Optional[str], Optional[str],
pydantic.Field(alias="X-Plex-Client-Identifier"), pydantic.Field(alias="X-Plex-Client-Identifier"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -87,7 +87,7 @@ class GetTokenByPinIDGeoDataTypedDict(TypedDict):
r"""The name of the city.""" r"""The name of the city."""
time_zone: str time_zone: str
r"""The time zone of the country.""" r"""The time zone of the country."""
postal_code: int postal_code: str
r"""The postal code of the location.""" r"""The postal code of the location."""
subdivisions: str subdivisions: str
r"""The name of the primary administrative subdivision.""" r"""The name of the primary administrative subdivision."""
@@ -119,7 +119,7 @@ class GetTokenByPinIDGeoData(BaseModel):
time_zone: str time_zone: str
r"""The time zone of the country.""" r"""The time zone of the country."""
postal_code: int postal_code: str
r"""The postal code of the location.""" r"""The postal code of the location."""
subdivisions: str subdivisions: str
@@ -154,7 +154,7 @@ class GetTokenByPinIDAuthPinContainerTypedDict(TypedDict):
trusted: NotRequired[bool] trusted: NotRequired[bool]
expires_in: NotRequired[int] expires_in: NotRequired[int]
r"""The number of seconds this pin expires, by default 900 seconds""" r"""The number of seconds this pin expires, by default 900 seconds"""
auth_token: NotRequired[Nullable[Any]] auth_token: NotRequired[Nullable[str]]
new_registration: NotRequired[Nullable[Any]] new_registration: NotRequired[Nullable[Any]]
@@ -184,7 +184,7 @@ class GetTokenByPinIDAuthPinContainer(BaseModel):
expires_in: Annotated[Optional[int], pydantic.Field(alias="expiresIn")] = 900 expires_in: Annotated[Optional[int], pydantic.Field(alias="expiresIn")] = 900
r"""The number of seconds this pin expires, by default 900 seconds""" r"""The number of seconds this pin expires, by default 900 seconds"""
auth_token: Annotated[OptionalNullable[Any], pydantic.Field(alias="authToken")] = ( auth_token: Annotated[OptionalNullable[str], pydantic.Field(alias="authToken")] = (
UNSET UNSET
) )

View File

@@ -23,7 +23,7 @@ POST_USERS_SIGN_IN_DATA_SERVERS = [
class PostUsersSignInDataGlobalsTypedDict(TypedDict): class PostUsersSignInDataGlobalsTypedDict(TypedDict):
x_plex_client_identifier: NotRequired[str] client_id: NotRequired[str]
r"""The unique identifier for the client application r"""The unique identifier for the client application
This is used to track the client application and its usage This is used to track the client application and its usage
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
@@ -32,7 +32,7 @@ class PostUsersSignInDataGlobalsTypedDict(TypedDict):
class PostUsersSignInDataGlobals(BaseModel): class PostUsersSignInDataGlobals(BaseModel):
x_plex_client_identifier: Annotated[ client_id: Annotated[
Optional[str], Optional[str],
pydantic.Field(alias="X-Plex-Client-Identifier"), pydantic.Field(alias="X-Plex-Client-Identifier"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -72,7 +72,7 @@ class PostUsersSignInDataRequestBody(BaseModel):
class PostUsersSignInDataRequestTypedDict(TypedDict): class PostUsersSignInDataRequestTypedDict(TypedDict):
x_plex_client_identifier: NotRequired[str] client_id: NotRequired[str]
r"""The unique identifier for the client application r"""The unique identifier for the client application
This is used to track the client application and its usage This is used to track the client application and its usage
(UUID, serial number, or other number unique per device) (UUID, serial number, or other number unique per device)
@@ -83,7 +83,7 @@ class PostUsersSignInDataRequestTypedDict(TypedDict):
class PostUsersSignInDataRequest(BaseModel): class PostUsersSignInDataRequest(BaseModel):
x_plex_client_identifier: Annotated[ client_id: Annotated[
Optional[str], Optional[str],
pydantic.Field(alias="X-Plex-Client-Identifier"), pydantic.Field(alias="X-Plex-Client-Identifier"),
FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),

View File

@@ -4,8 +4,8 @@ from .basesdk import BaseSDK
from plex_api_client import utils from plex_api_client import utils
from plex_api_client._hooks import HookContext from plex_api_client._hooks import HookContext
from plex_api_client.models import errors, operations from plex_api_client.models import errors, operations
from plex_api_client.types import OptionalNullable, UNSET from plex_api_client.types import BaseModel, OptionalNullable, UNSET
from typing import Any, List, Optional from typing import Any, List, Optional, Union, cast
class Plex(BaseSDK): class Plex(BaseSDK):
@@ -740,7 +740,7 @@ class Plex(BaseSDK):
def get_server_resources( def get_server_resources(
self, self,
*, *,
x_plex_client_identifier: Optional[str] = None, client_id: Optional[str] = None,
include_https: Optional[operations.IncludeHTTPS] = operations.IncludeHTTPS.ZERO, include_https: Optional[operations.IncludeHTTPS] = operations.IncludeHTTPS.ZERO,
include_relay: Optional[operations.IncludeRelay] = operations.IncludeRelay.ZERO, include_relay: Optional[operations.IncludeRelay] = operations.IncludeRelay.ZERO,
include_i_pv6: Optional[operations.IncludeIPv6] = operations.IncludeIPv6.ZERO, include_i_pv6: Optional[operations.IncludeIPv6] = operations.IncludeIPv6.ZERO,
@@ -752,7 +752,7 @@ class Plex(BaseSDK):
Get Plex server access tokens and server connections Get Plex server access tokens and server connections
:param x_plex_client_identifier: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) :param client_id: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device)
:param include_https: Include Https entries in the results :param include_https: Include Https entries in the results
:param include_relay: Include Relay addresses in the results E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400 :param include_relay: Include Relay addresses in the results E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
:param include_i_pv6: Include IPv6 entries in the results :param include_i_pv6: Include IPv6 entries in the results
@@ -771,7 +771,7 @@ class Plex(BaseSDK):
base_url = operations.GET_SERVER_RESOURCES_SERVERS[0] base_url = operations.GET_SERVER_RESOURCES_SERVERS[0]
request = operations.GetServerResourcesRequest( request = operations.GetServerResourcesRequest(
x_plex_client_identifier=x_plex_client_identifier, client_id=client_id,
include_https=include_https, include_https=include_https,
include_relay=include_relay, include_relay=include_relay,
include_i_pv6=include_i_pv6, include_i_pv6=include_i_pv6,
@@ -789,7 +789,7 @@ class Plex(BaseSDK):
user_agent_header="user-agent", user_agent_header="user-agent",
accept_header_value="application/json", accept_header_value="application/json",
_globals=operations.GetServerResourcesGlobals( _globals=operations.GetServerResourcesGlobals(
x_plex_client_identifier=self.sdk_configuration.globals.x_plex_client_identifier, client_id=self.sdk_configuration.globals.client_id,
), ),
security=self.sdk_configuration.security, security=self.sdk_configuration.security,
timeout_ms=timeout_ms, timeout_ms=timeout_ms,
@@ -852,7 +852,7 @@ class Plex(BaseSDK):
async def get_server_resources_async( async def get_server_resources_async(
self, self,
*, *,
x_plex_client_identifier: Optional[str] = None, client_id: Optional[str] = None,
include_https: Optional[operations.IncludeHTTPS] = operations.IncludeHTTPS.ZERO, include_https: Optional[operations.IncludeHTTPS] = operations.IncludeHTTPS.ZERO,
include_relay: Optional[operations.IncludeRelay] = operations.IncludeRelay.ZERO, include_relay: Optional[operations.IncludeRelay] = operations.IncludeRelay.ZERO,
include_i_pv6: Optional[operations.IncludeIPv6] = operations.IncludeIPv6.ZERO, include_i_pv6: Optional[operations.IncludeIPv6] = operations.IncludeIPv6.ZERO,
@@ -864,7 +864,7 @@ class Plex(BaseSDK):
Get Plex server access tokens and server connections Get Plex server access tokens and server connections
:param x_plex_client_identifier: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) :param client_id: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device)
:param include_https: Include Https entries in the results :param include_https: Include Https entries in the results
:param include_relay: Include Relay addresses in the results E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400 :param include_relay: Include Relay addresses in the results E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
:param include_i_pv6: Include IPv6 entries in the results :param include_i_pv6: Include IPv6 entries in the results
@@ -883,7 +883,7 @@ class Plex(BaseSDK):
base_url = operations.GET_SERVER_RESOURCES_SERVERS[0] base_url = operations.GET_SERVER_RESOURCES_SERVERS[0]
request = operations.GetServerResourcesRequest( request = operations.GetServerResourcesRequest(
x_plex_client_identifier=x_plex_client_identifier, client_id=client_id,
include_https=include_https, include_https=include_https,
include_relay=include_relay, include_relay=include_relay,
include_i_pv6=include_i_pv6, include_i_pv6=include_i_pv6,
@@ -901,7 +901,7 @@ class Plex(BaseSDK):
user_agent_header="user-agent", user_agent_header="user-agent",
accept_header_value="application/json", accept_header_value="application/json",
_globals=operations.GetServerResourcesGlobals( _globals=operations.GetServerResourcesGlobals(
x_plex_client_identifier=self.sdk_configuration.globals.x_plex_client_identifier, client_id=self.sdk_configuration.globals.client_id,
), ),
security=self.sdk_configuration.security, security=self.sdk_configuration.security,
timeout_ms=timeout_ms, timeout_ms=timeout_ms,
@@ -964,20 +964,16 @@ class Plex(BaseSDK):
def get_pin( def get_pin(
self, self,
*, *,
strong: Optional[bool] = False, request: Union[operations.GetPinRequest, operations.GetPinRequestTypedDict],
x_plex_client_identifier: Optional[str] = None,
x_plex_product: Optional[str] = None,
retries: OptionalNullable[utils.RetryConfig] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET,
server_url: Optional[str] = None, server_url: Optional[str] = None,
timeout_ms: Optional[int] = None, timeout_ms: Optional[int] = None,
) -> operations.GetPinResponse: ) -> operations.GetPinResponse:
r"""Get a Pin r"""Get a Pin
Retrieve a Pin from Plex.tv for authentication flows Retrieve a Pin ID from Plex.tv to use for authentication flows
:param strong: Determines the kind of code returned by the API call Strong codes are used for Pin authentication flows Non-Strong codes are used for `Plex.tv/link` :param request: The request object to send.
:param x_plex_client_identifier: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device)
:param x_plex_product:
:param retries: Override the default retry configuration for this method :param retries: Override the default retry configuration for this method
:param server_url: Override the default server URL for this method :param server_url: Override the default server URL for this method
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -992,11 +988,9 @@ class Plex(BaseSDK):
else: else:
base_url = operations.GET_PIN_SERVERS[0] base_url = operations.GET_PIN_SERVERS[0]
request = operations.GetPinRequest( if not isinstance(request, BaseModel):
strong=strong, request = utils.unmarshal(request, operations.GetPinRequest)
x_plex_client_identifier=x_plex_client_identifier, request = cast(operations.GetPinRequest, request)
x_plex_product=x_plex_product,
)
req = self.build_request( req = self.build_request(
method="POST", method="POST",
@@ -1010,7 +1004,11 @@ class Plex(BaseSDK):
user_agent_header="user-agent", user_agent_header="user-agent",
accept_header_value="application/json", accept_header_value="application/json",
_globals=operations.GetPinGlobals( _globals=operations.GetPinGlobals(
x_plex_client_identifier=self.sdk_configuration.globals.x_plex_client_identifier, client_id=self.sdk_configuration.globals.client_id,
client_name=self.sdk_configuration.globals.client_name,
device_name=self.sdk_configuration.globals.device_name,
client_version=self.sdk_configuration.globals.client_version,
client_platform=self.sdk_configuration.globals.client_platform,
), ),
timeout_ms=timeout_ms, timeout_ms=timeout_ms,
) )
@@ -1033,7 +1031,7 @@ class Plex(BaseSDK):
) )
data: Any = None data: Any = None
if utils.match_response(http_res, "200", "application/json"): if utils.match_response(http_res, "201", "application/json"):
return operations.GetPinResponse( return operations.GetPinResponse(
auth_pin_container=utils.unmarshal_json( auth_pin_container=utils.unmarshal_json(
http_res.text, Optional[operations.GetPinAuthPinContainer] http_res.text, Optional[operations.GetPinAuthPinContainer]
@@ -1062,20 +1060,16 @@ class Plex(BaseSDK):
async def get_pin_async( async def get_pin_async(
self, self,
*, *,
strong: Optional[bool] = False, request: Union[operations.GetPinRequest, operations.GetPinRequestTypedDict],
x_plex_client_identifier: Optional[str] = None,
x_plex_product: Optional[str] = None,
retries: OptionalNullable[utils.RetryConfig] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET,
server_url: Optional[str] = None, server_url: Optional[str] = None,
timeout_ms: Optional[int] = None, timeout_ms: Optional[int] = None,
) -> operations.GetPinResponse: ) -> operations.GetPinResponse:
r"""Get a Pin r"""Get a Pin
Retrieve a Pin from Plex.tv for authentication flows Retrieve a Pin ID from Plex.tv to use for authentication flows
:param strong: Determines the kind of code returned by the API call Strong codes are used for Pin authentication flows Non-Strong codes are used for `Plex.tv/link` :param request: The request object to send.
:param x_plex_client_identifier: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device)
:param x_plex_product:
:param retries: Override the default retry configuration for this method :param retries: Override the default retry configuration for this method
:param server_url: Override the default server URL for this method :param server_url: Override the default server URL for this method
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1090,11 +1084,9 @@ class Plex(BaseSDK):
else: else:
base_url = operations.GET_PIN_SERVERS[0] base_url = operations.GET_PIN_SERVERS[0]
request = operations.GetPinRequest( if not isinstance(request, BaseModel):
strong=strong, request = utils.unmarshal(request, operations.GetPinRequest)
x_plex_client_identifier=x_plex_client_identifier, request = cast(operations.GetPinRequest, request)
x_plex_product=x_plex_product,
)
req = self.build_request_async( req = self.build_request_async(
method="POST", method="POST",
@@ -1108,7 +1100,11 @@ class Plex(BaseSDK):
user_agent_header="user-agent", user_agent_header="user-agent",
accept_header_value="application/json", accept_header_value="application/json",
_globals=operations.GetPinGlobals( _globals=operations.GetPinGlobals(
x_plex_client_identifier=self.sdk_configuration.globals.x_plex_client_identifier, client_id=self.sdk_configuration.globals.client_id,
client_name=self.sdk_configuration.globals.client_name,
device_name=self.sdk_configuration.globals.device_name,
client_version=self.sdk_configuration.globals.client_version,
client_platform=self.sdk_configuration.globals.client_platform,
), ),
timeout_ms=timeout_ms, timeout_ms=timeout_ms,
) )
@@ -1131,7 +1127,7 @@ class Plex(BaseSDK):
) )
data: Any = None data: Any = None
if utils.match_response(http_res, "200", "application/json"): if utils.match_response(http_res, "201", "application/json"):
return operations.GetPinResponse( return operations.GetPinResponse(
auth_pin_container=utils.unmarshal_json( auth_pin_container=utils.unmarshal_json(
http_res.text, Optional[operations.GetPinAuthPinContainer] http_res.text, Optional[operations.GetPinAuthPinContainer]
@@ -1161,7 +1157,7 @@ class Plex(BaseSDK):
self, self,
*, *,
pin_id: int, pin_id: int,
x_plex_client_identifier: Optional[str] = None, client_id: Optional[str] = None,
retries: OptionalNullable[utils.RetryConfig] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET,
server_url: Optional[str] = None, server_url: Optional[str] = None,
timeout_ms: Optional[int] = None, timeout_ms: Optional[int] = None,
@@ -1171,7 +1167,7 @@ class Plex(BaseSDK):
Retrieve an Access Token from Plex.tv after the Pin has been authenticated Retrieve an Access Token from Plex.tv after the Pin has been authenticated
:param pin_id: The PinID to retrieve an access token for :param pin_id: The PinID to retrieve an access token for
:param x_plex_client_identifier: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) :param client_id: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device)
:param retries: Override the default retry configuration for this method :param retries: Override the default retry configuration for this method
:param server_url: Override the default server URL for this method :param server_url: Override the default server URL for this method
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1187,7 +1183,7 @@ class Plex(BaseSDK):
base_url = operations.GET_TOKEN_BY_PIN_ID_SERVERS[0] base_url = operations.GET_TOKEN_BY_PIN_ID_SERVERS[0]
request = operations.GetTokenByPinIDRequest( request = operations.GetTokenByPinIDRequest(
x_plex_client_identifier=x_plex_client_identifier, client_id=client_id,
pin_id=pin_id, pin_id=pin_id,
) )
@@ -1203,7 +1199,7 @@ class Plex(BaseSDK):
user_agent_header="user-agent", user_agent_header="user-agent",
accept_header_value="application/json", accept_header_value="application/json",
_globals=operations.GetTokenByPinIDGlobals( _globals=operations.GetTokenByPinIDGlobals(
x_plex_client_identifier=self.sdk_configuration.globals.x_plex_client_identifier, client_id=self.sdk_configuration.globals.client_id,
), ),
timeout_ms=timeout_ms, timeout_ms=timeout_ms,
) )
@@ -1264,7 +1260,7 @@ class Plex(BaseSDK):
self, self,
*, *,
pin_id: int, pin_id: int,
x_plex_client_identifier: Optional[str] = None, client_id: Optional[str] = None,
retries: OptionalNullable[utils.RetryConfig] = UNSET, retries: OptionalNullable[utils.RetryConfig] = UNSET,
server_url: Optional[str] = None, server_url: Optional[str] = None,
timeout_ms: Optional[int] = None, timeout_ms: Optional[int] = None,
@@ -1274,7 +1270,7 @@ class Plex(BaseSDK):
Retrieve an Access Token from Plex.tv after the Pin has been authenticated Retrieve an Access Token from Plex.tv after the Pin has been authenticated
:param pin_id: The PinID to retrieve an access token for :param pin_id: The PinID to retrieve an access token for
:param x_plex_client_identifier: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) :param client_id: The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device)
:param retries: Override the default retry configuration for this method :param retries: Override the default retry configuration for this method
:param server_url: Override the default server URL for this method :param server_url: Override the default server URL for this method
:param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1290,7 +1286,7 @@ class Plex(BaseSDK):
base_url = operations.GET_TOKEN_BY_PIN_ID_SERVERS[0] base_url = operations.GET_TOKEN_BY_PIN_ID_SERVERS[0]
request = operations.GetTokenByPinIDRequest( request = operations.GetTokenByPinIDRequest(
x_plex_client_identifier=x_plex_client_identifier, client_id=client_id,
pin_id=pin_id, pin_id=pin_id,
) )
@@ -1306,7 +1302,7 @@ class Plex(BaseSDK):
user_agent_header="user-agent", user_agent_header="user-agent",
accept_header_value="application/json", accept_header_value="application/json",
_globals=operations.GetTokenByPinIDGlobals( _globals=operations.GetTokenByPinIDGlobals(
x_plex_client_identifier=self.sdk_configuration.globals.x_plex_client_identifier, client_id=self.sdk_configuration.globals.client_id,
), ),
timeout_ms=timeout_ms, timeout_ms=timeout_ms,
) )

View File

@@ -112,7 +112,11 @@ class PlexAPI(BaseSDK):
access_token: Optional[ access_token: Optional[
Union[Optional[str], Callable[[], Optional[str]]] Union[Optional[str], Callable[[], Optional[str]]]
] = None, ] = None,
x_plex_client_identifier: Optional[str] = None, client_id: Optional[str] = None,
client_name: Optional[str] = None,
client_version: Optional[str] = None,
client_platform: Optional[str] = None,
device_name: Optional[str] = None,
protocol: Optional[ServerProtocol] = None, protocol: Optional[ServerProtocol] = None,
ip: Optional[str] = None, ip: Optional[str] = None,
port: Optional[str] = None, port: Optional[str] = None,
@@ -128,7 +132,11 @@ class PlexAPI(BaseSDK):
r"""Instantiates the SDK configuring it with the provided parameters. r"""Instantiates the SDK configuring it with the provided parameters.
:param access_token: The access_token required for authentication :param access_token: The access_token required for authentication
:param x_plex_client_identifier: Configures the x_plex_client_identifier parameter for all supported operations :param client_id: Configures the client_id parameter for all supported operations
:param client_name: Configures the client_name parameter for all supported operations
:param client_version: Configures the client_version parameter for all supported operations
:param client_platform: Configures the client_platform parameter for all supported operations
:param device_name: Configures the device_name parameter for all supported operations
:param protocol: Allows setting the protocol variable for url substitution :param protocol: Allows setting the protocol variable for url substitution
:param ip: Allows setting the ip variable for url substitution :param ip: Allows setting the ip variable for url substitution
:param port: Allows setting the port variable for url substitution :param port: Allows setting the port variable for url substitution
@@ -175,9 +183,15 @@ class PlexAPI(BaseSDK):
] ]
_globals = internal.Globals( _globals = internal.Globals(
x_plex_client_identifier=utils.get_global_from_env( client_id=utils.get_global_from_env(client_id, "CLIENT_ID", str),
x_plex_client_identifier, "X_PLEX_CLIENT_IDENTIFIER", str client_name=utils.get_global_from_env(client_name, "CLIENT_NAME", str),
client_version=utils.get_global_from_env(
client_version, "CLIENT_VERSION", str
), ),
client_platform=utils.get_global_from_env(
client_platform, "CLIENT_PLATFORM", str
),
device_name=utils.get_global_from_env(device_name, "DEVICE_NAME", str),
) )
BaseSDK.__init__( BaseSDK.__init__(

View File

@@ -39,9 +39,9 @@ class SDKConfiguration:
server_defaults: List[Dict[str, str]] = field(default_factory=List) server_defaults: List[Dict[str, str]] = field(default_factory=List)
language: str = "python" language: str = "python"
openapi_doc_version: str = "0.0.3" openapi_doc_version: str = "0.0.3"
sdk_version: str = "0.12.1" sdk_version: str = "0.12.2"
gen_version: str = "2.415.8" gen_version: str = "2.416.6"
user_agent: str = "speakeasy-sdk/python 0.12.1 2.415.8 0.0.3 plex-api-client" user_agent: str = "speakeasy-sdk/python 0.12.2 2.416.6 0.0.3 plex-api-client"
retry_config: OptionalNullable[RetryConfig] = Field(default_factory=lambda: UNSET) retry_config: OptionalNullable[RetryConfig] = Field(default_factory=lambda: UNSET)
timeout_ms: Optional[int] = None timeout_ms: Optional[int] = None