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

slackwebapi/controllers/files_controller.py

@@ -0,0 +1,470 @@
+"""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.files_delete_error_schema_exception import (
+    FilesDeleteErrorSchemaException,
+)
+from slackwebapi.exceptions.files_info_error_schema_exception import (
+    FilesInfoErrorSchemaException,
+)
+from slackwebapi.exceptions.files_list_error_schema_exception import (
+    FilesListErrorSchemaException,
+)
+from slackwebapi.exceptions.files_revoke_public_url_error_schema_exception import (
+    FilesRevokePublicUrlErrorSchemaException,
+)
+from slackwebapi.exceptions.files_shared_public_url_error_schema_exception import (
+    FilesSharedPublicUrlErrorSchemaException,
+)
+from slackwebapi.exceptions.files_upload_error_schema_exception import (
+    FilesUploadErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.files_delete_schema import (
+    FilesDeleteSchema,
+)
+from slackwebapi.models.files_info_schema import (
+    FilesInfoSchema,
+)
+from slackwebapi.models.files_list_schema import (
+    FilesListSchema,
+)
+from slackwebapi.models.files_revoke_public_url_schema import (
+    FilesRevokePublicUrlSchema,
+)
+from slackwebapi.models.files_shared_public_url_schema import (
+    FilesSharedPublicUrlSchema,
+)
+from slackwebapi.models.files_upload_schema import (
+    FilesUploadSchema,
+)
+
+
+class FilesController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize FilesController object."""
+        super(FilesController, self).__init__(config)
+
+    def files_delete(self,
+                     token=None,
+                     file=None):
+        """Perform a POST request to /files.delete.
+
+        Deletes a file.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `files:write:user`
+            file (str, optional): ID of file to delete.
+
+        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.delete")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token))
+            .form_param(Parameter()
+                .key("file")
+                .value(file))
+            .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(FilesDeleteSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                FilesDeleteErrorSchemaException),
+        ).execute()
+
+    def files_info(self,
+                   token=None,
+                   file=None,
+                   count=None,
+                   page=None,
+                   limit=None,
+                   cursor=None):
+        """Perform a GET request to /files.info.
+
+        Gets information about a file.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope: `files:read`
+            file (str, optional): Specify a file by providing its ID.
+            count (str, optional): The request query parameter.
+            page (str, optional): The request query parameter.
+            limit (int, optional): The maximum number of items to return. Fewer than
+                the requested number of items may be returned, even if the end of the
+                list hasn't been reached.
+            cursor (str, optional): Parameter for pagination. File comments are
+                paginated for a single file. Set `cursor` equal to the `next_cursor`
+                attribute returned by the previous request's `response_metadata`.
+                This parameter is optional, but pagination is mandatory: the default
+                value simply fetches the first "page" of the collection of comments.
+                See [pagination](/docs/pagination) for more details.
+
+        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.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("count")
+                .value(count))
+            .query_param(Parameter()
+                .key("page")
+                .value(page))
+            .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(FilesInfoSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                FilesInfoErrorSchemaException),
+        ).execute()
+
+    def files_list(self,
+                   token=None,
+                   user=None,
+                   channel=None,
+                   ts_from=None,
+                   ts_to=None,
+                   types=None,
+                   count=None,
+                   page=None,
+                   show_files_hidden_by_limit=None):
+        """Perform a GET request to /files.list.
+
+        List for a team, in a channel, or from a user with applied filters.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope: `files:read`
+            user (str, optional): Filter files created by a single user.
+            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).
+            types (str, optional): Filter files by type ([see below](#file_types)).
+                You can pass multiple values in the types argument, like
+                `types=spaces,snippets`.The default value is `all`, which does not
+                filter the list.
+            count (str, optional): The request query parameter.
+            page (str, optional): The request query parameter.
+            show_files_hidden_by_limit (bool, optional): Show truncated file info for
+                files hidden due to being too old, and the team who owns the file
+                being over the file limit.
+
+        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.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("user")
+                .value(user))
+            .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("types")
+                .value(types))
+            .query_param(Parameter()
+                .key("count")
+                .value(count))
+            .query_param(Parameter()
+                .key("page")
+                .value(page))
+            .query_param(Parameter()
+                .key("show_files_hidden_by_limit")
+                .value(show_files_hidden_by_limit))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(FilesListSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                FilesListErrorSchemaException),
+        ).execute()
+
+    def files_revoke_public_url(self,
+                                token=None,
+                                file=None):
+        """Perform a POST request to /files.revokePublicURL.
+
+        Revokes public/external sharing access for a file
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `files:write:user`
+            file (str, optional): File to revoke
+
+        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.revokePublicURL")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token))
+            .form_param(Parameter()
+                .key("file")
+                .value(file))
+            .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(FilesRevokePublicUrlSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                FilesRevokePublicUrlErrorSchemaException),
+        ).execute()
+
+    def files_shared_public_url(self,
+                                token=None,
+                                file=None):
+        """Perform a POST request to /files.sharedPublicURL.
+
+        Enables a file for public/external sharing.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `files:write:user`
+            file (str, optional): File to share
+
+        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.sharedPublicURL")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token))
+            .form_param(Parameter()
+                .key("file")
+                .value(file))
+            .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(FilesSharedPublicUrlSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                FilesSharedPublicUrlErrorSchemaException),
+        ).execute()
+
+    def files_upload(self,
+                     token=None,
+                     file=None,
+                     content=None,
+                     filetype=None,
+                     filename=None,
+                     title=None,
+                     initial_comment=None,
+                     channels=None,
+                     thread_ts=None):
+        """Perform a POST request to /files.upload.
+
+        Uploads or creates a file.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `files:write:user`
+            file (str, optional): File contents via `multipart/form-data`. If
+                omitting this parameter, you must submit `content`.
+            content (str, optional): File contents via a POST variable. If omitting
+                this parameter, you must provide a `file`.
+            filetype (str, optional): A [file type](/types/file#file_types)
+                identifier.
+            filename (str, optional): Filename of file.
+            title (str, optional): Title of file.
+            initial_comment (str, optional): The message text introducing the file in
+                specified `channels`.
+            channels (str, optional): Comma-separated list of channel names or IDs
+                where the file will be shared.
+            thread_ts (float, optional): Provide another message's `ts` value to
+                upload this file as a reply. Never use a reply's `ts` value; use its
+                parent instead.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Success response after
+                uploading a file to a channel with an initial message
+
+        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.upload")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token))
+            .form_param(Parameter()
+                .key("file")
+                .value(file))
+            .form_param(Parameter()
+                .key("content")
+                .value(content))
+            .form_param(Parameter()
+                .key("filetype")
+                .value(filetype))
+            .form_param(Parameter()
+                .key("filename")
+                .value(filename))
+            .form_param(Parameter()
+                .key("title")
+                .value(title))
+            .form_param(Parameter()
+                .key("initial_comment")
+                .value(initial_comment))
+            .form_param(Parameter()
+                .key("channels")
+                .value(channels))
+            .form_param(Parameter()
+                .key("thread_ts")
+                .value(thread_ts))
+            .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(FilesUploadSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                FilesUploadErrorSchemaException),
+        ).execute()