from .base import Base
[docs]class Schemes(Base):
[docs] def get_schemes(self, params=None):
"""Get the schemes.
scope: Limit the results returned to the provided scope, either ``team`` or ``channel``.
page: The page to select.
per_page: The number of schemes per page.
`Read in Mattermost API docs (schemes - GetSchemes) <https://api.mattermost.com/#tag/schemes/operation/GetSchemes>`_
"""
return self.client.get("""/api/v4/schemes""", params=params)
[docs] def create_scheme(self, options):
"""Create a scheme
name: The name of the scheme
description: The description of the scheme
scope: The scope of the scheme ("team" or "channel")
`Read in Mattermost API docs (schemes - CreateScheme) <https://api.mattermost.com/#tag/schemes/operation/CreateScheme>`_
"""
return self.client.post("""/api/v4/schemes""", options=options)
[docs] def get_scheme(self, scheme_id):
"""Get a scheme
scheme_id: Scheme GUID
`Read in Mattermost API docs (schemes - GetScheme) <https://api.mattermost.com/#tag/schemes/operation/GetScheme>`_
"""
return self.client.get(f"/api/v4/schemes/{scheme_id}")
[docs] def delete_scheme(self, scheme_id):
"""Delete a scheme
scheme_id: ID of the scheme to delete
`Read in Mattermost API docs (schemes - DeleteScheme) <https://api.mattermost.com/#tag/schemes/operation/DeleteScheme>`_
"""
return self.client.delete(f"/api/v4/schemes/{scheme_id}")
[docs] def patch_scheme(self, scheme_id, options):
"""Patch a scheme
scheme_id: Scheme GUID
name: The human readable name of the scheme
description: The description of the scheme
`Read in Mattermost API docs (schemes - PatchScheme) <https://api.mattermost.com/#tag/schemes/operation/PatchScheme>`_
"""
return self.client.put(f"/api/v4/schemes/{scheme_id}/patch", options=options)
[docs] def get_teams_for_scheme(self, scheme_id, params=None):
"""Get a page of teams which use this scheme.
scheme_id: Scheme GUID
page: The page to select.
per_page: The number of teams per page.
`Read in Mattermost API docs (schemes - GetTeamsForScheme) <https://api.mattermost.com/#tag/schemes/operation/GetTeamsForScheme>`_
"""
return self.client.get(f"/api/v4/schemes/{scheme_id}/teams", params=params)
[docs] def get_channels_for_scheme(self, scheme_id, params=None):
"""Get a page of channels which use this scheme.
scheme_id: Scheme GUID
page: The page to select.
per_page: The number of channels per page.
`Read in Mattermost API docs (schemes - GetChannelsForScheme) <https://api.mattermost.com/#tag/schemes/operation/GetChannelsForScheme>`_
"""
return self.client.get(f"/api/v4/schemes/{scheme_id}/channels", params=params)