plex-api-client 0.36.0__tar.gz → 0.36.1__tar.gz

{plex_api_client-0.36.0 → plex_api_client-0.36.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plex-api-client
-Version: 0.36.0
+Version: 0.36.1
 Summary: Python Client SDK Generated by Speakeasy
 License-File: LICENSE.md
 Author: Speakeasy

{plex_api_client-0.36.0 → plex_api_client-0.36.1}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "plex-api-client"
-version = "0.36.0"
+version = "0.36.1"
 description = "Python Client SDK Generated by Speakeasy"
 authors = [{ name = "Speakeasy" },]
 readme = "README-PYPI.md"

{plex_api_client-0.36.0 → plex_api_client-0.36.1}/src/plex_api_client/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "plex-api-client"
-__version__: str = "0.36.0"
+__version__: str = "0.36.1"
 __openapi_doc_version__: str = "1.1.1"
-__gen_version__: str = "2.932.9"
-__user_agent__: str = "speakeasy-sdk/python 0.36.0 2.932.9 1.1.1 plex-api-client"
+__gen_version__: str = "2.948.4"
+__user_agent__: str = "speakeasy-sdk/python 0.36.1 2.948.4 1.1.1 plex-api-client"
 
 try:
     if __package__ is not None:

{plex_api_client-0.36.0 → plex_api_client-0.36.1}/src/plex_api_client/models/operations/listcontent.py

@@ -179,6 +179,10 @@ class ListContentRequestTypedDict(TypedDict):
     r"""A friendly name for the client"""
     marketplace: NotRequired[str]
     r"""The marketplace on which the client application is distributed"""
+    pms_api_version: NotRequired[str]
+    r"""The PMS API version requested by the client. If omitted, the server assumes `0.0`.
+    Use `1.0` for the published PMS API response customization behavior.
+    """
     x_plex_container_start: NotRequired[int]
     r"""The index of the first item to return. If not specified, the first item will be returned.
     If the number of items exceeds the limit, the response will be paginated.
@@ -207,6 +211,34 @@ class ListContentRequestTypedDict(TypedDict):
 
     See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.
     """
+    updated_at_after: NotRequired[int]
+    r"""Return current items whose updatedAt is strictly greater than this Unix timestamp in seconds.
+    The query key is updatedAt>> (URL-encoded as updatedAt%3E%3E), for example updatedAt%3E%3E=1792000000.
+    Items updated exactly at the supplied timestamp are excluded; overlap polling windows and deduplicate ratingKey values to avoid missing same-second updates.
+    Verified for movies, episodes, and tracks on PMS 1.43.4.10903. Support on other server versions and library types may vary.
+    This filters current items, not a durable change log: deleted items are not returned, and it does not guarantee that every file, part, or stream change updates the parent timestamp.
+    """
+    updated_at_before: NotRequired[int]
+    r"""Return current items whose updatedAt is strictly less than this Unix timestamp in seconds.
+    The query key is updatedAt<< (URL-encoded as updatedAt%3C%3C), for example updatedAt%3C%3C=1792054845.
+    Items updated exactly at the supplied timestamp are excluded. Combine with updatedAt>> to request a bounded interval; both conditions must match.
+    Verified for movies on PMS 1.43.4.10903. Support on other server versions and library types may vary.
+    This filters current items and does not provide an atomic snapshot, a replay cursor, or deleted items.
+    """
+    added_at_after: NotRequired[int]
+    r"""Return current items whose addedAt is strictly greater than this Unix timestamp in seconds.
+    The query key is addedAt>> (URL-encoded as addedAt%3E%3E), for example addedAt%3E%3E=1791200000.
+    Items added exactly at the supplied timestamp are excluded; overlap polling windows and deduplicate ratingKey values to avoid missing same-second additions.
+    Verified for movies on PMS 1.43.4.10903. Support on other server versions and library types may vary.
+    This filters surviving additions only; it does not identify later metadata updates or deleted items.
+    """
+    added_at_before: NotRequired[int]
+    r"""Return current items whose addedAt is strictly less than this Unix timestamp in seconds.
+    The query key is addedAt<< (URL-encoded as addedAt%3C%3C), for example addedAt%3C%3C=1791252847.
+    Items added exactly at the supplied timestamp are excluded. Combine with addedAt>> to request a bounded interval; both conditions must match.
+    Support on server versions and library types may vary.
+    This filters surviving additions only; it does not identify later metadata updates or deleted items, or provide an atomic snapshot.
+    """
     include_meta: NotRequired[components_boolint.BoolInt]
     r"""Adds the Meta object to the response"""
     include_guids: NotRequired[components_boolint.BoolInt]
@@ -254,7 +286,12 @@ class ListContentRequestTypedDict(TypedDict):
     include_theme: NotRequired[components_boolint.BoolInt]
     r"""Force inclusion of theme fields"""
     include_fields: NotRequired[str]
-    r"""Whitelist of fields to return"""
+    r"""Comma-separated whitelist of fields to return.
+    With PMS API version 1.0.0 or later, this projection also applies to container attributes.
+    Include size,totalSize,offset alongside item fields when paging, for example ratingKey,updatedAt,size,totalSize,offset.
+    Otherwise the response may omit the pagination attributes needed to determine whether the complete result has been retrieved.
+    This does not necessarily remove nested elements; use excludeElements to request their exclusion.
+    """
     exclude_fields: NotRequired[str]
     r"""Blacklist of fields to omit"""
     async_augment_metadata: NotRequired[components_boolint.BoolInt]
@@ -265,6 +302,11 @@ class ListContentRequestTypedDict(TypedDict):
     r"""Bypass cache"""
     skip_refresh: NotRequired[components_boolint.BoolInt]
     r"""Skip synchronous refresh"""
+    include_optional_elements: NotRequired[str]
+    r"""Comma-separated list of optional elements to add to the response.
+    Use `Stream` to request stream metadata within returned media parts.
+    Unlike `includeElements`, this adds optional elements without excluding the normal response elements.
+    """
     exclude_elements: NotRequired[str]
     r"""Comma-separated list of elements to exclude from the response"""
     filters: NotRequired[str]
@@ -369,6 +411,15 @@ class ListContentRequest(BaseModel):
     ] = None
     r"""The marketplace on which the client application is distributed"""
 
+    pms_api_version: Annotated[
+        Optional[str],
+        pydantic.Field(alias="X-Plex-Pms-Api-Version"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ] = None
+    r"""The PMS API version requested by the client. If omitted, the server assumes `0.0`.
+    Use `1.0` for the published PMS API response customization behavior.
+    """
+
     x_plex_container_start: Annotated[
         Optional[int],
         pydantic.Field(alias="X-Plex-Container-Start"),
@@ -412,6 +463,54 @@ class ListContentRequest(BaseModel):
     See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries.
     """
 
+    updated_at_after: Annotated[
+        Optional[int],
+        pydantic.Field(alias="updatedAt>>"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Return current items whose updatedAt is strictly greater than this Unix timestamp in seconds.
+    The query key is updatedAt>> (URL-encoded as updatedAt%3E%3E), for example updatedAt%3E%3E=1792000000.
+    Items updated exactly at the supplied timestamp are excluded; overlap polling windows and deduplicate ratingKey values to avoid missing same-second updates.
+    Verified for movies, episodes, and tracks on PMS 1.43.4.10903. Support on other server versions and library types may vary.
+    This filters current items, not a durable change log: deleted items are not returned, and it does not guarantee that every file, part, or stream change updates the parent timestamp.
+    """
+
+    updated_at_before: Annotated[
+        Optional[int],
+        pydantic.Field(alias="updatedAt<<"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Return current items whose updatedAt is strictly less than this Unix timestamp in seconds.
+    The query key is updatedAt<< (URL-encoded as updatedAt%3C%3C), for example updatedAt%3C%3C=1792054845.
+    Items updated exactly at the supplied timestamp are excluded. Combine with updatedAt>> to request a bounded interval; both conditions must match.
+    Verified for movies on PMS 1.43.4.10903. Support on other server versions and library types may vary.
+    This filters current items and does not provide an atomic snapshot, a replay cursor, or deleted items.
+    """
+
+    added_at_after: Annotated[
+        Optional[int],
+        pydantic.Field(alias="addedAt>>"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Return current items whose addedAt is strictly greater than this Unix timestamp in seconds.
+    The query key is addedAt>> (URL-encoded as addedAt%3E%3E), for example addedAt%3E%3E=1791200000.
+    Items added exactly at the supplied timestamp are excluded; overlap polling windows and deduplicate ratingKey values to avoid missing same-second additions.
+    Verified for movies on PMS 1.43.4.10903. Support on other server versions and library types may vary.
+    This filters surviving additions only; it does not identify later metadata updates or deleted items.
+    """
+
+    added_at_before: Annotated[
+        Optional[int],
+        pydantic.Field(alias="addedAt<<"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Return current items whose addedAt is strictly less than this Unix timestamp in seconds.
+    The query key is addedAt<< (URL-encoded as addedAt%3C%3C), for example addedAt%3C%3C=1791252847.
+    Items added exactly at the supplied timestamp are excluded. Combine with addedAt>> to request a bounded interval; both conditions must match.
+    Support on server versions and library types may vary.
+    This filters surviving additions only; it does not identify later metadata updates or deleted items, or provide an atomic snapshot.
+    """
+
     include_meta: Annotated[
         Optional[components_boolint.BoolInt],
         pydantic.Field(alias="includeMeta"),
@@ -578,7 +677,12 @@ class ListContentRequest(BaseModel):
         pydantic.Field(alias="includeFields"),
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""Whitelist of fields to return"""
+    r"""Comma-separated whitelist of fields to return.
+    With PMS API version 1.0.0 or later, this projection also applies to container attributes.
+    Include size,totalSize,offset alongside item fields when paging, for example ratingKey,updatedAt,size,totalSize,offset.
+    Otherwise the response may omit the pagination attributes needed to determine whether the complete result has been retrieved.
+    This does not necessarily remove nested elements; use excludeElements to request their exclusion.
+    """
 
     exclude_fields: Annotated[
         Optional[str],
@@ -614,6 +718,16 @@ class ListContentRequest(BaseModel):
     ] = components_boolint.BoolInt.FALSE
     r"""Skip synchronous refresh"""
 
+    include_optional_elements: Annotated[
+        Optional[str],
+        pydantic.Field(alias="includeOptionalElements"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Comma-separated list of optional elements to add to the response.
+    Use `Stream` to request stream metadata within returned media parts.
+    Unlike `includeElements`, this adds optional elements without excluding the normal response elements.
+    """
+
     exclude_elements: Annotated[
         Optional[str],
         pydantic.Field(alias="excludeElements"),
@@ -686,9 +800,14 @@ class ListContentRequest(BaseModel):
                 "Device-Vendor",
                 "Device-Name",
                 "Marketplace",
+                "Pms-Api-Version",
                 "X-Plex-Container-Start",
                 "X-Plex-Container-Size",
                 "mediaQuery",
+                "updatedAtAfter",
+                "updatedAtBefore",
+                "addedAtAfter",
+                "addedAtBefore",
                 "includeMeta",
                 "includeGuids",
                 "includeCollections",
@@ -718,6 +837,7 @@ class ListContentRequest(BaseModel):
                 "asyncRefreshLocalMediaAgent",
                 "nocache",
                 "skipRefresh",
+                "includeOptionalElements",
                 "excludeElements",
                 "filters",
                 "unwatched",

{plex_api_client-0.36.0 → plex_api_client-0.36.1}/src/plex_api_client/utils/__init__.py

@@ -34,6 +34,7 @@ if TYPE_CHECKING:
     from .requestbodies import serialize_request_body, SerializedRequestBody
     from .security import get_security
     from .serializers import (
+        ALLOW_UNKNOWN_UNION_VARIANTS,
         get_pydantic_model,
         marshal_json,
         unmarshal,
@@ -104,6 +105,7 @@ __all__ = [
     "stream_to_bytes",
     "stream_to_bytes_async",
     "template_url",
+    "ALLOW_UNKNOWN_UNION_VARIANTS",
     "unmarshal",
     "unmarshal_json",
     "validate_decimal",
@@ -126,6 +128,7 @@ _dynamic_imports: dict[str, str] = {
     "parse_duration": ".datetimes",
     "get_global_from_env": ".values",
     "get_headers": ".headers",
+    "ALLOW_UNKNOWN_UNION_VARIANTS": ".serializers",
     "get_pydantic_model": ".serializers",
     "get_query_params": ".queryparams",
     "get_response_headers": ".headers",

{plex_api_client-0.36.0 → plex_api_client-0.36.1}/src/plex_api_client/utils/datetimes.py

@@ -25,7 +25,7 @@ def parse_datetime(datetime_string: str) -> datetime:
     return datetime.fromisoformat(datetime_string)
 
 
-_DURATION_ADAPTER = TypeAdapter(timedelta)
+_DURATION_ADAPTER: TypeAdapter[timedelta] = TypeAdapter(timedelta)
 
 
 def parse_duration(duration_string: str) -> timedelta:
@@ -35,3 +35,7 @@ def parse_duration(duration_string: str) -> timedelta:
     pydantic, which is already a runtime dependency of the SDK.
     """
     return _DURATION_ADAPTER.validate_python(duration_string)
+
+
+def format_duration(duration: timedelta) -> str:
+    return _DURATION_ADAPTER.dump_python(duration, mode="json")

{plex_api_client-0.36.0 → plex_api_client-0.36.1}/src/plex_api_client/utils/retries.py

@@ -318,6 +318,7 @@ def retry_with_backoff(
                 retry_after_ms = _parse_retry_after_ms_header(exception.response)
                 if retry_after_ms is not None:
                     exception.retry_after = retry_after_ms
+                exception.response.close()
             sleep = _get_sleep_interval(
                 exception,
                 initial_interval,
@@ -358,6 +359,7 @@ async def retry_with_backoff_async(
                 retry_after_ms = _parse_retry_after_ms_header(exception.response)
                 if retry_after_ms is not None:
                     exception.retry_after = retry_after_ms
+                await exception.response.aclose()
             sleep = _get_sleep_interval(
                 exception,
                 initial_interval,

{plex_api_client-0.36.0 → plex_api_client-0.36.1}/src/plex_api_client/utils/serializers.py

@@ -112,11 +112,26 @@ def validate_const(v):
     return validate
 
 
+ALLOW_UNKNOWN_UNION_VARIANTS = "speakeasy_allow_unknown_union_variants"
+"""Validation-context key enabling the Unknown fallback on open discriminated
+unions. The SDK sets it when deserializing server responses; validation
+without it (e.g. of user-constructed request payloads) stays strict. Pass
+``context={ALLOW_UNKNOWN_UNION_VARIANTS: True}`` to ``model_validate`` to
+opt in when parsing response payloads manually."""
+
+
 def unmarshal_json(raw, typ: Any) -> Any:
-    return unmarshal(from_json(raw), typ, coerce_iterables=False)
+    return unmarshal(
+        from_json(raw), typ, coerce_iterables=False, allow_unknown_union_variants=True
+    )
 
 
-def unmarshal(val, typ: Any, coerce_iterables: bool = True) -> Any:
+def unmarshal(
+    val,
+    typ: Any,
+    coerce_iterables: bool = True,
+    allow_unknown_union_variants: bool = False,
+) -> Any:
     if coerce_iterables:
         val = _coerce_iterables_for_type(val, typ)
     unmarshaller = create_model(
@@ -125,7 +140,12 @@ def unmarshal(val, typ: Any, coerce_iterables: bool = True) -> Any:
         __config__=ConfigDict(populate_by_name=True, arbitrary_types_allowed=True),
     )
 
-    m = unmarshaller(body=val)
+    if allow_unknown_union_variants:
+        m = unmarshaller.model_validate(
+            {"body": val}, context={ALLOW_UNKNOWN_UNION_VARIANTS: True}
+        )
+    else:
+        m = unmarshaller(body=val)
 
     # pyright: ignore[reportAttributeAccessIssue]
     return m.body  # type: ignore

{plex_api_client-0.36.0 → plex_api_client-0.36.1}/src/plex_api_client/utils/url.py

@@ -1,6 +1,5 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
-from decimal import Decimal
 from typing import (
     Any,
     Dict,
@@ -105,7 +104,7 @@ def _populate_path_params(
                         else:
                             pp_vals.append(f"{pp_key},{_val_to_string(param[pp_key])}")
                     path_param_values[f_name] = ",".join(pp_vals)
-                elif not isinstance(param, (str, int, float, complex, bool, Decimal)):
+                elif isinstance(param, BaseModel):
                     param_fields: Dict[str, FieldInfo] = param.__class__.model_fields
                     for name in param_fields:
                         param_field = param_fields[name]
@@ -132,7 +131,7 @@ def _populate_path_params(
                                 f"{param_name},{_val_to_string(param_field_val)}"
                             )
                     path_param_values[f_name] = ",".join(pp_vals)
-                elif _is_set(param):
+                else:
                     path_param_values[f_name] = _val_to_string(param)
 
     return globals_already_populated

{plex_api_client-0.36.0 → plex_api_client-0.36.1}/src/plex_api_client/utils/values.py

@@ -1,6 +1,6 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
-from datetime import datetime
+from datetime import datetime, timedelta
 from enum import Enum
 from email.message import Message
 from functools import partial
@@ -13,6 +13,7 @@ from pydantic.fields import FieldInfo
 
 from ..types.basemodel import Unset
 
+from .datetimes import format_duration
 from .serializers import marshal_json
 
 from .metadata import ParamMetadata, find_field_metadata
@@ -117,6 +118,8 @@ def _val_to_string(val) -> str:
         return str(val).lower()
     if isinstance(val, datetime):
         return str(val.isoformat().replace("+00:00", "Z"))
+    if isinstance(val, timedelta):
+        return format_duration(val)
     if isinstance(val, Enum):
         return str(val.value)