From 998ed04a6c071063e5fe2e1bde640e5e694a3ae2 Mon Sep 17 00:00:00 2001 From: blacktwin Date: Thu, 16 Jul 2020 21:21:26 -0400 Subject: [PATCH] update docstrings for AccountSettings and AccountOptOut --- plexapi/myplex.py | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/plexapi/myplex.py b/plexapi/myplex.py index a7b15347..1f1a0fc5 100644 --- a/plexapi/myplex.py +++ b/plexapi/myplex.py @@ -1320,6 +1320,17 @@ def _chooseConnection(ctype, name, results): class AccountSettings(PlexObject): + """ Represents a single Account Setting + 'https://plex.tv/api/v2/user/{userUUID}/settings' + + Attributes: + id (str): Unknown. "experience"? + type (str): "json" + value (dict): Lots of user server, library, + and other endpoints and settings + hidden (str): Unknown. Are these settings hidden? + updatedAt (datetime): Datetime last updated + """ def _loadData(self, data): self.id = data.attrib.get('id') @@ -1333,8 +1344,14 @@ class AccountSettings(PlexObject): class AccountOptOut(PlexObject): + """ Represents a single AccountOptOut + 'https://plex.tv/api/v2/user/{userUUID}/settings/opt_outs' + + Attributes: + key (str): Online Media Source key + value (str): Online Media Source opt_in or opt_out + """ - TYPE = 'array' def _loadData(self, data): self.key = data.attrib.get('key') self.value = data.attrib.get('value')