plex-api-client 0.16.0__tar.gz → 0.17.1__tar.gz

{plex_api_client-0.16.0 → plex_api_client-0.17.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plex-api-client
-Version: 0.16.0
+Version: 0.17.1
 Summary: Python Client SDK Generated by Speakeasy
 Home-page: https://github.com/LukeHagar/plexpy.git
 Author: Speakeasy
@@ -347,13 +347,24 @@ if res.object is not None:
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Handling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
+Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
 
-| Error Object                             | Status Code                              | Content Type                             |
+By default, an API error will raise a errors.SDKError exception, which has the following properties:
+
+| Property        | Type             | Description           |
+|-----------------|------------------|-----------------------|
+| `.status_code`  | *int*            | The HTTP status code  |
+| `.message`      | *str*            | The error message     |
+| `.raw_response` | *httpx.Response* | The raw HTTP response |
+| `.body`         | *str*            | The response content  |
+
+When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `get_server_capabilities_async` method may raise the following exceptions:
+
+| Error Type                               | Status Code                              | Content Type                             |
 | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
 | errors.GetServerCapabilitiesBadRequest   | 400                                      | application/json                         |
 | errors.GetServerCapabilitiesUnauthorized | 401                                      | application/json                         |
-| errors.SDKError                          | 4xx-5xx                                  | */*                                      |
+| errors.SDKError                          | 4XX, 5XX                                 | \*/\*                                    |
 
 ### Example
 
@@ -607,10 +618,7 @@ The following global parameters are available.
 
 | Name | Type | Required | Description |
 | ---- | ---- |:--------:| ----------- |
-| 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_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. |

{plex_api_client-0.16.0 → plex_api_client-0.17.1}/README-PYPI.md

@@ -325,13 +325,24 @@ if res.object is not None:
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Handling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
+Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
 
-| Error Object                             | Status Code                              | Content Type                             |
+By default, an API error will raise a errors.SDKError exception, which has the following properties:
+
+| Property        | Type             | Description           |
+|-----------------|------------------|-----------------------|
+| `.status_code`  | *int*            | The HTTP status code  |
+| `.message`      | *str*            | The error message     |
+| `.raw_response` | *httpx.Response* | The raw HTTP response |
+| `.body`         | *str*            | The response content  |
+
+When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `get_server_capabilities_async` method may raise the following exceptions:
+
+| Error Type                               | Status Code                              | Content Type                             |
 | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
 | errors.GetServerCapabilitiesBadRequest   | 400                                      | application/json                         |
 | errors.GetServerCapabilitiesUnauthorized | 401                                      | application/json                         |
-| errors.SDKError                          | 4xx-5xx                                  | */*                                      |
+| errors.SDKError                          | 4XX, 5XX                                 | \*/\*                                    |
 
 ### Example
 
@@ -585,10 +596,7 @@ The following global parameters are available.
 
 | Name | Type | Required | Description |
 | ---- | ---- |:--------:| ----------- |
-| 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_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. |

{plex_api_client-0.16.0 → plex_api_client-0.17.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "plex-api-client"
-version = "0.16.0"
+version = "0.17.1"
 description = "Python Client SDK Generated by Speakeasy"
 authors = ["Speakeasy",]
 readme = "README-PYPI.md"
@@ -28,9 +28,6 @@ typing-inspect = "^0.9.0"
 [tool.poetry.group.dev.dependencies]
 mypy = "==1.10.1"
 pylint = "==3.2.3"
-pytest = "^8.2.0"
-pytest-asyncio = "^0.23.7"
-pytest-xdist = "^3.6.1"
 types-python-dateutil = "^2.9.0.20240316"
 
 [build-system]

{plex_api_client-0.16.0 → plex_api_client-0.17.1}/src/plex_api_client/models/internal/globals.py

@@ -10,11 +10,7 @@ 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)
-
-    """
+    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]
@@ -27,11 +23,7 @@ class Globals(BaseModel):
         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)
-
-    """
+    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],

{plex_api_client-0.16.0 → plex_api_client-0.17.1}/src/plex_api_client/models/operations/get_server_resources.py

@@ -18,11 +18,7 @@ GET_SERVER_RESOURCES_SERVERS = [
 
 class GetServerResourcesGlobalsTypedDict(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)
-
-    """
+    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)"""
 
 
 class GetServerResourcesGlobals(BaseModel):
@@ -31,11 +27,7 @@ class GetServerResourcesGlobals(BaseModel):
         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)
-
-    """
+    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)"""
 
 
 class IncludeHTTPS(int, Enum):
@@ -73,11 +65,7 @@ class GetServerResourcesRequestTypedDict(TypedDict):
     include_i_pv6: NotRequired[IncludeIPv6]
     r"""Include IPv6 entries in the results"""
     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)
-
-    """
+    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)"""
 
 
 class GetServerResourcesRequest(BaseModel):
@@ -110,11 +98,7 @@ class GetServerResourcesRequest(BaseModel):
         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)
-
-    """
+    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)"""
 
 
 class Protocol(str, Enum):

{plex_api_client-0.16.0 → plex_api_client-0.17.1}/src/plex_api_client/models/operations/getpin.py

@@ -23,11 +23,7 @@ GET_PIN_SERVERS = [
 
 class GetPinGlobalsTypedDict(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)
-
-    """
+    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]
     device_name: NotRequired[str]
     client_version: NotRequired[str]
@@ -40,11 +36,7 @@ class GetPinGlobals(BaseModel):
         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)
-
-    """
+    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],
@@ -79,11 +71,7 @@ class GetPinRequestTypedDict(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)
-
-    """
+    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]
     device_name: NotRequired[str]
     client_version: NotRequired[str]
@@ -106,11 +94,7 @@ class GetPinRequest(BaseModel):
         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)
-
-    """
+    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],

{plex_api_client-0.16.0 → plex_api_client-0.17.1}/src/plex_api_client/models/operations/gettokenbypinid.py

@@ -23,11 +23,7 @@ GET_TOKEN_BY_PIN_ID_SERVERS = [
 
 class GetTokenByPinIDGlobalsTypedDict(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)
-
-    """
+    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]
     device_name: NotRequired[str]
     client_version: NotRequired[str]
@@ -40,11 +36,7 @@ class GetTokenByPinIDGlobals(BaseModel):
         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)
-
-    """
+    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],
@@ -75,11 +67,7 @@ class GetTokenByPinIDRequestTypedDict(TypedDict):
     pin_id: int
     r"""The PinID to retrieve an access token for"""
     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)
-
-    """
+    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]
     device_name: NotRequired[str]
     client_version: NotRequired[str]
@@ -99,11 +87,7 @@ class GetTokenByPinIDRequest(BaseModel):
         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)
-
-    """
+    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],

{plex_api_client-0.16.0 → plex_api_client-0.17.1}/src/plex_api_client/models/operations/post_users_sign_in_data.py

@@ -31,11 +31,7 @@ POST_USERS_SIGN_IN_DATA_SERVERS = [
 
 class PostUsersSignInDataGlobalsTypedDict(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)
-
-    """
+    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]
     device_name: NotRequired[str]
     client_version: NotRequired[str]
@@ -48,11 +44,7 @@ class PostUsersSignInDataGlobals(BaseModel):
         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)
-
-    """
+    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],
@@ -108,11 +100,7 @@ class PostUsersSignInDataRequestBody(BaseModel):
 
 class PostUsersSignInDataRequestTypedDict(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)
-
-    """
+    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]
     device_name: NotRequired[str]
     client_version: NotRequired[str]
@@ -127,11 +115,7 @@ class PostUsersSignInDataRequest(BaseModel):
         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)
-
-    """
+    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],

{plex_api_client-0.16.0 → plex_api_client-0.17.1}/src/plex_api_client/plex.py

@@ -761,7 +761,7 @@ class Plex(BaseSDK):
         :param include_https: Include Https entries in the results
         :param include_relay: Include Relay addresses in the results  E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
         :param include_i_pv6: Include IPv6 entries in the results
-        :param client_id: 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 client_id: 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 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
@@ -879,7 +879,7 @@ class Plex(BaseSDK):
         :param include_https: Include Https entries in the results
         :param include_relay: Include Relay addresses in the results  E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
         :param include_i_pv6: Include IPv6 entries in the results
-        :param client_id: 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 client_id: 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 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

{plex_api_client-0.16.0 → plex_api_client-0.17.1}/src/plex_api_client/sdkconfiguration.py

@@ -39,9 +39,9 @@ class SDKConfiguration:
     server_defaults: List[Dict[str, str]] = field(default_factory=List)
     language: str = "python"
     openapi_doc_version: str = "0.0.3"
-    sdk_version: str = "0.16.0"
-    gen_version: str = "2.426.2"
-    user_agent: str = "speakeasy-sdk/python 0.16.0 2.426.2 0.0.3 plex-api-client"
+    sdk_version: str = "0.17.1"
+    gen_version: str = "2.428.1"
+    user_agent: str = "speakeasy-sdk/python 0.17.1 2.428.1 0.0.3 plex-api-client"
     retry_config: OptionalNullable[RetryConfig] = Field(default_factory=lambda: UNSET)
     timeout_ms: Optional[int] = None