LukeParke/plexpy
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexpy.git synced 2025-12-06 04:20:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.228.1

Browse Source
This commit is contained in:
speakeasybot
2024-03-29 16:37:20 +00:00
parent 6ce3adfd94
commit 03e43e4b00
42 changed files with 216 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/models/operations/getpinrequest.md
View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *str* | :heavy_check_mark: | 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/> |
| `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/> |

2
docs/models/operations/gettokenrequest.md
View File

@@ -6,4 +6,4 @@
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *str* | :heavy_check_mark: | The PinID to retrieve an access token for |
| `x_plex_client_identifier` | *str* | :heavy_check_mark: | 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/> |
| `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/> |

2
docs/sdks/activities/README.md
View File

@@ -28,6 +28,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -61,6 +62,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

2
docs/sdks/authentication/README.md
View File

@@ -24,6 +24,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -66,6 +67,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

5
docs/sdks/butler/README.md
View File

@@ -25,6 +25,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -63,6 +64,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -97,6 +99,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -136,6 +139,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -177,6 +181,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

2
docs/sdks/hubs/README.md
View File

@@ -23,6 +23,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -65,6 +66,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

11
docs/sdks/library/README.md
View File

@@ -31,6 +31,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -72,6 +73,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -111,6 +113,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -184,6 +187,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -224,6 +228,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -284,6 +289,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -324,6 +330,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -382,6 +389,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -422,6 +430,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -462,6 +471,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -502,6 +512,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

3
docs/sdks/log/README.md
View File

@@ -25,6 +25,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -87,6 +88,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
req = 'level=4&message=Test%20message%201&source=postman
@@ -130,6 +132,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

3
docs/sdks/media/README.md
View File

@@ -23,6 +23,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -62,6 +63,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -102,6 +104,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

9
docs/sdks/playlists/README.md
View File

@@ -36,6 +36,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
req = operations.CreatePlaylistRequest(
@@ -82,6 +83,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -124,6 +126,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -164,6 +167,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -204,6 +208,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -249,6 +254,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -290,6 +296,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -331,6 +338,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -374,6 +382,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

14
docs/sdks/plex/README.md
View File

@@ -20,10 +20,12 @@ Retrieve a Pin from Plex.tv for authentication flows
```python
import plex_api
s = plex_api.PlexAPI()
s = plex_api.PlexAPI(
x_plex_client_identifier='<value>',
)
res = s.plex.get_pin(x_plex_client_identifier='<value>', strong=False)
res = s.plex.get_pin(strong=False, x_plex_client_identifier='<value>')
if res.object is not None:
# handle response
@@ -35,8 +37,8 @@ if res.object is not None:
| Parameter | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x_plex_client_identifier` | *str* | :heavy_check_mark: | 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/> |
| `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/> |
| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. |
@@ -59,7 +61,9 @@ Retrieve an Access Token from Plex.tv after the Pin has already been authenticat
```python
import plex_api
s = plex_api.PlexAPI()
s = plex_api.PlexAPI(
x_plex_client_identifier='<value>',
)
res = s.plex.get_token(pin_id='<value>', x_plex_client_identifier='<value>')
@@ -75,7 +79,7 @@ if res is not None:
| Parameter | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pin_id` | *str* | :heavy_check_mark: | The PinID to retrieve an access token for |
| `x_plex_client_identifier` | *str* | :heavy_check_mark: | 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/> |
| `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/> |
| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. |

3
docs/sdks/search/README.md
View File

@@ -35,6 +35,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -80,6 +81,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -121,6 +123,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

8
docs/sdks/server/README.md
View File

@@ -28,6 +28,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -61,6 +62,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -94,6 +96,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -127,6 +130,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -160,6 +164,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -193,6 +198,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -228,6 +234,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
req = operations.GetResizedPhotoRequest(
@@ -276,6 +283,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

4
docs/sdks/sessions/README.md
View File

@@ -24,6 +24,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -57,6 +58,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -90,6 +92,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -123,6 +126,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

1
docs/sdks/statistics/README.md
View File

@@ -21,6 +21,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

3
docs/sdks/updater/README.md
View File

@@ -24,6 +24,7 @@ import plex_api
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -58,6 +59,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
@@ -99,6 +101,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)

2
docs/sdks/video/README.md
View File

@@ -23,6 +23,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
req = operations.GetTimelineRequest(
@@ -75,6 +76,7 @@ from plex_api.models import operations
s = plex_api.PlexAPI(
access_token="<YOUR_API_KEY_HERE>",
x_plex_client_identifier='<value>',
)
req = operations.StartUniversalTranscodeRequest(