plex-api-client 0.12.1__tar.gz → 0.13.0__tar.gz

{plex_api_client-0.12.1 → plex_api_client-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plex-api-client
-Version: 0.12.1
+Version: 0.13.0
 Summary: Python Client SDK Generated by Speakeasy
 Home-page: https://github.com/LukeHagar/plexpy.git
 Author: Speakeasy
@@ -94,7 +94,11 @@ from plex_api_client import PlexAPI
 
 s = PlexAPI(
     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()
@@ -115,7 +119,11 @@ from plex_api_client import PlexAPI
 async def main():
     s = PlexAPI(
         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()
     if res.object is not None:
@@ -270,7 +278,11 @@ from plex_api_client import PlexAPI
 
 s = PlexAPI(
     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(,
@@ -290,7 +302,11 @@ from plex_api_client import PlexAPI
 s = PlexAPI(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     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()
@@ -321,7 +337,11 @@ from plex_api_client.models import errors
 
 s = PlexAPI(
     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
@@ -363,7 +383,11 @@ from plex_api_client import PlexAPI
 s = PlexAPI(
     server_idx=0,
     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()
@@ -390,7 +414,11 @@ from plex_api_client import PlexAPI
 s = PlexAPI(
     server_url="{protocol}://{ip}:{port}",
     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()
@@ -409,7 +437,11 @@ from plex_api_client import PlexAPI
 
 s = PlexAPI(
     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/")
@@ -519,7 +551,11 @@ from plex_api_client import PlexAPI
 
 s = PlexAPI(
     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()
@@ -534,37 +570,43 @@ if res.object is not None:
 <!-- Start 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_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 following global parameters are available.
 
 | 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
 (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
 
 ```python
 from plex_api_client import PlexAPI
-from plex_api_client.models import operations
 
 s = PlexAPI(
-    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_pin(request={})
 
-if res.plex_devices is not None:
+if res.auth_pin_container is not None:
     # handle response
     pass
 

{plex_api_client-0.12.1 → plex_api_client-0.13.0}/README-PYPI.md

@@ -72,7 +72,11 @@ from plex_api_client import PlexAPI
 
 s = PlexAPI(
     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()
@@ -93,7 +97,11 @@ from plex_api_client import PlexAPI
 async def main():
     s = PlexAPI(
         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()
     if res.object is not None:
@@ -248,7 +256,11 @@ from plex_api_client import PlexAPI
 
 s = PlexAPI(
     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(,
@@ -268,7 +280,11 @@ from plex_api_client import PlexAPI
 s = PlexAPI(
     retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
     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()
@@ -299,7 +315,11 @@ from plex_api_client.models import errors
 
 s = PlexAPI(
     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
@@ -341,7 +361,11 @@ from plex_api_client import PlexAPI
 s = PlexAPI(
     server_idx=0,
     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()
@@ -368,7 +392,11 @@ from plex_api_client import PlexAPI
 s = PlexAPI(
     server_url="{protocol}://{ip}:{port}",
     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()
@@ -387,7 +415,11 @@ from plex_api_client import PlexAPI
 
 s = PlexAPI(
     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/")
@@ -497,7 +529,11 @@ from plex_api_client import PlexAPI
 
 s = PlexAPI(
     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()
@@ -512,37 +548,43 @@ if res.object is not None:
 <!-- Start 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_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 following global parameters are available.
 
 | 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
 (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
 
 ```python
 from plex_api_client import PlexAPI
-from plex_api_client.models import operations
 
 s = PlexAPI(
-    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_pin(request={})
 
-if res.plex_devices is not None:
+if res.auth_pin_container is not None:
     # handle response
     pass
 

{plex_api_client-0.12.1 → plex_api_client-0.13.0}/pyproject.toml

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

{plex_api_client-0.12.1 → plex_api_client-0.13.0}/src/plex_api_client/authentication.py

@@ -4,8 +4,8 @@ from .basesdk import BaseSDK
 from plex_api_client import utils
 from plex_api_client._hooks import HookContext
 from plex_api_client.models import errors, operations
-from plex_api_client.types import OptionalNullable, UNSET
-from typing import Any, Optional, Union
+from plex_api_client.types import BaseModel, OptionalNullable, UNSET
+from typing import Any, Optional, Union, cast
 
 
 class Authentication(BaseSDK):
@@ -592,8 +592,7 @@ class Authentication(BaseSDK):
     def post_users_sign_in_data(
         self,
         *,
-        x_plex_client_identifier: Optional[str] = None,
-        request_body: Optional[
+        request: Optional[
             Union[
                 operations.PostUsersSignInDataRequestBody,
                 operations.PostUsersSignInDataRequestBodyTypedDict,
@@ -607,8 +606,7 @@ class Authentication(BaseSDK):
 
         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 request_body: Login credentials
+        :param request: The request object to send.
         :param retries: Override the default retry configuration 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
@@ -623,12 +621,11 @@ class Authentication(BaseSDK):
         else:
             base_url = operations.POST_USERS_SIGN_IN_DATA_SERVERS[0]
 
-        request = operations.PostUsersSignInDataRequest(
-            x_plex_client_identifier=x_plex_client_identifier,
-            request_body=utils.get_pydantic_model(
-                request_body, Optional[operations.PostUsersSignInDataRequestBody]
-            ),
-        )
+        if not isinstance(request, BaseModel):
+            request = utils.unmarshal(
+                request, Optional[operations.PostUsersSignInDataRequestBody]
+            )
+        request = cast(Optional[operations.PostUsersSignInDataRequestBody], request)
 
         req = self.build_request(
             method="POST",
@@ -638,14 +635,11 @@ class Authentication(BaseSDK):
             request=request,
             request_body_required=False,
             request_has_path_params=False,
-            request_has_query_params=True,
+            request_has_query_params=False,
             user_agent_header="user-agent",
             accept_header_value="application/json",
-            _globals=operations.PostUsersSignInDataGlobals(
-                x_plex_client_identifier=self.sdk_configuration.globals.x_plex_client_identifier,
-            ),
             get_serialized_body=lambda: utils.serialize_request_body(
-                request.request_body,
+                request,
                 False,
                 True,
                 "form",
@@ -712,8 +706,7 @@ class Authentication(BaseSDK):
     async def post_users_sign_in_data_async(
         self,
         *,
-        x_plex_client_identifier: Optional[str] = None,
-        request_body: Optional[
+        request: Optional[
             Union[
                 operations.PostUsersSignInDataRequestBody,
                 operations.PostUsersSignInDataRequestBodyTypedDict,
@@ -727,8 +720,7 @@ class Authentication(BaseSDK):
 
         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 request_body: Login credentials
+        :param request: The request object to send.
         :param retries: Override the default retry configuration 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
@@ -743,12 +735,11 @@ class Authentication(BaseSDK):
         else:
             base_url = operations.POST_USERS_SIGN_IN_DATA_SERVERS[0]
 
-        request = operations.PostUsersSignInDataRequest(
-            x_plex_client_identifier=x_plex_client_identifier,
-            request_body=utils.get_pydantic_model(
-                request_body, Optional[operations.PostUsersSignInDataRequestBody]
-            ),
-        )
+        if not isinstance(request, BaseModel):
+            request = utils.unmarshal(
+                request, Optional[operations.PostUsersSignInDataRequestBody]
+            )
+        request = cast(Optional[operations.PostUsersSignInDataRequestBody], request)
 
         req = self.build_request_async(
             method="POST",
@@ -758,14 +749,11 @@ class Authentication(BaseSDK):
             request=request,
             request_body_required=False,
             request_has_path_params=False,
-            request_has_query_params=True,
+            request_has_query_params=False,
             user_agent_header="user-agent",
             accept_header_value="application/json",
-            _globals=operations.PostUsersSignInDataGlobals(
-                x_plex_client_identifier=self.sdk_configuration.globals.x_plex_client_identifier,
-            ),
             get_serialized_body=lambda: utils.serialize_request_body(
-                request.request_body,
+                request,
                 False,
                 True,
                 "form",

{plex_api_client-0.12.1 → plex_api_client-0.13.0}/src/plex_api_client/models/components/security.py

@@ -18,7 +18,7 @@ class Security(BaseModel):
             security=SecurityMetadata(
                 scheme=True,
                 scheme_type="apiKey",
-                sub_type="query",
+                sub_type="header",
                 field_name="X-Plex-Token",
             )
         ),

plex_api_client-0.13.0/src/plex_api_client/models/internal/globals.py

@@ -0,0 +1,58 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from plex_api_client.types import BaseModel
+from plex_api_client.utils import FieldMetadata, QueryParamMetadata
+import pydantic
+from typing import Optional, TypedDict
+from typing_extensions import Annotated, NotRequired
+
+
+class GlobalsTypedDict(TypedDict):
+    client_id: NotRequired[str]
+    r"""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)
+
+    """
+    client_name: NotRequired[str]
+    client_version: NotRequired[str]
+    client_platform: NotRequired[str]
+    device_name: NotRequired[str]
+
+
+class Globals(BaseModel):
+    client_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="X-Plex-Client-Identifier"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""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)
+
+    """
+
+    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