plex-api-client 0.23.0__tar.gz → 0.24.1__tar.gz

plex_api_client-0.23.0/README-PYPI.md → plex_api_client-0.24.1/PKG-INFO

@@ -1,3 +1,23 @@
+Metadata-Version: 2.3
+Name: plex-api-client
+Version: 0.24.1
+Summary: Python Client SDK Generated by Speakeasy
+Author: Speakeasy
+Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.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)
+Requires-Dist: httpx (>=0.28.1)
+Requires-Dist: pydantic (>=2.10.3)
+Requires-Dist: python-dateutil (>=2.8.2)
+Requires-Dist: typing-inspection (>=0.4.0)
+Project-URL: Repository, https://github.com/LukeHagar/plexpy.git
+Description-Content-Type: text/markdown
+
 # plexpy
 
 <div align="left">
@@ -139,6 +159,7 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 # Synchronous Example
 from plex_api_client import PlexAPI
 
+
 with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
 ) as plex_api:
@@ -160,6 +181,7 @@ import asyncio
 from plex_api_client import PlexAPI
 
 async def main():
+
     async with PlexAPI(
         access_token="<YOUR_API_KEY_HERE>",
     ) as plex_api:
@@ -225,7 +247,6 @@ asyncio.run(main())
 * [get_media_meta_data](https://github.com/LukeHagar/plexpy/blob/master/docs/sdks/library/README.md#get_media_meta_data) - Get Media Metadata
 * [get_metadata_children](https://github.com/LukeHagar/plexpy/blob/master/docs/sdks/library/README.md#get_metadata_children) - Get Items Children
 * [get_top_watched_content](https://github.com/LukeHagar/plexpy/blob/master/docs/sdks/library/README.md#get_top_watched_content) - Get Top Watched Content
-* [get_on_deck](https://github.com/LukeHagar/plexpy/blob/master/docs/sdks/library/README.md#get_on_deck) - Get On Deck
 
 ### [log](https://github.com/LukeHagar/plexpy/blob/master/docs/sdks/log/README.md)
 
@@ -327,6 +348,7 @@ To change the default retry strategy for a single API call, simply provide a `Re
 from plex_api_client import PlexAPI
 from plex_api_client.utils import BackoffStrategy, RetryConfig
 
+
 with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
 ) as plex_api:
@@ -346,6 +368,7 @@ If you'd like to override the default retry strategy for all operations that sup
 from plex_api_client import PlexAPI
 from plex_api_client.utils import BackoffStrategy, RetryConfig
 
+
 with PlexAPI(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     access_token="<YOUR_API_KEY_HERE>",
@@ -389,6 +412,7 @@ 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
 
+
 with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
 ) as plex_api:
@@ -420,16 +444,42 @@ with PlexAPI(
 ### Server Variables
 
 The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following parameters are available when initializing the SDK client instance:
- * `protocol: models.ServerProtocol`
- * `ip: str`
- * `port: str`
+
+| Variable   | Parameter                         | Supported Values           | Default         | Description                                    |
+| ---------- | --------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
+| `protocol` | `protocol: models.ServerProtocol` | - `"http"`<br/>- `"https"` | `"https"`       | The protocol to use for the server connection  |
+| `ip`       | `ip: str`                         | str                        | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
+| `port`     | `port: str`                       | str                        | `"32400"`       | The port of your Plex Server                   |
+
+#### Example
+
+```python
+from plex_api_client import PlexAPI
+
+
+with PlexAPI(
+    protocol="https"
+    ip="e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9"
+    port="40311"
+    access_token="<YOUR_API_KEY_HERE>",
+) as plex_api:
+
+    res = plex_api.server.get_server_capabilities()
+
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
+
+```
 
 ### Override Server URL Per-Client
 
-The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
+The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
 from plex_api_client import PlexAPI
 
+
 with PlexAPI(
     server_url="https://10.10.10.47:32400",
     access_token="<YOUR_API_KEY_HERE>",
@@ -450,6 +500,7 @@ The server URL can also be overridden on a per-operation basis, provided a serve
 ```python
 from plex_api_client import PlexAPI
 
+
 with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
 ) as plex_api:
@@ -560,6 +611,7 @@ To authenticate with the API the `access_token` parameter must be set when initi
 ```python
 from plex_api_client import PlexAPI
 
+
 with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
 ) as plex_api:
@@ -584,6 +636,7 @@ The `PlexAPI` class implements the context manager protocol and registers a fina
 ```python
 from plex_api_client import PlexAPI
 def main():
+
     with PlexAPI(
         access_token="<YOUR_API_KEY_HERE>",
     ) as plex_api:
@@ -592,6 +645,7 @@ def main():
 
 # Or when using async:
 async def amain():
+
     async with PlexAPI(
         access_token="<YOUR_API_KEY_HERE>",
     ) as plex_api:
@@ -630,3 +684,4 @@ While we value open-source contributions to this SDK, this library is generated
 Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
 
 ### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
+

plex_api_client-0.23.0/PKG-INFO → plex_api_client-0.24.1/README-PYPI.md

@@ -1,23 +1,3 @@
-Metadata-Version: 2.3
-Name: plex-api-client
-Version: 0.23.0
-Summary: Python Client SDK Generated by Speakeasy
-Author: Speakeasy
-Requires-Python: >=3.9
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.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)
-Requires-Dist: httpx (>=0.28.1)
-Requires-Dist: pydantic (>=2.10.3)
-Requires-Dist: python-dateutil (>=2.8.2)
-Requires-Dist: typing-inspect (>=0.9.0)
-Project-URL: Repository, https://github.com/LukeHagar/plexpy.git
-Description-Content-Type: text/markdown
-
 # plexpy
 
 <div align="left">
@@ -159,6 +139,7 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 # Synchronous Example
 from plex_api_client import PlexAPI
 
+
 with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
 ) as plex_api:
@@ -180,6 +161,7 @@ import asyncio
 from plex_api_client import PlexAPI
 
 async def main():
+
     async with PlexAPI(
         access_token="<YOUR_API_KEY_HERE>",
     ) as plex_api:
@@ -245,7 +227,6 @@ asyncio.run(main())
 * [get_media_meta_data](https://github.com/LukeHagar/plexpy/blob/master/docs/sdks/library/README.md#get_media_meta_data) - Get Media Metadata
 * [get_metadata_children](https://github.com/LukeHagar/plexpy/blob/master/docs/sdks/library/README.md#get_metadata_children) - Get Items Children
 * [get_top_watched_content](https://github.com/LukeHagar/plexpy/blob/master/docs/sdks/library/README.md#get_top_watched_content) - Get Top Watched Content
-* [get_on_deck](https://github.com/LukeHagar/plexpy/blob/master/docs/sdks/library/README.md#get_on_deck) - Get On Deck
 
 ### [log](https://github.com/LukeHagar/plexpy/blob/master/docs/sdks/log/README.md)
 
@@ -347,6 +328,7 @@ To change the default retry strategy for a single API call, simply provide a `Re
 from plex_api_client import PlexAPI
 from plex_api_client.utils import BackoffStrategy, RetryConfig
 
+
 with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
 ) as plex_api:
@@ -366,6 +348,7 @@ If you'd like to override the default retry strategy for all operations that sup
 from plex_api_client import PlexAPI
 from plex_api_client.utils import BackoffStrategy, RetryConfig
 
+
 with PlexAPI(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     access_token="<YOUR_API_KEY_HERE>",
@@ -409,6 +392,7 @@ 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
 
+
 with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
 ) as plex_api:
@@ -440,16 +424,42 @@ with PlexAPI(
 ### Server Variables
 
 The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following parameters are available when initializing the SDK client instance:
- * `protocol: models.ServerProtocol`
- * `ip: str`
- * `port: str`
+
+| Variable   | Parameter                         | Supported Values           | Default         | Description                                    |
+| ---------- | --------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
+| `protocol` | `protocol: models.ServerProtocol` | - `"http"`<br/>- `"https"` | `"https"`       | The protocol to use for the server connection  |
+| `ip`       | `ip: str`                         | str                        | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
+| `port`     | `port: str`                       | str                        | `"32400"`       | The port of your Plex Server                   |
+
+#### Example
+
+```python
+from plex_api_client import PlexAPI
+
+
+with PlexAPI(
+    protocol="https"
+    ip="e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9"
+    port="40311"
+    access_token="<YOUR_API_KEY_HERE>",
+) as plex_api:
+
+    res = plex_api.server.get_server_capabilities()
+
+    assert res.object is not None
+
+    # Handle response
+    print(res.object)
+
+```
 
 ### Override Server URL Per-Client
 
-The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
+The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
 from plex_api_client import PlexAPI
 
+
 with PlexAPI(
     server_url="https://10.10.10.47:32400",
     access_token="<YOUR_API_KEY_HERE>",
@@ -470,6 +480,7 @@ The server URL can also be overridden on a per-operation basis, provided a serve
 ```python
 from plex_api_client import PlexAPI
 
+
 with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
 ) as plex_api:
@@ -580,6 +591,7 @@ To authenticate with the API the `access_token` parameter must be set when initi
 ```python
 from plex_api_client import PlexAPI
 
+
 with PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
 ) as plex_api:
@@ -604,6 +616,7 @@ The `PlexAPI` class implements the context manager protocol and registers a fina
 ```python
 from plex_api_client import PlexAPI
 def main():
+
     with PlexAPI(
         access_token="<YOUR_API_KEY_HERE>",
     ) as plex_api:
@@ -612,6 +625,7 @@ def main():
 
 # Or when using async:
 async def amain():
+
     async with PlexAPI(
         access_token="<YOUR_API_KEY_HERE>",
     ) as plex_api:
@@ -650,4 +664,3 @@ While we value open-source contributions to this SDK, this library is generated
 Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
 
 ### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
-

{plex_api_client-0.23.0 → plex_api_client-0.24.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plex-api-client"
-version = "0.23.0"
+version = "0.24.1"
 description = "Python Client SDK Generated by Speakeasy"
 authors = [{ name = "Speakeasy" },]
 readme = "README-PYPI.md"
@@ -10,7 +10,7 @@ dependencies = [
     "httpx >=0.28.1",
     "pydantic >=2.10.3",
     "python-dateutil >=2.8.2",
-    "typing-inspect >=0.9.0",
+    "typing-inspection >=0.4.0",
 ]
 
 [tool.poetry]

{plex_api_client-0.23.0 → plex_api_client-0.24.1}/src/plex_api_client/_hooks/types.py

@@ -7,16 +7,19 @@ from typing import Any, Callable, List, Optional, Tuple, Union
 
 
 class HookContext:
+    base_url: str
     operation_id: str
     oauth2_scopes: Optional[List[str]] = None
     security_source: Optional[Union[Any, Callable[[], Any]]] = None
 
     def __init__(
         self,
+        base_url: str,
         operation_id: str,
         oauth2_scopes: Optional[List[str]],
         security_source: Optional[Union[Any, Callable[[], Any]]],
     ):
+        self.base_url = base_url
         self.operation_id = operation_id
         self.oauth2_scopes = oauth2_scopes
         self.security_source = security_source
@@ -25,21 +28,30 @@ class HookContext:
 class BeforeRequestContext(HookContext):
     def __init__(self, hook_ctx: HookContext):
         super().__init__(
-            hook_ctx.operation_id, hook_ctx.oauth2_scopes, hook_ctx.security_source
+            hook_ctx.base_url,
+            hook_ctx.operation_id,
+            hook_ctx.oauth2_scopes,
+            hook_ctx.security_source,
         )
 
 
 class AfterSuccessContext(HookContext):
     def __init__(self, hook_ctx: HookContext):
         super().__init__(
-            hook_ctx.operation_id, hook_ctx.oauth2_scopes, hook_ctx.security_source
+            hook_ctx.base_url,
+            hook_ctx.operation_id,
+            hook_ctx.oauth2_scopes,
+            hook_ctx.security_source,
         )
 
 
 class AfterErrorContext(HookContext):
     def __init__(self, hook_ctx: HookContext):
         super().__init__(
-            hook_ctx.operation_id, hook_ctx.oauth2_scopes, hook_ctx.security_source
+            hook_ctx.base_url,
+            hook_ctx.operation_id,
+            hook_ctx.oauth2_scopes,
+            hook_ctx.security_source,
         )
 
 

{plex_api_client-0.23.0 → plex_api_client-0.24.1}/src/plex_api_client/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "plex-api-client"
-__version__: str = "0.23.0"
+__version__: str = "0.24.1"
 __openapi_doc_version__: str = "0.0.3"
-__gen_version__: str = "2.506.0"
-__user_agent__: str = "speakeasy-sdk/python 0.23.0 2.506.0 0.0.3 plex-api-client"
+__gen_version__: str = "2.545.4"
+__user_agent__: str = "speakeasy-sdk/python 0.24.1 2.545.4 0.0.3 plex-api-client"
 
 try:
     if __package__ is not None:

{plex_api_client-0.23.0 → plex_api_client-0.24.1}/src/plex_api_client/activities.py

@@ -43,6 +43,8 @@ class Activities(BaseSDK):
 
         if server_url is not None:
             base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
         req = self._build_request(
             method="GET",
             path="/activities",
@@ -69,6 +71,7 @@ class Activities(BaseSDK):
 
         http_res = self.do_request(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="getServerActivities",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
@@ -144,6 +147,8 @@ class Activities(BaseSDK):
 
         if server_url is not None:
             base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
         req = self._build_request_async(
             method="GET",
             path="/activities",
@@ -170,6 +175,7 @@ class Activities(BaseSDK):
 
         http_res = await self.do_request_async(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="getServerActivities",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
@@ -247,6 +253,8 @@ class Activities(BaseSDK):
 
         if server_url is not None:
             base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
 
         request = operations.CancelServerActivitiesRequest(
             activity_uuid=activity_uuid,
@@ -278,6 +286,7 @@ class Activities(BaseSDK):
 
         http_res = self.do_request(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="cancelServerActivities",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
@@ -352,6 +361,8 @@ class Activities(BaseSDK):
 
         if server_url is not None:
             base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
 
         request = operations.CancelServerActivitiesRequest(
             activity_uuid=activity_uuid,
@@ -383,6 +394,7 @@ class Activities(BaseSDK):
 
         http_res = await self.do_request_async(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="cancelServerActivities",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,

{plex_api_client-0.23.0 → plex_api_client-0.24.1}/src/plex_api_client/authentication.py

@@ -40,6 +40,8 @@ class Authentication(BaseSDK):
 
         if server_url is not None:
             base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
 
         request = operations.GetTransientTokenRequest(
             type=type_,
@@ -72,6 +74,7 @@ class Authentication(BaseSDK):
 
         http_res = self.do_request(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="getTransientToken",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
@@ -149,6 +152,8 @@ class Authentication(BaseSDK):
 
         if server_url is not None:
             base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
 
         request = operations.GetTransientTokenRequest(
             type=type_,
@@ -181,6 +186,7 @@ class Authentication(BaseSDK):
 
         http_res = await self.do_request_async(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="getTransientToken",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
@@ -257,6 +263,8 @@ class Authentication(BaseSDK):
 
         if server_url is not None:
             base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
 
         request = operations.GetSourceConnectionInformationRequest(
             source=source,
@@ -288,6 +296,7 @@ class Authentication(BaseSDK):
 
         http_res = self.do_request(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="getSourceConnectionInformation",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
@@ -364,6 +373,8 @@ class Authentication(BaseSDK):
 
         if server_url is not None:
             base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
 
         request = operations.GetSourceConnectionInformationRequest(
             source=source,
@@ -395,6 +406,7 @@ class Authentication(BaseSDK):
 
         http_res = await self.do_request_async(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="getSourceConnectionInformation",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
@@ -495,6 +507,7 @@ class Authentication(BaseSDK):
 
         http_res = self.do_request(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="getTokenDetails",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
@@ -598,6 +611,7 @@ class Authentication(BaseSDK):
 
         http_res = await self.do_request_async(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="getTokenDetails",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
@@ -717,6 +731,7 @@ class Authentication(BaseSDK):
 
         http_res = self.do_request(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="post-users-sign-in-data",
                 oauth2_scopes=[],
                 security_source=None,
@@ -837,6 +852,7 @@ class Authentication(BaseSDK):
 
         http_res = await self.do_request_async(
             hook_ctx=HookContext(
+                base_url=base_url or "",
                 operation_id="post-users-sign-in-data",
                 oauth2_scopes=[],
                 security_source=None,

{plex_api_client-0.23.0 → plex_api_client-0.24.1}/src/plex_api_client/basesdk.py

@@ -232,6 +232,10 @@ class BaseSDK:
                     req.headers,
                     get_body_content(req),
                 )
+
+                if client is None:
+                    raise ValueError("client is required")
+
                 http_res = client.send(req, stream=stream)
             except Exception as e:
                 _, e = self.sdk_configuration.get_hooks().after_error(
@@ -304,6 +308,10 @@ class BaseSDK:
                     req.headers,
                     get_body_content(req),
                 )
+
+                if client is None:
+                    raise ValueError("client is required")
+
                 http_res = await client.send(req, stream=stream)
             except Exception as e:
                 _, e = self.sdk_configuration.get_hooks().after_error(