plex-api-client 0.2.0__tar.gz → 0.6.0__tar.gz

{plex-api-client-0.2.0/src/plex_api_client.egg-info → plex-api-client-0.6.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: plex-api-client
-Version: 0.2.0
+Version: 0.6.0
 Summary: Python Client SDK Generated by Speakeasy
-Home-page: UNKNOWN
+Home-page: https://github.com/LukeHagar/plexpy.git
 Author: LukeHagar
 License: UNKNOWN
 Description: # plexpy
@@ -32,6 +32,7 @@ Description: # plexpy
         
         s = plex_api.PlexAPI(
             access_token="<YOUR_API_KEY_HERE>",
+            x_plex_client_identifier='<value>',
         )
         
         
@@ -40,6 +41,7 @@ Description: # plexpy
         if res.object is not None:
             # handle response
             pass
+        
         ```
         <!-- End SDK Example Usage [usage] -->
         
@@ -129,10 +131,10 @@ Description: # plexpy
         * [add_playlist_contents](docs/sdks/playlists/README.md#add_playlist_contents) - Adding to a Playlist
         * [upload_playlist](docs/sdks/playlists/README.md#upload_playlist) - Upload Playlist
         
-        ### [security](docs/sdks/security/README.md)
+        ### [authentication](docs/sdks/authentication/README.md)
         
-        * [get_transient_token](docs/sdks/security/README.md#get_transient_token) - Get a Transient Token.
-        * [get_source_connection_information](docs/sdks/security/README.md#get_source_connection_information) - Get Source Connection Information
+        * [get_transient_token](docs/sdks/authentication/README.md#get_transient_token) - Get a Transient Token.
+        * [get_source_connection_information](docs/sdks/authentication/README.md#get_source_connection_information) - Get Source Connection Information
         
         ### [statistics](docs/sdks/statistics/README.md)
         
@@ -160,7 +162,7 @@ Description: # plexpy
         | Error Object                             | Status Code                              | Content Type                             |
         | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
         | errors.GetServerCapabilitiesResponseBody | 401                                      | application/json                         |
-        | errors.SDKError                          | 4x-5xx                                   | */*                                      |
+        | errors.SDKError                          | 4xx-5xx                                  | */*                                      |
         
         ### Example
         
@@ -170,6 +172,7 @@ Description: # plexpy
         
         s = plex_api.PlexAPI(
             access_token="<YOUR_API_KEY_HERE>",
+            x_plex_client_identifier='<value>',
         )
         
         
@@ -186,6 +189,7 @@ Description: # plexpy
         if res.object is not None:
             # handle response
             pass
+        
         ```
         <!-- End Error Handling [errors] -->
         
@@ -208,6 +212,7 @@ Description: # plexpy
         s = plex_api.PlexAPI(
             server_idx=0,
             access_token="<YOUR_API_KEY_HERE>",
+            x_plex_client_identifier='<value>',
         )
         
         
@@ -216,6 +221,7 @@ Description: # plexpy
         if res.object is not None:
             # handle response
             pass
+        
         ```
         
         #### Variables
@@ -234,6 +240,7 @@ Description: # plexpy
         s = plex_api.PlexAPI(
             server_url="{protocol}://{ip}:{port}",
             access_token="<YOUR_API_KEY_HERE>",
+            x_plex_client_identifier='<value>',
         )
         
         
@@ -242,6 +249,7 @@ Description: # plexpy
         if res.object is not None:
             # handle response
             pass
+        
         ```
         
         ### Override Server URL Per-Operation
@@ -251,15 +259,16 @@ Description: # plexpy
         import plex_api
         
         s = plex_api.PlexAPI(
-            access_token="<YOUR_API_KEY_HERE>",
+            x_plex_client_identifier='<value>',
         )
         
         
-        res = s.plex.get_pin(server_url="https://plex.tv/api/v2", x_plex_client_identifier='<value>', strong=False)
+        res = s.plex.get_pin(server_url="https://plex.tv/api/v2", strong=False, x_plex_client_identifier='<value>')
         
         if res.object is not None:
             # handle response
             pass
+        
         ```
         <!-- End Server Selection [server] -->
         
@@ -275,7 +284,7 @@ Description: # plexpy
         
         http_client = requests.Session()
         http_client.headers.update({'x-custom-header': 'someValue'})
-        s = plex_api.PlexAPI(client: http_client)
+        s = plex_api.PlexAPI(client=http_client)
         ```
         <!-- End Custom HTTP Client [http-client] -->
         
@@ -296,6 +305,7 @@ Description: # plexpy
         
         s = plex_api.PlexAPI(
             access_token="<YOUR_API_KEY_HERE>",
+            x_plex_client_identifier='<value>',
         )
         
         
@@ -304,9 +314,49 @@ Description: # plexpy
         if res.object is not None:
             # handle response
             pass
+        
         ```
         <!-- End Authentication [security] -->
         
+        <!-- Start Global Parameters [global-parameters] -->
+        ## Global Parameters
+        
+        A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
+        
+        For example, you can set `X-Plex-Client-Identifier` to `'<value>'` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_pin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
+        
+        
+        ### Available Globals
+        
+        The following global parameter is available. The required parameter must be set when you initialize the SDK client.
+        
+        | Name | Type | Required | Description |
+        | ---- | ---- |:--------:| ----------- |
+        | x_plex_client_identifier | str | ✔️ | 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)
+         |
+        
+        
+        ### Example
+        
+        ```python
+        import plex_api
+        
+        s = plex_api.PlexAPI(
+            x_plex_client_identifier='<value>',
+        )
+        
+        
+        res = s.plex.get_pin(strong=False, x_plex_client_identifier='<value>')
+        
+        if res.object is not None:
+            # handle response
+            pass
+        
+        ```
+        <!-- End Global Parameters [global-parameters] -->
+        
         <!-- Placeholder for Future Speakeasy SDK Sections -->
         
         # Development

{plex-api-client-0.2.0 → plex-api-client-0.6.0}/README.md

@@ -25,6 +25,7 @@ import plex_api
 
 s = plex_api.PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
+    x_plex_client_identifier='<value>',
 )
 
 
@@ -33,6 +34,7 @@ res = s.server.get_server_capabilities()
 if res.object is not None:
     # handle response
     pass
+
 ```
 <!-- End SDK Example Usage [usage] -->
 
@@ -122,10 +124,10 @@ if res.object is not None:
 * [add_playlist_contents](docs/sdks/playlists/README.md#add_playlist_contents) - Adding to a Playlist
 * [upload_playlist](docs/sdks/playlists/README.md#upload_playlist) - Upload Playlist
 
-### [security](docs/sdks/security/README.md)
+### [authentication](docs/sdks/authentication/README.md)
 
-* [get_transient_token](docs/sdks/security/README.md#get_transient_token) - Get a Transient Token.
-* [get_source_connection_information](docs/sdks/security/README.md#get_source_connection_information) - Get Source Connection Information
+* [get_transient_token](docs/sdks/authentication/README.md#get_transient_token) - Get a Transient Token.
+* [get_source_connection_information](docs/sdks/authentication/README.md#get_source_connection_information) - Get Source Connection Information
 
 ### [statistics](docs/sdks/statistics/README.md)
 
@@ -153,7 +155,7 @@ Handling errors in this SDK should largely match your expectations.  All operati
 | Error Object                             | Status Code                              | Content Type                             |
 | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
 | errors.GetServerCapabilitiesResponseBody | 401                                      | application/json                         |
-| errors.SDKError                          | 4x-5xx                                   | */*                                      |
+| errors.SDKError                          | 4xx-5xx                                  | */*                                      |
 
 ### Example
 
@@ -163,6 +165,7 @@ from plex_api.models import errors
 
 s = plex_api.PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
+    x_plex_client_identifier='<value>',
 )
 
 
@@ -179,6 +182,7 @@ except errors.SDKError as e:
 if res.object is not None:
     # handle response
     pass
+
 ```
 <!-- End Error Handling [errors] -->
 
@@ -201,6 +205,7 @@ import plex_api
 s = plex_api.PlexAPI(
     server_idx=0,
     access_token="<YOUR_API_KEY_HERE>",
+    x_plex_client_identifier='<value>',
 )
 
 
@@ -209,6 +214,7 @@ res = s.server.get_server_capabilities()
 if res.object is not None:
     # handle response
     pass
+
 ```
 
 #### Variables
@@ -227,6 +233,7 @@ import plex_api
 s = plex_api.PlexAPI(
     server_url="{protocol}://{ip}:{port}",
     access_token="<YOUR_API_KEY_HERE>",
+    x_plex_client_identifier='<value>',
 )
 
 
@@ -235,6 +242,7 @@ res = s.server.get_server_capabilities()
 if res.object is not None:
     # handle response
     pass
+
 ```
 
 ### Override Server URL Per-Operation
@@ -244,15 +252,16 @@ The server URL can also be overridden on a per-operation basis, provided a serve
 import plex_api
 
 s = plex_api.PlexAPI(
-    access_token="<YOUR_API_KEY_HERE>",
+    x_plex_client_identifier='<value>',
 )
 
 
-res = s.plex.get_pin(server_url="https://plex.tv/api/v2", x_plex_client_identifier='<value>', strong=False)
+res = s.plex.get_pin(server_url="https://plex.tv/api/v2", strong=False, x_plex_client_identifier='<value>')
 
 if res.object is not None:
     # handle response
     pass
+
 ```
 <!-- End Server Selection [server] -->
 
@@ -268,7 +277,7 @@ import requests
 
 http_client = requests.Session()
 http_client.headers.update({'x-custom-header': 'someValue'})
-s = plex_api.PlexAPI(client: http_client)
+s = plex_api.PlexAPI(client=http_client)
 ```
 <!-- End Custom HTTP Client [http-client] -->
 
@@ -289,6 +298,7 @@ import plex_api
 
 s = plex_api.PlexAPI(
     access_token="<YOUR_API_KEY_HERE>",
+    x_plex_client_identifier='<value>',
 )
 
 
@@ -297,9 +307,49 @@ res = s.server.get_server_capabilities()
 if res.object is not None:
     # handle response
     pass
+
 ```
 <!-- End Authentication [security] -->
 
+<!-- Start Global Parameters [global-parameters] -->
+## Global Parameters
+
+A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
+
+For example, you can set `X-Plex-Client-Identifier` to `'<value>'` at SDK initialization and then you do not have to pass the same value on calls to operations like `get_pin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
+
+
+### Available Globals
+
+The following global parameter is available. The required parameter must be set when you initialize the SDK client.
+
+| Name | Type | Required | Description |
+| ---- | ---- |:--------:| ----------- |
+| x_plex_client_identifier | str | ✔️ | 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)
+ |
+
+
+### Example
+
+```python
+import plex_api
+
+s = plex_api.PlexAPI(
+    x_plex_client_identifier='<value>',
+)
+
+
+res = s.plex.get_pin(strong=False, x_plex_client_identifier='<value>')
+
+if res.object is not None:
+    # handle response
+    pass
+
+```
+<!-- End Global Parameters [global-parameters] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 # Development

{plex-api-client-0.2.0 → plex-api-client-0.6.0}/setup.py

@@ -10,18 +10,19 @@ except FileNotFoundError:
 
 setuptools.setup(
     name="plex-api-client",
-    version="0.2.0",
+    version="0.6.0",
     author="LukeHagar",
     description="Python Client SDK Generated by Speakeasy",
+    url="https://github.com/LukeHagar/plexpy.git",
     long_description=long_description,
     long_description_content_type="text/markdown",
     packages=setuptools.find_packages(where="src"),
     install_requires=[
         "certifi>=2023.7.22",
         "charset-normalizer>=3.2.0",
-        "dataclasses-json-speakeasy>=0.5.11",
+        "dataclasses-json>=0.6.4",
         "idna>=3.4",
-        "jsonpath-python>=1.0.6 ",
+        "jsonpath-python>=1.0.6",
         "marshmallow>=3.19.0",
         "mypy-extensions>=1.0.0",
         "packaging>=23.1",
@@ -33,7 +34,9 @@ setuptools.setup(
         "urllib3>=1.26.18",
     ],
     extras_require={
-        "dev":["pylint==2.16.2"]
+        "dev": [
+            "pylint==2.16.2",
+        ],
     },
     package_dir={'': 'src'},
     python_requires='>=3.8',

plex-api-client-0.6.0/src/plex_api/_hooks/__init__.py

@@ -0,0 +1,5 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
+from .sdkhooks import *
+from .types import *
+from .registration import *

plex-api-client-0.6.0/src/plex_api/_hooks/registration.py

@@ -0,0 +1,13 @@
+from .types import Hooks
+
+
+# This file is only ever generated once on the first generation and then is free to be modified.
+# Any hooks you wish to add should be registered in the init_hooks function. Feel free to define them
+# in this file or in separate files in the hooks folder.
+
+
+def init_hooks(hooks: Hooks):
+    # pylint: disable=unused-argument
+    """Add hooks by calling hooks.register{sdk_init/before_request/after_success/after_error}Hook 
+    with an instance of a hook that implements that specific Hook interface
+    Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance"""

plex-api-client-0.6.0/src/plex_api/_hooks/sdkhooks.py

@@ -0,0 +1,57 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
+import requests
+from .types import SDKInitHook, BeforeRequestContext, BeforeRequestHook, AfterSuccessContext, AfterSuccessHook, AfterErrorContext, AfterErrorHook, Hooks
+from .registration import init_hooks
+from typing import List, Optional, Tuple
+
+
+class SDKHooks(Hooks):
+    def __init__(self):
+        self.sdk_init_hooks: List[SDKInitHook] = []
+        self.before_request_hooks: List[BeforeRequestHook] = []
+        self.after_success_hooks: List[AfterSuccessHook] = []
+        self.after_error_hooks: List[AfterErrorHook] = []
+        init_hooks(self)
+
+    def register_sdk_init_hook(self, hook: SDKInitHook) -> None:
+        self.sdk_init_hooks.append(hook)
+
+    def register_before_request_hook(self, hook: BeforeRequestHook) -> None:
+        self.before_request_hooks.append(hook)
+
+    def register_after_success_hook(self, hook: AfterSuccessHook) -> None:
+        self.after_success_hooks.append(hook)
+
+    def register_after_error_hook(self, hook: AfterErrorHook) -> None:
+        self.after_error_hooks.append(hook)
+
+    def sdk_init(self, base_url: str, client: requests.Session) -> Tuple[str, requests.Session]:
+        for hook in self.sdk_init_hooks:
+            base_url, client = hook.sdk_init(base_url, client)
+        return base_url, client
+
+    def before_request(self, hook_ctx: BeforeRequestContext, request: requests.PreparedRequest) -> requests.PreparedRequest:
+        for hook in self.before_request_hooks:
+            out = hook.before_request(hook_ctx, request)
+            if isinstance(out, Exception):
+                raise out
+            request = out
+
+        return request
+
+    def after_success(self, hook_ctx: AfterSuccessContext, response: requests.Response) -> requests.Response:
+        for hook in self.after_success_hooks:
+            out = hook.after_success(hook_ctx, response)
+            if isinstance(out, Exception):
+                raise out
+            response = out
+        return response
+
+    def after_error(self, hook_ctx: AfterErrorContext, response: Optional[requests.Response], error: Optional[Exception]) -> Tuple[Optional[requests.Response], Optional[Exception]]:
+        for hook in self.after_error_hooks:
+            result = hook.after_error(hook_ctx, response, error)
+            if isinstance(result, Exception):
+                raise result
+            response, error = result
+        return response, error

plex-api-client-0.6.0/src/plex_api/_hooks/types.py

@@ -0,0 +1,74 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
+import requests as requests_http
+from abc import ABC, abstractmethod
+from typing import Any, Callable, List, Optional, Tuple, Union
+
+
+class HookContext:
+    operation_id: str
+    oauth2_scopes: Optional[List[str]] = None
+    security_source: Optional[Union[Any, Callable[[], Any]]] = None
+
+    def __init__(self, operation_id: str, oauth2_scopes: Optional[List[str]], security_source: Optional[Union[Any, Callable[[], Any]]]):
+        self.operation_id = operation_id
+        self.oauth2_scopes = oauth2_scopes
+        self.security_source = security_source
+
+
+class BeforeRequestContext(HookContext):
+    def __init__(self, hook_ctx: HookContext):
+        super().__init__(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)
+    
+
+
+class AfterErrorContext(HookContext):
+    def __init__(self, hook_ctx: HookContext):
+        super().__init__(hook_ctx.operation_id, hook_ctx.oauth2_scopes, hook_ctx.security_source)
+
+
+class SDKInitHook(ABC):
+    @abstractmethod
+    def sdk_init(self, base_url: str, client: requests_http.Session) -> Tuple[str, requests_http.Session]:
+        pass
+
+
+class BeforeRequestHook(ABC):
+    @abstractmethod
+    def before_request(self, hook_ctx: BeforeRequestContext, request: requests_http.PreparedRequest) -> Union[requests_http.PreparedRequest, Exception]:
+        pass
+
+
+class AfterSuccessHook(ABC):
+    @abstractmethod
+    def after_success(self, hook_ctx: AfterSuccessContext, response: requests_http.Response) -> Union[requests_http.Response, Exception]:
+        pass
+
+
+class AfterErrorHook(ABC):
+    @abstractmethod
+    def after_error(self, hook_ctx: AfterErrorContext, response: Optional[requests_http.Response], error: Optional[Exception]) -> Union[Tuple[Optional[requests_http.Response], Optional[Exception]], Exception]:
+        pass
+
+
+class Hooks(ABC):
+    @abstractmethod
+    def register_sdk_init_hook(self, hook: SDKInitHook):
+        pass
+
+    @abstractmethod
+    def register_before_request_hook(self, hook: BeforeRequestHook):
+        pass
+
+    @abstractmethod
+    def register_after_success_hook(self, hook: AfterSuccessHook):
+        pass
+
+    @abstractmethod
+    def register_after_error_hook(self, hook: AfterErrorHook):
+        pass