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

slackwebapi/controllers/rtm_controller.py

@@ -0,0 +1,93 @@
+"""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.rtm_connect_error_schema_exception import (
+    RtmConnectErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.rtm_connect_schema import (
+    RtmConnectSchema,
+)
+
+
+class RtmController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize RtmController object."""
+        super(RtmController, self).__init__(config)
+
+    def rtm_connect(self,
+                    token,
+                    batch_presence_aware=None,
+                    presence_sub=None):
+        """Perform a GET request to /rtm.connect.
+
+        Starts a Real Time Messaging session.
+
+        Args:
+            token (str): Authentication token. Requires scope: `rtm:stream`
+            batch_presence_aware (bool, optional): Batch presence deliveries via
+                subscription. Enabling changes the shape of `presence_change` events.
+                See [batch presence](/docs/presence-and-status#batching).
+            presence_sub (bool, optional): Only deliver presence events when
+                requested by subscription. See [presence
+                subscriptions](/docs/presence-and-status#subscriptions).
+
+        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("/rtm.connect")
+            .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("batch_presence_aware")
+                .value(batch_presence_aware))
+            .query_param(Parameter()
+                .key("presence_sub")
+                .value(presence_sub))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(RtmConnectSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                RtmConnectErrorSchemaException),
+        ).execute()

slackwebapi/controllers/search_controller.py

@@ -0,0 +1,114 @@
+"""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 SearchController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize SearchController object."""
+        super(SearchController, self).__init__(config)
+
+    def search_messages(self,
+                        token,
+                        query,
+                        count=None,
+                        highlight=None,
+                        page=None,
+                        sort=None,
+                        sort_dir=None):
+        """Perform a GET request to /search.messages.
+
+        Searches for messages matching a query.
+
+        Args:
+            token (str): Authentication token. Requires scope: `search:read`
+            query (str): Search query.
+            count (int, optional): Pass the number of results you want per "page".
+                Maximum of `100`.
+            highlight (bool, optional): Pass a value of `true` to enable query
+                highlight markers (see below).
+            page (int, optional): The request query parameter.
+            sort (str, optional): Return matches sorted by either `score` or
+                `timestamp`.
+            sort_dir (str, optional): Change sort direction to ascending (`asc`) or
+                descending (`desc`).
+
+        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("/search.messages")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("query")
+                .value(query)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("count")
+                .value(count))
+            .query_param(Parameter()
+                .key("highlight")
+                .value(highlight))
+            .query_param(Parameter()
+                .key("page")
+                .value(page))
+            .query_param(Parameter()
+                .key("sort")
+                .value(sort))
+            .query_param(Parameter()
+                .key("sort_dir")
+                .value(sort_dir))
+            .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/stars_controller.py

@@ -0,0 +1,246 @@
+"""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.stars_add_error_schema_exception import (
+    StarsAddErrorSchemaException,
+)
+from slackwebapi.exceptions.stars_list_error_schema_exception import (
+    StarsListErrorSchemaException,
+)
+from slackwebapi.exceptions.stars_remove_error_schema_exception import (
+    StarsRemoveErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.stars_add_schema import (
+    StarsAddSchema,
+)
+from slackwebapi.models.stars_list_schema import (
+    StarsListSchema,
+)
+from slackwebapi.models.stars_remove_schema import (
+    StarsRemoveSchema,
+)
+
+
+class StarsController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize StarsController object."""
+        super(StarsController, self).__init__(config)
+
+    def stars_add(self,
+                  token,
+                  channel=None,
+                  file=None,
+                  file_comment=None,
+                  timestamp=None):
+        """Perform a POST request to /stars.add.
+
+        Adds a star to an item.
+
+        Args:
+            token (str): Authentication token. Requires scope: `stars:write`
+            channel (str, optional): Channel to add star to, or channel where the
+                message to add star to was posted (used with `timestamp`).
+            file (str, optional): File to add star to.
+            file_comment (str, optional): File comment to add star to.
+            timestamp (str, optional): Timestamp of the message to add star to.
+
+        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("/stars.add")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("channel")
+                .value(channel))
+            .form_param(Parameter()
+                .key("file")
+                .value(file))
+            .form_param(Parameter()
+                .key("file_comment")
+                .value(file_comment))
+            .form_param(Parameter()
+                .key("timestamp")
+                .value(timestamp))
+            .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(StarsAddSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                StarsAddErrorSchemaException),
+        ).execute()
+
+    def stars_list(self,
+                   token=None,
+                   count=None,
+                   page=None,
+                   cursor=None,
+                   limit=None):
+        """Perform a GET request to /stars.list.
+
+        Lists stars for a user.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope: `stars:read`
+            count (str, optional): The request query parameter.
+            page (str, optional): The request query parameter.
+            cursor (str, optional): Parameter for pagination. 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. See [pagination](/docs/pagination) for more details.
+            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.
+
+        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("/stars.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("count")
+                .value(count))
+            .query_param(Parameter()
+                .key("page")
+                .value(page))
+            .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(StarsListSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                StarsListErrorSchemaException),
+        ).execute()
+
+    def stars_remove(self,
+                     token,
+                     channel=None,
+                     file=None,
+                     file_comment=None,
+                     timestamp=None):
+        """Perform a POST request to /stars.remove.
+
+        Removes a star from an item.
+
+        Args:
+            token (str): Authentication token. Requires scope: `stars:write`
+            channel (str, optional): Channel to remove star from, or channel where
+                the message to remove star from was posted (used with `timestamp`).
+            file (str, optional): File to remove star from.
+            file_comment (str, optional): File comment to remove star from.
+            timestamp (str, optional): Timestamp of the message to remove star 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("/stars.remove")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("channel")
+                .value(channel))
+            .form_param(Parameter()
+                .key("file")
+                .value(file))
+            .form_param(Parameter()
+                .key("file_comment")
+                .value(file_comment))
+            .form_param(Parameter()
+                .key("timestamp")
+                .value(timestamp))
+            .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(StarsRemoveSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                StarsRemoveErrorSchemaException),
+        ).execute()