slack-api-sdk-apimatic 1.1.1__py3-none-any.whl

slackwebapi/controllers/admin_teams_owners_controller.py

@@ -0,0 +1,97 @@
+"""slackwebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+from apimatic_core.authentication.multiple.single_auth import (
+    Single,
+)
+from apimatic_core.request_builder import RequestBuilder
+from apimatic_core.response_handler import ResponseHandler
+from apimatic_core.types.parameter import Parameter
+
+from slackwebapi.api_helper import APIHelper
+from slackwebapi.configuration import Server
+from slackwebapi.controllers.base_controller import (
+    BaseController,
+)
+from slackwebapi.exceptions.default_error_template_exception import (
+    DefaultErrorTemplateException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.default_success_template import (
+    DefaultSuccessTemplate,
+)
+
+
+class AdminTeamsOwnersController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AdminTeamsOwnersController object."""
+        super(AdminTeamsOwnersController, self).__init__(config)
+
+    def admin_teams_owners_list(self,
+                                token,
+                                team_id,
+                                limit=None,
+                                cursor=None):
+        """Perform a GET request to /admin.teams.owners.list.
+
+        List all of the owners on a given workspace.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:read`
+            team_id (str): The request query parameter.
+            limit (int, optional): The maximum number of items to return. Must be
+                between 1 - 1000 both inclusive.
+            cursor (str, optional): Set `cursor` to `next_cursor` returned by the
+                previous call to list items in the next page.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/admin.teams.owners.list")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("team_id")
+                .value(team_id)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("limit")
+                .value(limit))
+            .query_param(Parameter()
+                .key("cursor")
+                .value(cursor))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                DefaultErrorTemplateException),
+        ).execute()

slackwebapi/controllers/admin_teams_settings_controller.py

@@ -0,0 +1,367 @@
+"""slackwebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+from apimatic_core.authentication.multiple.single_auth import (
+    Single,
+)
+from apimatic_core.request_builder import RequestBuilder
+from apimatic_core.response_handler import ResponseHandler
+from apimatic_core.types.parameter import Parameter
+
+from slackwebapi.api_helper import APIHelper
+from slackwebapi.configuration import Server
+from slackwebapi.controllers.base_controller import (
+    BaseController,
+)
+from slackwebapi.exceptions.default_error_template_exception import (
+    DefaultErrorTemplateException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.default_success_template import (
+    DefaultSuccessTemplate,
+)
+
+
+class AdminTeamsSettingsController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AdminTeamsSettingsController object."""
+        super(AdminTeamsSettingsController, self).__init__(config)
+
+    def admin_teams_settings_info(self,
+                                  token,
+                                  team_id):
+        """Perform a GET request to /admin.teams.settings.info.
+
+        Fetch information about settings in a workspace
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:read`
+            team_id (str): The request query parameter.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/admin.teams.settings.info")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("team_id")
+                .value(team_id)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                DefaultErrorTemplateException),
+        ).execute()
+
+    def admin_teams_settings_set_default_channels(self,
+                                                  token,
+                                                  team_id,
+                                                  channel_ids):
+        """Perform a POST request to /admin.teams.settings.setDefaultChannels.
+
+        Set the default channels of a workspace.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:write`
+            team_id (str): ID for the workspace to set the default channel for.
+            channel_ids (str): An array of channel IDs.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/admin.teams.settings.setDefaultChannels")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("team_id")
+                .value(team_id)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("channel_ids")
+                .value(channel_ids)
+                .is_required(True))
+            .header_param(Parameter()
+                            .key("content-type")
+                            .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                DefaultErrorTemplateException),
+        ).execute()
+
+    def admin_teams_settings_set_description(self,
+                                             token,
+                                             team_id,
+                                             description):
+        """Perform a POST request to /admin.teams.settings.setDescription.
+
+        Set the description of a given workspace.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:write`
+            team_id (str): ID for the workspace to set the description for.
+            description (str): The new description for the workspace.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/admin.teams.settings.setDescription")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("team_id")
+                .value(team_id)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("description")
+                .value(description)
+                .is_required(True))
+            .header_param(Parameter()
+                            .key("content-type")
+                            .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                DefaultErrorTemplateException),
+        ).execute()
+
+    def admin_teams_settings_set_discoverability(self,
+                                                 token,
+                                                 team_id,
+                                                 discoverability):
+        """Perform a POST request to /admin.teams.settings.setDiscoverability.
+
+        An API method that allows admins to set the discoverability of a given
+        workspace
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:write`
+            team_id (str): The ID of the workspace to set discoverability on.
+            discoverability (str): This workspace's discovery setting. It must be set
+                to one of `open`, `invite_only`, `closed`, or `unlisted`.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/admin.teams.settings.setDiscoverability")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("team_id")
+                .value(team_id)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("discoverability")
+                .value(discoverability)
+                .is_required(True))
+            .header_param(Parameter()
+                            .key("content-type")
+                            .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                DefaultErrorTemplateException),
+        ).execute()
+
+    def admin_teams_settings_set_icon(self,
+                                      token,
+                                      image_url,
+                                      team_id):
+        """Perform a POST request to /admin.teams.settings.setIcon.
+
+        Sets the icon of a workspace.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:write`
+            image_url (str): Image URL for the icon
+            team_id (str): ID for the workspace to set the icon for.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/admin.teams.settings.setIcon")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("image_url")
+                .value(image_url)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("team_id")
+                .value(team_id)
+                .is_required(True))
+            .header_param(Parameter()
+                            .key("content-type")
+                            .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                DefaultErrorTemplateException),
+        ).execute()
+
+    def admin_teams_settings_set_name(self,
+                                      token,
+                                      team_id,
+                                      name):
+        """Perform a POST request to /admin.teams.settings.setName.
+
+        Set the name of a given workspace.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:write`
+            team_id (str): ID for the workspace to set the name for.
+            name (str): The new name of the workspace.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success response
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/admin.teams.settings.setName")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("team_id")
+                .value(team_id)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("name")
+                .value(name)
+                .is_required(True))
+            .header_param(Parameter()
+                            .key("content-type")
+                            .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(DefaultSuccessTemplate.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                DefaultErrorTemplateException),
+        ).execute()