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

slackwebapi/controllers/files_remote_controller.py

@@ -0,0 +1,440 @@
+"""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 FilesRemoteController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize FilesRemoteController object."""
+        super(FilesRemoteController, self).__init__(config)
+
+    def files_remote_add(self,
+                         token=None,
+                         external_id=None,
+                         title=None,
+                         filetype=None,
+                         external_url=None,
+                         preview_image=None,
+                         indexable_file_contents=None):
+        """Perform a POST request to /files.remote.add.
+
+        Adds a file from a remote service
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `remote_files:write`
+            external_id (str, optional): Creator defined GUID for the file.
+            title (str, optional): Title of the file being shared.
+            filetype (str, optional): type of file
+            external_url (str, optional): URL of the remote file.
+            preview_image (str, optional): Preview of the document via
+                `multipart/form-data`.
+            indexable_file_contents (str, optional): A text file (txt, pdf, doc,
+                etc.) containing textual search terms that are used to improve
+                discovery of the remote file.
+
+        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("/files.remote.add")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token))
+            .form_param(Parameter()
+                .key("external_id")
+                .value(external_id))
+            .form_param(Parameter()
+                .key("title")
+                .value(title))
+            .form_param(Parameter()
+                .key("filetype")
+                .value(filetype))
+            .form_param(Parameter()
+                .key("external_url")
+                .value(external_url))
+            .form_param(Parameter()
+                .key("preview_image")
+                .value(preview_image))
+            .form_param(Parameter()
+                .key("indexable_file_contents")
+                .value(indexable_file_contents))
+            .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 files_remote_info(self,
+                          token=None,
+                          file=None,
+                          external_id=None):
+        """Perform a GET request to /files.remote.info.
+
+        Retrieve information about a remote file added to Slack
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `remote_files:read`
+            file (str, optional): Specify a file by providing its ID.
+            external_id (str, optional): Creator defined GUID for the file.
+
+        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("/files.remote.info")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("token")
+                .value(token))
+            .query_param(Parameter()
+                .key("file")
+                .value(file))
+            .query_param(Parameter()
+                .key("external_id")
+                .value(external_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 files_remote_list(self,
+                          token=None,
+                          channel=None,
+                          ts_from=None,
+                          ts_to=None,
+                          limit=None,
+                          cursor=None):
+        """Perform a GET request to /files.remote.list.
+
+        Retrieve information about a remote file added to Slack
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `remote_files:read`
+            channel (str, optional): Filter files appearing in a specific channel,
+                indicated by its ID.
+            ts_from (float, optional): Filter files created after this timestamp
+                (inclusive).
+            ts_to (float, optional): Filter files created before this timestamp
+                (inclusive).
+            limit (int, optional): The maximum number of items to return.
+            cursor (str, optional): Paginate through collections of data by setting
+                the `cursor` parameter to a `next_cursor` attribute returned by a
+                previous request's `response_metadata`. Default value fetches the
+                first "page" of the collection. See [pagination](/docs/pagination)
+                for more detail.
+
+        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("/files.remote.list")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("token")
+                .value(token))
+            .query_param(Parameter()
+                .key("channel")
+                .value(channel))
+            .query_param(Parameter()
+                .key("ts_from")
+                .value(ts_from))
+            .query_param(Parameter()
+                .key("ts_to")
+                .value(ts_to))
+            .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()
+
+    def files_remote_remove(self,
+                            token=None,
+                            file=None,
+                            external_id=None):
+        """Perform a POST request to /files.remote.remove.
+
+        Remove a remote file.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `remote_files:write`
+            file (str, optional): Specify a file by providing its ID.
+            external_id (str, optional): Creator defined GUID for the file.
+
+        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("/files.remote.remove")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token))
+            .form_param(Parameter()
+                .key("file")
+                .value(file))
+            .form_param(Parameter()
+                .key("external_id")
+                .value(external_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 files_remote_share(self,
+                           token=None,
+                           file=None,
+                           external_id=None,
+                           channels=None):
+        """Perform a GET request to /files.remote.share.
+
+        Share a remote file into a channel.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `remote_files:share`
+            file (str, optional): Specify a file registered with Slack by providing
+                its ID. Either this field or `external_id` or both are required.
+            external_id (str, optional): The globally unique identifier (GUID) for
+                the file, as set by the app registering the file with Slack.  Either
+                this field or `file` or both are required.
+            channels (str, optional): Comma-separated list of channel IDs where the
+                file will be shared.
+
+        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("/files.remote.share")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("token")
+                .value(token))
+            .query_param(Parameter()
+                .key("file")
+                .value(file))
+            .query_param(Parameter()
+                .key("external_id")
+                .value(external_id))
+            .query_param(Parameter()
+                .key("channels")
+                .value(channels))
+            .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 files_remote_update(self,
+                            token=None,
+                            file=None,
+                            external_id=None,
+                            title=None,
+                            filetype=None,
+                            external_url=None,
+                            preview_image=None,
+                            indexable_file_contents=None):
+        """Perform a POST request to /files.remote.update.
+
+        Updates an existing remote file.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `remote_files:write`
+            file (str, optional): Specify a file by providing its ID.
+            external_id (str, optional): Creator defined GUID for the file.
+            title (str, optional): Title of the file being shared.
+            filetype (str, optional): type of file
+            external_url (str, optional): URL of the remote file.
+            preview_image (str, optional): Preview of the document via
+                `multipart/form-data`.
+            indexable_file_contents (str, optional): File containing contents that
+                can be used to improve searchability for the remote file.
+
+        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("/files.remote.update")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token))
+            .form_param(Parameter()
+                .key("file")
+                .value(file))
+            .form_param(Parameter()
+                .key("external_id")
+                .value(external_id))
+            .form_param(Parameter()
+                .key("title")
+                .value(title))
+            .form_param(Parameter()
+                .key("filetype")
+                .value(filetype))
+            .form_param(Parameter()
+                .key("external_url")
+                .value(external_url))
+            .form_param(Parameter()
+                .key("preview_image")
+                .value(preview_image))
+            .form_param(Parameter()
+                .key("indexable_file_contents")
+                .value(indexable_file_contents))
+            .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/migration_controller.py

@@ -0,0 +1,98 @@
+"""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.migration_exchange_error_schema_exception import (
+    MigrationExchangeErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.migration_exchange_success_schema import (
+    MigrationExchangeSuccessSchema,
+)
+
+
+class MigrationController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize MigrationController object."""
+        super(MigrationController, self).__init__(config)
+
+    def migration_exchange(self,
+                           token,
+                           users,
+                           team_id=None,
+                           to_old=None):
+        """Perform a GET request to /migration.exchange.
+
+        For Enterprise Grid workspaces, map local user IDs to global user IDs
+
+        Args:
+            token (str): Authentication token. Requires scope: `tokens.basic`
+            users (str): A comma-separated list of user ids, up to 400 per request
+            team_id (str, optional): Specify team_id starts with `T` in case of Org
+                Token
+            to_old (bool, optional): Specify `true` to convert `W` global user IDs to
+                workspace-specific `U` IDs. Defaults to `false`.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success
+                response when mappings exist for the specified user IDs
+
+        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("/migration.exchange")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("users")
+                .value(users)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("team_id")
+                .value(team_id))
+            .query_param(Parameter()
+                .key("to_old")
+                .value(to_old))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(MigrationExchangeSuccessSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response when there are no mappings to provide",
+                MigrationExchangeErrorSchemaException),
+        ).execute()

slackwebapi/controllers/oauth_authorization_controller.py

@@ -0,0 +1,159 @@
+"""slackwebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+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.oauth_provider_exception import (
+    OauthProviderException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.oauth_token import OauthToken
+
+
+class OauthAuthorizationController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize OauthAuthorizationController object."""
+        super(OauthAuthorizationController, self).__init__(config)
+
+    def request_token(self,
+                      authorization,
+                      code,
+                      redirect_uri,
+                      _optional_form_parameters=None):
+        """Perform a POST request to /oauth.access.
+
+        Create a new OAuth 2 token.
+
+        Args:
+            authorization (str): Authorization header in Basic auth format
+            code (str): Authorization Code
+            redirect_uri (str): Redirect Uri
+            _optional_form_parameters (Array, optional): Additional optional form
+                parameters are supported by this endpoint
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers.
+
+        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("/oauth.access")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("grant_type")
+                .value("authorization_code"))
+            .header_param(Parameter()
+                .key("Authorization")
+                .value(authorization)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("code")
+                .value(code)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("redirect_uri")
+                .value(redirect_uri)
+                .is_required(True))
+            .header_param(Parameter()
+                            .key("content-type")
+                            .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .additional_form_params(_optional_form_parameters),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(OauthToken.from_dictionary)
+            .is_api_response(True)
+            .local_error("400",
+                "OAuth 2 provider returned an error.",
+                OauthProviderException)
+            .local_error("401",
+                "OAuth 2 provider says client authentication failed.",
+                OauthProviderException),
+        ).execute()
+
+    def refresh_token(self,
+                      authorization,
+                      refresh_token,
+                      scope=None,
+                      _optional_form_parameters=None):
+        """Perform a POST request to /oauth.access.
+
+        Obtain a new access token using a refresh token
+
+        Args:
+            authorization (str): Authorization header in Basic auth format
+            refresh_token (str): Refresh token
+            scope (str, optional): Requested scopes as a space-delimited list.
+            _optional_form_parameters (Array, optional): Additional optional form
+                parameters are supported by this endpoint
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers.
+
+        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("/oauth.access")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("grant_type")
+                .value("refresh_token"))
+            .header_param(Parameter()
+                .key("Authorization")
+                .value(authorization)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("refresh_token")
+                .value(refresh_token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("scope")
+                .value(scope))
+            .header_param(Parameter()
+                            .key("content-type")
+                            .value("application/x-www-form-urlencoded"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .additional_form_params(_optional_form_parameters),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(OauthToken.from_dictionary)
+            .is_api_response(True)
+            .local_error("400",
+                "OAuth 2 provider returned an error.",
+                OauthProviderException)
+            .local_error("401",
+                "OAuth 2 provider says client authentication failed.",
+                OauthProviderException),
+        ).execute()