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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plex-api-client
-Version: 0.15.0
+Version: 0.16.0
 Summary: Python Client SDK Generated by Speakeasy
 Home-page: https://github.com/LukeHagar/plexpy.git
 Author: Speakeasy
@@ -46,7 +46,7 @@ Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
 
 ## SDKs
 
-The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the respective repository.
+The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
 
 | Language              | Repository                                        | Releases                                                                                         | Other                                                   |
 | --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
@@ -598,7 +598,7 @@ if res.object is not None:
 
 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 `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.
+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_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.
 
 
 ### Available Globals
@@ -621,8 +621,10 @@ This is used to track the client application and its usage
 
 ```python
 from plex_api_client import PlexAPI
+from plex_api_client.models import operations
 
 s = PlexAPI(
+    access_token="<YOUR_API_KEY_HERE>",
     client_id="gcgzw5rz2xovp84b4vha3a40",
     client_name="Plex Web",
     client_version="4.133.0",
@@ -630,9 +632,9 @@ s = PlexAPI(
     device_name="Linux",
 )
 
-res = s.plex.get_pin(request={})
+res = s.plex.get_server_resources(include_https=operations.IncludeHTTPS.ENABLE, include_relay=operations.IncludeRelay.ENABLE, include_i_pv6=operations.IncludeIPv6.ENABLE, client_id="gcgzw5rz2xovp84b4vha3a40")
 
-if res.auth_pin_container is not None:
+if res.plex_devices is not None:
     # handle response
     pass
 

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

@@ -24,7 +24,7 @@ Automation and SDKs provided by [Speakeasy](https://speakeasyapi.dev/)
 
 ## SDKs
 
-The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the respective repository.
+The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the [main specification Repository](https://github.com/LukeHagar/plex-api-spec).
 
 | Language              | Repository                                        | Releases                                                                                         | Other                                                   |
 | --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
@@ -576,7 +576,7 @@ if res.object is not None:
 
 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 `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.
+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_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.
 
 
 ### Available Globals
@@ -599,8 +599,10 @@ This is used to track the client application and its usage
 
 ```python
 from plex_api_client import PlexAPI
+from plex_api_client.models import operations
 
 s = PlexAPI(
+    access_token="<YOUR_API_KEY_HERE>",
     client_id="gcgzw5rz2xovp84b4vha3a40",
     client_name="Plex Web",
     client_version="4.133.0",
@@ -608,9 +610,9 @@ s = PlexAPI(
     device_name="Linux",
 )
 
-res = s.plex.get_pin(request={})
+res = s.plex.get_server_resources(include_https=operations.IncludeHTTPS.ENABLE, include_relay=operations.IncludeRelay.ENABLE, include_i_pv6=operations.IncludeIPv6.ENABLE, client_id="gcgzw5rz2xovp84b4vha3a40")
 
-if res.auth_pin_container is not None:
+if res.plex_devices is not None:
     # handle response
     pass
 

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

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

{plex_api_client-0.15.0 → plex_api_client-0.16.0}/src/plex_api_client/models/operations/__init__.py

@@ -380,6 +380,8 @@ from .get_server_resources import (
     Connections,
     ConnectionsTypedDict,
     GET_SERVER_RESOURCES_SERVERS,
+    GetServerResourcesGlobals,
+    GetServerResourcesGlobalsTypedDict,
     GetServerResourcesRequest,
     GetServerResourcesRequestTypedDict,
     GetServerResourcesResponse,
@@ -1562,6 +1564,8 @@ __all__ = [
     "GetServerPreferencesResponseBody",
     "GetServerPreferencesResponseBodyTypedDict",
     "GetServerPreferencesResponseTypedDict",
+    "GetServerResourcesGlobals",
+    "GetServerResourcesGlobalsTypedDict",
     "GetServerResourcesRequest",
     "GetServerResourcesRequestTypedDict",
     "GetServerResourcesResponse",

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

@@ -16,6 +16,28 @@ 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)
+
+    """
+
+
+class GetServerResourcesGlobals(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)
+
+    """
+
+
 class IncludeHTTPS(int, Enum):
     r"""Include Https entries in the results"""
 
@@ -50,6 +72,12 @@ 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)
+
+    """
 
 
 class GetServerResourcesRequest(BaseModel):
@@ -77,6 +105,17 @@ class GetServerResourcesRequest(BaseModel):
     ] = IncludeIPv6.DISABLE
     r"""Include IPv6 entries in the results"""
 
+    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)
+
+    """
+
 
 class Protocol(str, Enum):
     r"""The protocol used for the connection (http, https, etc)"""

{plex_api_client-0.15.0 → plex_api_client-0.16.0}/src/plex_api_client/models/operations/gettokendetails.py

@@ -4,6 +4,7 @@ from __future__ import annotations
 from datetime import datetime
 from enum import Enum
 import httpx
+from plex_api_client import utils
 from plex_api_client.types import (
     BaseModel,
     Nullable,
@@ -11,8 +12,10 @@ from plex_api_client.types import (
     UNSET,
     UNSET_SENTINEL,
 )
+from plex_api_client.utils import validate_open_enum
 import pydantic
 from pydantic import model_serializer
+from pydantic.functional_validators import PlainValidator
 from typing import List, Optional, TypedDict
 from typing_extensions import Annotated, NotRequired
 
@@ -207,7 +210,7 @@ class Services(BaseModel):
         return m
 
 
-class Features(str, Enum):
+class Features(str, Enum, metaclass=utils.OpenEnumMeta):
     ANDROID_DOLBY_VISION = "Android - Dolby Vision"
     ANDROID_PI_P = "Android - PiP"
     CU_SUNSET = "CU Sunset"
@@ -215,28 +218,43 @@ class Features(str, Enum):
     TREBLE_SHOW_FEATURES = "TREBLE-show-features"
     AD_COUNTDOWN_TIMER = "ad-countdown-timer"
     ADAPTIVE_BITRATE = "adaptive_bitrate"
+    ALBUM_TYPES = "album-types"
+    ALLOW_DVR = "allow_dvr"
     AMAZON_LOOP_DEBUG = "amazon-loop-debug"
     AVOD_AD_ANALYSIS = "avod-ad-analysis"
     AVOD_NEW_MEDIA = "avod-new-media"
     BLACKLIST_GET_SIGNIN = "blacklist_get_signin"
+    BOOST_VOICES = "boost-voices"
+    CAMERA_UPLOAD = "camera_upload"
     CLIENT_RADIO_STATIONS = "client-radio-stations"
     CLOUDFLARE_TURNSTILE_REQUIRED = "cloudflare-turnstile-required"
+    CLOUDSYNC = "cloudsync"
     COLLECTIONS = "collections"
     COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS = "comments_and_replies_push_notifications"
     COMMUNITY_ACCESS_PLEX_TV = "community_access_plex_tv"
     COMPANIONS_SONOS = "companions_sonos"
+    CONTENT_FILTER = "content_filter"
     CUSTOM_HOME_REMOVAL = "custom-home-removal"
     DISABLE_HOME_USER_FRIENDSHIPS = "disable_home_user_friendships"
     DISABLE_SHARING_FRIENDSHIPS = "disable_sharing_friendships"
+    DOWNLOADS_GATING = "downloads-gating"
     DRM_SUPPORT = "drm_support"
+    DVR = "dvr"
+    DVR_BLOCK_UNSUPPORTED_COUNTRIES = "dvr-block-unsupported-countries"
+    EPG_RECENT_CHANNELS = "epg-recent-channels"
     EXCLUDE_RESTRICTIONS = "exclude restrictions"
     FEDERATED_AUTH = "federated-auth"
     FRIEND_REQUEST_PUSH_NOTIFICATIONS = "friend_request_push_notifications"
+    GRANDFATHER_SYNC = "grandfather-sync"
     GUIDED_UPGRADE = "guided-upgrade"
+    HARDWARE_TRANSCODING = "hardware_transcoding"
     HOME = "home"
+    HWTRANSCODE = "hwtranscode"
+    IMAGGA_V2 = "imagga-v2"
     INCREASE_PASSWORD_COMPLEXITY = "increase-password-complexity"
     IOS14_PRIVACY_BANNER = "ios14-privacy-banner"
     ITERABLE_NOTIFICATION_TOKENS = "iterable-notification-tokens"
+    ITEM_CLUSTERS = "item_clusters"
     KEEP_PAYMENT_METHOD = "keep-payment-method"
     KEVIN_BACON = "kevin-bacon"
     KOREA_CONSENT = "korea-consent"
@@ -245,28 +263,49 @@ class Features(str, Enum):
     LIGHTNING_DVR_PIVOT = "lightning-dvr-pivot"
     LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS = "live-tv-support-incomplete-segments"
     LIVETV = "livetv"
+    LYRICS = "lyrics"
     METADATA_SEARCH = "metadata_search"
+    MUSIC_ANALYSIS = "music-analysis"
+    MUSIC_VIDEOS = "music_videos"
     NEW_PLEX_PASS_PRICES = "new_plex_pass_prices"
     NEWS_PROVIDER_SUNSET_MODAL = "news-provider-sunset-modal"
+    NOMINATIM = "nominatim"
+    PASS = "pass"
     PHOTOS_FAVORITES = "photos-favorites"
     PHOTOS_METADATA_EDITION = "photos-metadata-edition"
+    PHOTOS_V6_EDIT = "photosV6-edit"
+    PHOTOS_V6_TV_ALBUMS = "photosV6-tv-albums"
     PMS_HEALTH = "pms_health"
+    PREMIUM_DASHBOARD = "premium-dashboard"
+    PREMIUM_MUSIC_METADATA = "premium_music_metadata"
     RADIO = "radio"
     RATE_LIMIT_CLIENT_TOKEN = "rate-limit-client-token"
     SCROBBLING_SERVICE_PLEX_TV = "scrobbling-service-plex-tv"
+    SESSION_BANDWIDTH_RESTRICTIONS = "session_bandwidth_restrictions"
+    SESSION_KICK = "session_kick"
     SHARED_SERVER_NOTIFICATION = "shared_server_notification"
     SHARED_SOURCE_NOTIFICATION = "shared_source_notification"
+    SIGNIN_NOTIFICATION = "signin_notification"
     SIGNIN_WITH_APPLE = "signin_with_apple"
+    SILENCE_REMOVAL = "silence-removal"
+    SLEEP_TIMER = "sleep-timer"
     SPRING_SERVE_AD_PROVIDER = "spring_serve_ad_provider"
+    SYNC = "sync"
+    SWEET_FADES = "sweet-fades"
     TRANSCODER_CACHE = "transcoder_cache"
+    TRAILERS = "trailers"
     TUNER_SHARING = "tuner-sharing"
     TWO_FACTOR_AUTHENTICATION = "two-factor-authentication"
     UNSUPPORTEDTUNERS = "unsupportedtuners"
     UPGRADE_3DS2 = "upgrade-3ds2"
+    VISUALIZERS = "visualizers"
     VOD_SCHEMA = "vod-schema"
     VOD_CLOUDFLARE = "vod_cloudflare"
+    VOLUME_LEVELING = "volume-leveling"
     WATCH_TOGETHER_INVITE = "watch-together-invite"
+    WATCHLIST_RSS = "watchlist-rss"
     WEB_SERVER_DASHBOARD = "web_server_dashboard"
+    WEBHOOKS = "webhooks"
 
 
 class GetTokenDetailsAuthenticationStatus(str, Enum):
@@ -296,7 +335,9 @@ class SubscriptionTypedDict(TypedDict):
 class Subscription(BaseModel):
     r"""If the account’s Plex Pass subscription is active"""
 
-    features: Optional[List[Features]] = None
+    features: Optional[
+        List[Annotated[Features, PlainValidator(validate_open_enum(False))]]
+    ] = None
     r"""List of features allowed on your Plex Pass subscription"""
 
     active: Optional[bool] = None
@@ -356,7 +397,7 @@ class Subscription(BaseModel):
         return m
 
 
-class GetTokenDetailsFeatures(str, Enum):
+class GetTokenDetailsFeatures(str, Enum, metaclass=utils.OpenEnumMeta):
     ANDROID_DOLBY_VISION = "Android - Dolby Vision"
     ANDROID_PI_P = "Android - PiP"
     CU_SUNSET = "CU Sunset"
@@ -364,28 +405,43 @@ class GetTokenDetailsFeatures(str, Enum):
     TREBLE_SHOW_FEATURES = "TREBLE-show-features"
     AD_COUNTDOWN_TIMER = "ad-countdown-timer"
     ADAPTIVE_BITRATE = "adaptive_bitrate"
+    ALBUM_TYPES = "album-types"
+    ALLOW_DVR = "allow_dvr"
     AMAZON_LOOP_DEBUG = "amazon-loop-debug"
     AVOD_AD_ANALYSIS = "avod-ad-analysis"
     AVOD_NEW_MEDIA = "avod-new-media"
     BLACKLIST_GET_SIGNIN = "blacklist_get_signin"
+    BOOST_VOICES = "boost-voices"
+    CAMERA_UPLOAD = "camera_upload"
     CLIENT_RADIO_STATIONS = "client-radio-stations"
     CLOUDFLARE_TURNSTILE_REQUIRED = "cloudflare-turnstile-required"
+    CLOUDSYNC = "cloudsync"
     COLLECTIONS = "collections"
     COMMENTS_AND_REPLIES_PUSH_NOTIFICATIONS = "comments_and_replies_push_notifications"
     COMMUNITY_ACCESS_PLEX_TV = "community_access_plex_tv"
     COMPANIONS_SONOS = "companions_sonos"
+    CONTENT_FILTER = "content_filter"
     CUSTOM_HOME_REMOVAL = "custom-home-removal"
     DISABLE_HOME_USER_FRIENDSHIPS = "disable_home_user_friendships"
     DISABLE_SHARING_FRIENDSHIPS = "disable_sharing_friendships"
+    DOWNLOADS_GATING = "downloads-gating"
     DRM_SUPPORT = "drm_support"
+    DVR = "dvr"
+    DVR_BLOCK_UNSUPPORTED_COUNTRIES = "dvr-block-unsupported-countries"
+    EPG_RECENT_CHANNELS = "epg-recent-channels"
     EXCLUDE_RESTRICTIONS = "exclude restrictions"
     FEDERATED_AUTH = "federated-auth"
     FRIEND_REQUEST_PUSH_NOTIFICATIONS = "friend_request_push_notifications"
+    GRANDFATHER_SYNC = "grandfather-sync"
     GUIDED_UPGRADE = "guided-upgrade"
+    HARDWARE_TRANSCODING = "hardware_transcoding"
     HOME = "home"
+    HWTRANSCODE = "hwtranscode"
+    IMAGGA_V2 = "imagga-v2"
     INCREASE_PASSWORD_COMPLEXITY = "increase-password-complexity"
     IOS14_PRIVACY_BANNER = "ios14-privacy-banner"
     ITERABLE_NOTIFICATION_TOKENS = "iterable-notification-tokens"
+    ITEM_CLUSTERS = "item_clusters"
     KEEP_PAYMENT_METHOD = "keep-payment-method"
     KEVIN_BACON = "kevin-bacon"
     KOREA_CONSENT = "korea-consent"
@@ -394,28 +450,49 @@ class GetTokenDetailsFeatures(str, Enum):
     LIGHTNING_DVR_PIVOT = "lightning-dvr-pivot"
     LIVE_TV_SUPPORT_INCOMPLETE_SEGMENTS = "live-tv-support-incomplete-segments"
     LIVETV = "livetv"
+    LYRICS = "lyrics"
     METADATA_SEARCH = "metadata_search"
+    MUSIC_ANALYSIS = "music-analysis"
+    MUSIC_VIDEOS = "music_videos"
     NEW_PLEX_PASS_PRICES = "new_plex_pass_prices"
     NEWS_PROVIDER_SUNSET_MODAL = "news-provider-sunset-modal"
+    NOMINATIM = "nominatim"
+    PASS = "pass"
     PHOTOS_FAVORITES = "photos-favorites"
     PHOTOS_METADATA_EDITION = "photos-metadata-edition"
+    PHOTOS_V6_EDIT = "photosV6-edit"
+    PHOTOS_V6_TV_ALBUMS = "photosV6-tv-albums"
     PMS_HEALTH = "pms_health"
+    PREMIUM_DASHBOARD = "premium-dashboard"
+    PREMIUM_MUSIC_METADATA = "premium_music_metadata"
     RADIO = "radio"
     RATE_LIMIT_CLIENT_TOKEN = "rate-limit-client-token"
     SCROBBLING_SERVICE_PLEX_TV = "scrobbling-service-plex-tv"
+    SESSION_BANDWIDTH_RESTRICTIONS = "session_bandwidth_restrictions"
+    SESSION_KICK = "session_kick"
     SHARED_SERVER_NOTIFICATION = "shared_server_notification"
     SHARED_SOURCE_NOTIFICATION = "shared_source_notification"
+    SIGNIN_NOTIFICATION = "signin_notification"
     SIGNIN_WITH_APPLE = "signin_with_apple"
+    SILENCE_REMOVAL = "silence-removal"
+    SLEEP_TIMER = "sleep-timer"
     SPRING_SERVE_AD_PROVIDER = "spring_serve_ad_provider"
+    SYNC = "sync"
+    SWEET_FADES = "sweet-fades"
     TRANSCODER_CACHE = "transcoder_cache"
+    TRAILERS = "trailers"
     TUNER_SHARING = "tuner-sharing"
     TWO_FACTOR_AUTHENTICATION = "two-factor-authentication"
     UNSUPPORTEDTUNERS = "unsupportedtuners"
     UPGRADE_3DS2 = "upgrade-3ds2"
+    VISUALIZERS = "visualizers"
     VOD_SCHEMA = "vod-schema"
     VOD_CLOUDFLARE = "vod_cloudflare"
+    VOLUME_LEVELING = "volume-leveling"
     WATCH_TOGETHER_INVITE = "watch-together-invite"
+    WATCHLIST_RSS = "watchlist-rss"
     WEB_SERVER_DASHBOARD = "web_server_dashboard"
+    WEBHOOKS = "webhooks"
 
 
 class GetTokenDetailsAuthenticationResponseStatus(str, Enum):
@@ -441,7 +518,13 @@ class GetTokenDetailsSubscriptionTypedDict(TypedDict):
 
 
 class GetTokenDetailsSubscription(BaseModel):
-    features: Optional[List[GetTokenDetailsFeatures]] = None
+    features: Optional[
+        List[
+            Annotated[
+                GetTokenDetailsFeatures, PlainValidator(validate_open_enum(False))
+            ]
+        ]
+    ] = None
     r"""List of features allowed on your Plex Pass subscription"""
 
     active: Optional[bool] = None