plex-api-client 0.19.1__tar.gz → 0.20.1__tar.gz

{plex_api_client-0.19.1 → plex_api_client-0.20.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plex-api-client
-Version: 0.19.1
+Version: 0.20.1
 Summary: Python Client SDK Generated by Speakeasy
 Home-page: https://github.com/LukeHagar/plexpy.git
 Author: Speakeasy
@@ -13,10 +13,10 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: eval-type-backport (>=0.2.0,<0.3.0)
-Requires-Dist: httpx (>=0.27.0,<0.28.0)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
 Requires-Dist: jsonpath-python (>=1.0.6,<2.0.0)
-Requires-Dist: pydantic (>=2.9.2,<2.10.0)
-Requires-Dist: python-dateutil (==2.8.2)
+Requires-Dist: pydantic (>=2.10.3,<2.11.0)
+Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: typing-inspect (>=0.9.0,<0.10.0)
 Project-URL: Repository, https://github.com/LukeHagar/plexpy.git
 Description-Content-Type: text/markdown
@@ -63,17 +63,25 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [plexpy](https://github.com/LukeHagar/plexpy/blob/master/#plexpy)
+* [Plex Media Server OpenAPI Specification](https://github.com/LukeHagar/plexpy/blob/master/#plex-media-server-openapi-specification)
+  * [Documentation](https://github.com/LukeHagar/plexpy/blob/master/#documentation)
+  * [SDKs](https://github.com/LukeHagar/plexpy/blob/master/#sdks)
+  * [SDK Installation](https://github.com/LukeHagar/plexpy/blob/master/#sdk-installation)
+  * [IDE Support](https://github.com/LukeHagar/plexpy/blob/master/#ide-support)
+  * [SDK Example Usage](https://github.com/LukeHagar/plexpy/blob/master/#sdk-example-usage)
+  * [Available Resources and Operations](https://github.com/LukeHagar/plexpy/blob/master/#available-resources-and-operations)
+  * [Retries](https://github.com/LukeHagar/plexpy/blob/master/#retries)
+  * [Error Handling](https://github.com/LukeHagar/plexpy/blob/master/#error-handling)
+  * [Server Selection](https://github.com/LukeHagar/plexpy/blob/master/#server-selection)
+  * [Custom HTTP Client](https://github.com/LukeHagar/plexpy/blob/master/#custom-http-client)
+  * [Authentication](https://github.com/LukeHagar/plexpy/blob/master/#authentication)
+  * [Debugging](https://github.com/LukeHagar/plexpy/blob/master/#debugging)
+* [Development](https://github.com/LukeHagar/plexpy/blob/master/#development)
+  * [Maturity](https://github.com/LukeHagar/plexpy/blob/master/#maturity)
+  * [Contributions](https://github.com/LukeHagar/plexpy/blob/master/#contributions)
 
-* [SDK Installation](https://github.com/LukeHagar/plexpy/blob/master/#sdk-installation)
-* [IDE Support](https://github.com/LukeHagar/plexpy/blob/master/#ide-support)
-* [SDK Example Usage](https://github.com/LukeHagar/plexpy/blob/master/#sdk-example-usage)
-* [Available Resources and Operations](https://github.com/LukeHagar/plexpy/blob/master/#available-resources-and-operations)
-* [Retries](https://github.com/LukeHagar/plexpy/blob/master/#retries)
-* [Error Handling](https://github.com/LukeHagar/plexpy/blob/master/#error-handling)
-* [Server Selection](https://github.com/LukeHagar/plexpy/blob/master/#server-selection)
-* [Custom HTTP Client](https://github.com/LukeHagar/plexpy/blob/master/#custom-http-client)
-* [Authentication](https://github.com/LukeHagar/plexpy/blob/master/#authentication)
-* [Debugging](https://github.com/LukeHagar/plexpy/blob/master/#debugging)
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
@@ -117,20 +125,16 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 # Synchronous Example
 from plex_api_client import PlexAPI
 
-s = PlexAPI(
+with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
-
-res = s.server.get_server_capabilities()
-
-if res.object is not None:
-    # handle response
-    pass
+) as plex_api:
+
+    res = plex_api.server.get_server_capabilities()
+
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
 ```
 
 </br>
@@ -142,18 +146,16 @@ import asyncio
 from plex_api_client import PlexAPI
 
 async def main():
-    s = PlexAPI(
+    async with PlexAPI(
         access_token="<YOUR_API_KEY_HERE>",
-        client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-        client_name="Plex for Roku",
-        client_version="2.4.1",
-        platform="Roku",
-        device_nickname="Roku 3",
-    )
-    res = await s.server.get_server_capabilities_async()
-    if res.object is not None:
-        # handle response
-        pass
+    ) as plex_api:
+
+        res = await plex_api.server.get_server_capabilities_async()
+
+        assert res.object is not None
+
+        # Handle response
+        print(res.object)
 
 asyncio.run(main())
 ```
@@ -300,47 +302,39 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
 
 To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
 ```python
-from plex_api.utils import BackoffStrategy, RetryConfig
 from plex_api_client import PlexAPI
+from plex_api_client.utils import BackoffStrategy, RetryConfig
 
-s = PlexAPI(
+with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
+) as plex_api:
+
+    res = plex_api.server.get_server_capabilities(,
+        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
-res = s.server.get_server_capabilities(,
-    RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
+    assert res.object is not None
 
-if res.object is not None:
-    # handle response
-    pass
+    # Handle response
+    print(res.object)
 
 ```
 
 If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
 ```python
-from plex_api.utils import BackoffStrategy, RetryConfig
 from plex_api_client import PlexAPI
+from plex_api_client.utils import BackoffStrategy, RetryConfig
 
-s = PlexAPI(
+with PlexAPI(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
+) as plex_api:
 
-res = s.server.get_server_capabilities()
+    res = plex_api.server.get_server_capabilities()
 
-if res.object is not None:
-    # handle response
-    pass
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
 
 ```
 <!-- End Retries [retries] -->
@@ -373,32 +367,28 @@ When custom error responses are specified for an operation, the SDK may also rai
 from plex_api_client import PlexAPI
 from plex_api_client.models import errors
 
-s = PlexAPI(
+with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
-
-res = None
-try:
-    res = s.server.get_server_capabilities()
-
-    if res.object is not None:
-        # handle response
-        pass
-
-except errors.GetServerCapabilitiesBadRequest as e:
-    # handle e.data: errors.GetServerCapabilitiesBadRequestData
-    raise(e)
-except errors.GetServerCapabilitiesUnauthorized as e:
-    # handle e.data: errors.GetServerCapabilitiesUnauthorizedData
-    raise(e)
-except errors.SDKError as e:
-    # handle exception
-    raise(e)
+) as plex_api:
+    res = None
+    try:
+
+        res = plex_api.server.get_server_capabilities()
+
+        assert res.object is not None
+
+        # Handle response
+        print(res.object)
+
+    except errors.GetServerCapabilitiesBadRequest as e:
+        # handle e.data: errors.GetServerCapabilitiesBadRequestData
+        raise(e)
+    except errors.GetServerCapabilitiesUnauthorized as e:
+        # handle e.data: errors.GetServerCapabilitiesUnauthorizedData
+        raise(e)
+    except errors.SDKError as e:
+        # handle exception
+        raise(e)
 ```
 <!-- End Error Handling [errors] -->
 
@@ -418,21 +408,17 @@ The default server can also be overridden globally by passing a URL to the `serv
 ```python
 from plex_api_client import PlexAPI
 
-s = PlexAPI(
+with PlexAPI(
     server_url="https://10.10.10.47:32400",
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
+) as plex_api:
+
+    res = plex_api.server.get_server_capabilities()
 
-res = s.server.get_server_capabilities()
+    assert res.object is not None
 
-if res.object is not None:
-    # handle response
-    pass
+    # Handle response
+    print(res.object)
 
 ```
 
@@ -442,20 +428,16 @@ The server URL can also be overridden on a per-operation basis, provided a serve
 ```python
 from plex_api_client import PlexAPI
 
-s = PlexAPI(
+with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
+) as plex_api:
+
+    res = plex_api.plex.get_companions_data(server_url="https://plex.tv/api/v2")
 
-res = s.plex.get_companions_data(server_url="https://plex.tv/api/v2")
+    assert res.response_bodies is not None
 
-if res.response_bodies is not None:
-    # handle response
-    pass
+    # Handle response
+    print(res.response_bodies)
 
 ```
 <!-- End Server Selection [server] -->
@@ -556,20 +538,16 @@ To authenticate with the API the `access_token` parameter must be set when initi
 ```python
 from plex_api_client import PlexAPI
 
-s = PlexAPI(
+with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
-
-res = s.server.get_server_capabilities()
-
-if res.object is not None:
-    # handle response
-    pass
+) as plex_api:
+
+    res = plex_api.server.get_server_capabilities()
+
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
 
 ```
 <!-- End Authentication [security] -->

{plex_api_client-0.19.1 → plex_api_client-0.20.1}/README-PYPI.md

@@ -40,17 +40,25 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [plexpy](https://github.com/LukeHagar/plexpy/blob/master/#plexpy)
+* [Plex Media Server OpenAPI Specification](https://github.com/LukeHagar/plexpy/blob/master/#plex-media-server-openapi-specification)
+  * [Documentation](https://github.com/LukeHagar/plexpy/blob/master/#documentation)
+  * [SDKs](https://github.com/LukeHagar/plexpy/blob/master/#sdks)
+  * [SDK Installation](https://github.com/LukeHagar/plexpy/blob/master/#sdk-installation)
+  * [IDE Support](https://github.com/LukeHagar/plexpy/blob/master/#ide-support)
+  * [SDK Example Usage](https://github.com/LukeHagar/plexpy/blob/master/#sdk-example-usage)
+  * [Available Resources and Operations](https://github.com/LukeHagar/plexpy/blob/master/#available-resources-and-operations)
+  * [Retries](https://github.com/LukeHagar/plexpy/blob/master/#retries)
+  * [Error Handling](https://github.com/LukeHagar/plexpy/blob/master/#error-handling)
+  * [Server Selection](https://github.com/LukeHagar/plexpy/blob/master/#server-selection)
+  * [Custom HTTP Client](https://github.com/LukeHagar/plexpy/blob/master/#custom-http-client)
+  * [Authentication](https://github.com/LukeHagar/plexpy/blob/master/#authentication)
+  * [Debugging](https://github.com/LukeHagar/plexpy/blob/master/#debugging)
+* [Development](https://github.com/LukeHagar/plexpy/blob/master/#development)
+  * [Maturity](https://github.com/LukeHagar/plexpy/blob/master/#maturity)
+  * [Contributions](https://github.com/LukeHagar/plexpy/blob/master/#contributions)
 
-* [SDK Installation](https://github.com/LukeHagar/plexpy/blob/master/#sdk-installation)
-* [IDE Support](https://github.com/LukeHagar/plexpy/blob/master/#ide-support)
-* [SDK Example Usage](https://github.com/LukeHagar/plexpy/blob/master/#sdk-example-usage)
-* [Available Resources and Operations](https://github.com/LukeHagar/plexpy/blob/master/#available-resources-and-operations)
-* [Retries](https://github.com/LukeHagar/plexpy/blob/master/#retries)
-* [Error Handling](https://github.com/LukeHagar/plexpy/blob/master/#error-handling)
-* [Server Selection](https://github.com/LukeHagar/plexpy/blob/master/#server-selection)
-* [Custom HTTP Client](https://github.com/LukeHagar/plexpy/blob/master/#custom-http-client)
-* [Authentication](https://github.com/LukeHagar/plexpy/blob/master/#authentication)
-* [Debugging](https://github.com/LukeHagar/plexpy/blob/master/#debugging)
 <!-- End Table of Contents [toc] -->
 
 <!-- Start SDK Installation [installation] -->
@@ -94,20 +102,16 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 # Synchronous Example
 from plex_api_client import PlexAPI
 
-s = PlexAPI(
+with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
-
-res = s.server.get_server_capabilities()
-
-if res.object is not None:
-    # handle response
-    pass
+) as plex_api:
+
+    res = plex_api.server.get_server_capabilities()
+
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
 ```
 
 </br>
@@ -119,18 +123,16 @@ import asyncio
 from plex_api_client import PlexAPI
 
 async def main():
-    s = PlexAPI(
+    async with PlexAPI(
         access_token="<YOUR_API_KEY_HERE>",
-        client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-        client_name="Plex for Roku",
-        client_version="2.4.1",
-        platform="Roku",
-        device_nickname="Roku 3",
-    )
-    res = await s.server.get_server_capabilities_async()
-    if res.object is not None:
-        # handle response
-        pass
+    ) as plex_api:
+
+        res = await plex_api.server.get_server_capabilities_async()
+
+        assert res.object is not None
+
+        # Handle response
+        print(res.object)
 
 asyncio.run(main())
 ```
@@ -277,47 +279,39 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
 
 To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
 ```python
-from plex_api.utils import BackoffStrategy, RetryConfig
 from plex_api_client import PlexAPI
+from plex_api_client.utils import BackoffStrategy, RetryConfig
 
-s = PlexAPI(
+with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
+) as plex_api:
+
+    res = plex_api.server.get_server_capabilities(,
+        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
-res = s.server.get_server_capabilities(,
-    RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
+    assert res.object is not None
 
-if res.object is not None:
-    # handle response
-    pass
+    # Handle response
+    print(res.object)
 
 ```
 
 If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
 ```python
-from plex_api.utils import BackoffStrategy, RetryConfig
 from plex_api_client import PlexAPI
+from plex_api_client.utils import BackoffStrategy, RetryConfig
 
-s = PlexAPI(
+with PlexAPI(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
+) as plex_api:
 
-res = s.server.get_server_capabilities()
+    res = plex_api.server.get_server_capabilities()
 
-if res.object is not None:
-    # handle response
-    pass
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
 
 ```
 <!-- End Retries [retries] -->
@@ -350,32 +344,28 @@ When custom error responses are specified for an operation, the SDK may also rai
 from plex_api_client import PlexAPI
 from plex_api_client.models import errors
 
-s = PlexAPI(
+with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
-
-res = None
-try:
-    res = s.server.get_server_capabilities()
-
-    if res.object is not None:
-        # handle response
-        pass
-
-except errors.GetServerCapabilitiesBadRequest as e:
-    # handle e.data: errors.GetServerCapabilitiesBadRequestData
-    raise(e)
-except errors.GetServerCapabilitiesUnauthorized as e:
-    # handle e.data: errors.GetServerCapabilitiesUnauthorizedData
-    raise(e)
-except errors.SDKError as e:
-    # handle exception
-    raise(e)
+) as plex_api:
+    res = None
+    try:
+
+        res = plex_api.server.get_server_capabilities()
+
+        assert res.object is not None
+
+        # Handle response
+        print(res.object)
+
+    except errors.GetServerCapabilitiesBadRequest as e:
+        # handle e.data: errors.GetServerCapabilitiesBadRequestData
+        raise(e)
+    except errors.GetServerCapabilitiesUnauthorized as e:
+        # handle e.data: errors.GetServerCapabilitiesUnauthorizedData
+        raise(e)
+    except errors.SDKError as e:
+        # handle exception
+        raise(e)
 ```
 <!-- End Error Handling [errors] -->
 
@@ -395,21 +385,17 @@ The default server can also be overridden globally by passing a URL to the `serv
 ```python
 from plex_api_client import PlexAPI
 
-s = PlexAPI(
+with PlexAPI(
     server_url="https://10.10.10.47:32400",
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
+) as plex_api:
+
+    res = plex_api.server.get_server_capabilities()
 
-res = s.server.get_server_capabilities()
+    assert res.object is not None
 
-if res.object is not None:
-    # handle response
-    pass
+    # Handle response
+    print(res.object)
 
 ```
 
@@ -419,20 +405,16 @@ The server URL can also be overridden on a per-operation basis, provided a serve
 ```python
 from plex_api_client import PlexAPI
 
-s = PlexAPI(
+with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
+) as plex_api:
+
+    res = plex_api.plex.get_companions_data(server_url="https://plex.tv/api/v2")
 
-res = s.plex.get_companions_data(server_url="https://plex.tv/api/v2")
+    assert res.response_bodies is not None
 
-if res.response_bodies is not None:
-    # handle response
-    pass
+    # Handle response
+    print(res.response_bodies)
 
 ```
 <!-- End Server Selection [server] -->
@@ -533,20 +515,16 @@ To authenticate with the API the `access_token` parameter must be set when initi
 ```python
 from plex_api_client import PlexAPI
 
-s = PlexAPI(
+with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
-    client_id="3381b62b-9ab7-4e37-827b-203e9809eb58",
-    client_name="Plex for Roku",
-    client_version="2.4.1",
-    platform="Roku",
-    device_nickname="Roku 3",
-)
-
-res = s.server.get_server_capabilities()
-
-if res.object is not None:
-    # handle response
-    pass
+) as plex_api:
+
+    res = plex_api.server.get_server_capabilities()
+
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
 
 ```
 <!-- End Authentication [security] -->

{plex_api_client-0.19.1 → plex_api_client-0.20.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "plex-api-client"
-version = "0.19.1"
+version = "0.20.1"
 description = "Python Client SDK Generated by Speakeasy"
 authors = ["Speakeasy",]
 readme = "README-PYPI.md"
@@ -19,14 +19,14 @@ in-project = true
 [tool.poetry.dependencies]
 python = "^3.8"
 eval-type-backport = "^0.2.0"
-httpx = "^0.27.0"
+httpx = "^0.28.1"
 jsonpath-python = "^1.0.6"
-pydantic = "~2.9.2"
-python-dateutil = "2.8.2"
+pydantic = "~2.10.3"
+python-dateutil = "^2.8.2"
 typing-inspect = "^0.9.0"
 
 [tool.poetry.group.dev.dependencies]
-mypy = "==1.10.1"
+mypy = "==1.13.0"
 pylint = "==3.2.3"
 types-python-dateutil = "^2.9.0.20240316"
 

{plex_api_client-0.19.1 → plex_api_client-0.20.1}/src/plex_api_client/_version.py

@@ -3,7 +3,7 @@
 import importlib.metadata
 
 __title__: str = "plex-api-client"
-__version__: str = "0.19.1"
+__version__: str = "0.20.1"
 
 try:
     if __package__ is not None: