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

slackwebapi/controllers/admin_conversations_ekm_controller.py

@@ -0,0 +1,107 @@
+"""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 AdminConversationsEkmController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AdminConversationsEkmController object."""
+        super(AdminConversationsEkmController, self).__init__(config)
+
+    def admin_conversations_ekm_list_original_connected_channel_info(self,
+                                                                     token,
+                                                                     channel_ids=None,
+                                                                     team_ids=None,
+                                                                     limit=None,
+                                                                     cursor=None):
+        """Perform a GET request to
+        /admin.conversations.ekm.listOriginalConnectedChannelInfo.
+
+        List all disconnected channels—i.e., channels that were once connected to
+        other workspaces and then disconnected—and the corresponding original channel
+        IDs for key revocation with EKM.
+
+        Args:
+            token (str): Authentication token. Requires scope:
+                `admin.conversations:read`
+            channel_ids (str, optional): A comma-separated list of channels to filter
+                to.
+            team_ids (str, optional): A comma-separated list of the workspaces to
+                which the channels you would like returned belong.
+            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.conversations.ekm.listOriginalConnectedChannelInfo")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("channel_ids")
+                .value(channel_ids))
+            .query_param(Parameter()
+                .key("team_ids")
+                .value(team_ids))
+            .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_conversations_restrict_access_controller.py

@@ -0,0 +1,231 @@
+"""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 AdminConversationsRestrictAccessController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AdminConversationsRestrictAccessController object."""
+        super(AdminConversationsRestrictAccessController, self).__init__(config)
+
+    def admin_conversations_restrict_access_add_group(self,
+                                                      token,
+                                                      group_id,
+                                                      channel_id,
+                                                      team_id=None):
+        """Perform a POST request to
+        /admin.conversations.restrictAccess.addGroup.
+
+        Add an allowlist of IDP groups for accessing a channel
+
+        Args:
+            token (str): Authentication token. Requires scope:
+                `admin.conversations:write`
+            group_id (str): The [IDP
+                Group](https://slack.com/help/articles/115001435788-Connect-identity-p
+                rovider-groups-to-your-Enterprise-Grid-org) ID to be an allowlist for
+                the private channel.
+            channel_id (str): The channel to link this group to.
+            team_id (str, optional): The workspace where the channel exists. This
+                argument is required for channels only tied to one workspace, and
+                optional for channels that are shared across an organization.
+
+        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.conversations.restrictAccess.addGroup")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("group_id")
+                .value(group_id)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("channel_id")
+                .value(channel_id)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("team_id")
+                .value(team_id))
+            .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_conversations_restrict_access_list_groups(self,
+                                                        token,
+                                                        channel_id,
+                                                        team_id=None):
+        """Perform a GET request to
+        /admin.conversations.restrictAccess.listGroups.
+
+        List all IDP Groups linked to a channel
+
+        Args:
+            token (str): Authentication token. Requires scope:
+                `admin.conversations:read`
+            channel_id (str): The request query parameter.
+            team_id (str, optional): The workspace where the channel exists. This
+                argument is required for channels only tied to one workspace, and
+                optional for channels that are shared across an organization.
+
+        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.conversations.restrictAccess.listGroups")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("channel_id")
+                .value(channel_id)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("team_id")
+                .value(team_id))
+            .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_conversations_restrict_access_remove_group(self,
+                                                         token,
+                                                         team_id,
+                                                         group_id,
+                                                         channel_id):
+        """Perform a POST request to
+        /admin.conversations.restrictAccess.removeGroup.
+
+        Remove a linked IDP group linked from a private channel
+
+        Args:
+            token (str): Authentication token. Requires scope:
+                `admin.conversations:write`
+            team_id (str): The workspace where the channel exists. This argument is
+                required for channels only tied to one workspace, and optional for
+                channels that are shared across an organization.
+            group_id (str): The [IDP
+                Group](https://slack.com/help/articles/115001435788-Connect-identity-p
+                rovider-groups-to-your-Enterprise-Grid-org) ID to remove from the
+                private channel.
+            channel_id (str): The channel to remove the linked group from.
+
+        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.conversations.restrictAccess.removeGroup")
+            .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("group_id")
+                .value(group_id)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("channel_id")
+                .value(channel_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()

slackwebapi/controllers/admin_emoji_controller.py

@@ -0,0 +1,314 @@
+"""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 AdminEmojiController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AdminEmojiController object."""
+        super(AdminEmojiController, self).__init__(config)
+
+    def admin_emoji_add(self,
+                        token,
+                        name,
+                        url):
+        """Perform a POST request to /admin.emoji.add.
+
+        Add an emoji.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:write`
+            name (str): The name of the emoji to be removed. Colons (`:myemoji:`)
+                around the value are not required, although they may be included.
+            url (str): The URL of a file to use as an image for the emoji. Square
+                images under 128KB and with transparent backgrounds work best.
+
+        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.emoji.add")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("name")
+                .value(name)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("url")
+                .value(url)
+                .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_emoji_add_alias(self,
+                              token,
+                              name,
+                              alias_for):
+        """Perform a POST request to /admin.emoji.addAlias.
+
+        Add an emoji alias.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:write`
+            name (str): The name of the emoji to be aliased. Colons (`:myemoji:`)
+                around the value are not required, although they may be included.
+            alias_for (str): The alias of the emoji.
+
+        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.emoji.addAlias")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("name")
+                .value(name)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("alias_for")
+                .value(alias_for)
+                .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_emoji_list(self,
+                         token,
+                         cursor=None,
+                         limit=None):
+        """Perform a GET request to /admin.emoji.list.
+
+        List emoji for an Enterprise Grid organization.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:read`
+            cursor (str, optional): Set `cursor` to `next_cursor` returned by the
+                previous call to list items in the next page
+            limit (int, optional): The maximum number of items to return. Must be
+                between 1 - 1000 both inclusive.
+
+        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.emoji.list")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("cursor")
+                .value(cursor))
+            .query_param(Parameter()
+                .key("limit")
+                .value(limit))
+            .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_emoji_remove(self,
+                           token,
+                           name):
+        """Perform a POST request to /admin.emoji.remove.
+
+        Remove an emoji across an Enterprise Grid organization
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:write`
+            name (str): The name of the emoji to be removed. Colons (`:myemoji:`)
+                around the value are not required, although they may be included.
+
+        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.emoji.remove")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token)
+                .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()
+
+    def admin_emoji_rename(self,
+                           token,
+                           name,
+                           new_name):
+        """Perform a POST request to /admin.emoji.rename.
+
+        Rename an emoji.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.teams:write`
+            name (str): The name of the emoji to be renamed. Colons (`:myemoji:`)
+                around the value are not required, although they may be included.
+            new_name (str): The new name of the emoji.
+
+        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.emoji.rename")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("name")
+                .value(name)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("new_name")
+                .value(new_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()