Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SG-33870 Add methods for the user_subscriptions API end points #315

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions shotgun_api3/shotgun.py
Original file line number Diff line number Diff line change
Expand Up @@ -3261,6 +3261,42 @@ def preferences_read(self, prefs=None):

return self._call_rpc("preferences_read", {"prefs": prefs})

def user_subscriptions_read(self):
"""
Get the list of user subscriptions.

:returns: A list of user subscriptions where each subscription is a
dictionary containing the ``humanUserId`` and ``subscription``
fields.
:rtype: list
"""

return self._call_rpc("user_subscriptions_read", None)

def user_subscriptions_create(self, users: list):
"""
Assign subscriptions to users.

:param list users: list of user subscriptions to assign.
Each subscription must be a dictionary with the ``humanUserId`` and
``subscription`` fields.
The ``subscription`` is either ``None``, a single string, or an
array of strings with subscription information.

:returns: ``True`` if the request succedeed, ``False`` if otherwise.
:rtype: bool
"""

response = self._call_rpc(
"user_subscriptions_create",
{"users": users}
)

if not isinstance(response, dict):
return False

return response.get("status") == "success"

def _build_opener(self, handler):
"""
Build urllib2 opener with appropriate proxy handler.
Expand Down
Loading