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

slackwebapi/controllers/apps_permissions_scopes_controller.py

@@ -0,0 +1,80 @@
+"""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.apps_permissions_scopes_list_error_schema_exception import (
+    AppsPermissionsScopesListErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.api_permissions_scopes_list_success_schema import (
+    ApiPermissionsScopesListSuccessSchema,
+)
+
+
+class AppsPermissionsScopesController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AppsPermissionsScopesController object."""
+        super(AppsPermissionsScopesController, self).__init__(config)
+
+    def apps_permissions_scopes_list(self,
+                                     token):
+        """Perform a GET request to /apps.permissions.scopes.list.
+
+        Returns list of scopes this app has on a team.
+
+        Args:
+            token (str): Authentication token. Requires scope: `none`
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical successful
+                paginated 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("/apps.permissions.scopes.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"))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(ApiPermissionsScopesListSuccessSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                AppsPermissionsScopesListErrorSchemaException),
+        ).execute()

slackwebapi/controllers/apps_permissions_users_controller.py

@@ -0,0 +1,158 @@
+"""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 AppsPermissionsUsersController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AppsPermissionsUsersController object."""
+        super(AppsPermissionsUsersController, self).__init__(config)
+
+    def apps_permissions_users_list(self,
+                                    token,
+                                    cursor=None,
+                                    limit=None):
+        """Perform a GET request to /apps.permissions.users.list.
+
+        Returns list of user grants and corresponding scopes this app has on a team.
+
+        Args:
+            token (str): Authentication token. Requires scope: `none`
+            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.
+            limit (int, optional): The maximum number of items to return.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical successful
+                paginated 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("/apps.permissions.users.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 apps_permissions_users_request(self,
+                                       token,
+                                       scopes,
+                                       trigger_id,
+                                       user):
+        """Perform a GET request to /apps.permissions.users.request.
+
+        Enables an app to trigger a permissions modal to grant an app access to a
+        user access scope.
+
+        Args:
+            token (str): Authentication token. Requires scope: `none`
+            scopes (str): A comma separated list of user scopes to request for
+            trigger_id (str): Token used to trigger the request
+            user (str): The user this scope is being requested for
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Standard success
+                response when used with a user token
+
+        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("/apps.permissions.users.request")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("scopes")
+                .value(scopes)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("trigger_id")
+                .value(trigger_id)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("user")
+                .value(user)
+                .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",
+                "Standard failure response when trigger_id is invalid",
+                DefaultErrorTemplateException),
+        ).execute()

slackwebapi/controllers/auth_controller.py

@@ -0,0 +1,136 @@
+"""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.auth_revoke_error_schema_exception import (
+    AuthRevokeErrorSchemaException,
+)
+from slackwebapi.exceptions.auth_test_error_schema_exception import (
+    AuthTestErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.auth_revoke_schema import (
+    AuthRevokeSchema,
+)
+from slackwebapi.models.auth_test_success_schema import (
+    AuthTestSuccessSchema,
+)
+
+
+class AuthController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AuthController object."""
+        super(AuthController, self).__init__(config)
+
+    def auth_revoke(self,
+                    token,
+                    test=None):
+        """Perform a GET request to /auth.revoke.
+
+        Revokes a token.
+
+        Args:
+            token (str): Authentication token. Requires scope: `none`
+            test (bool, optional): Setting this parameter to `1` triggers a _testing
+                mode_ where the specified token will not actually be revoked.
+
+        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("/auth.revoke")
+            .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("test")
+                .value(test))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(AuthRevokeSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                AuthRevokeErrorSchemaException),
+        ).execute()
+
+    def auth_test(self,
+                  token):
+        """Perform a GET request to /auth.test.
+
+        Checks authentication & identity.
+
+        Args:
+            token (str): Authentication token. Requires scope: `none`
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Standard success
+                response when used with a user token
+
+        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("/auth.test")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .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(AuthTestSuccessSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Standard failure response when used with an invalid token",
+                AuthTestErrorSchemaException),
+        ).execute()

slackwebapi/controllers/base_controller.py

@@ -0,0 +1,72 @@
+"""slackwebapi.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+import platform
+
+from apimatic_core.api_call import ApiCall
+from apimatic_core.types.error_case import ErrorCase
+
+from slackwebapi.exceptions.api_exception import (
+    ApiException,
+)
+
+
+class BaseController(object):
+    """All controllers inherit from this base class.
+
+    Attributes:
+        config (Configuration): The HttpClient which a specific controller
+            instance will use. By default all the controller objects share
+            the same HttpClient. A user can use his own custom HttpClient
+            as well.
+        http_call_back (HttpCallBack): An object which holds call back
+            methods to be called before and after the execution of an HttpRequest.
+        new_api_call_builder (APICall): Returns the API Call builder instance.
+
+    """
+
+    @staticmethod
+    def user_agent():
+        """Return UserAgent value."""
+        return "Python-SDK/1.1.1 [OS: {os-info}, Engine: {engine}/{engine-version}]"
+
+    @staticmethod
+    def user_agent_parameters():
+        """Return UserAgentParameters value."""
+        return {
+            "engine": {"value": platform.python_implementation(), "encode": False},
+            "engine-version": {"value": platform.python_version(), "encode": False},
+            "os-info": {"value": platform.system(), "encode": False},
+        }
+
+    @staticmethod
+    def global_errors():
+        """Return GlobalErrors value."""
+        return {
+            "default": ErrorCase()
+                .error_message("HTTP response not OK.")
+                .exception_type(ApiException),
+        }
+
+    def __init__(self, config):
+        """Initialize BaseController object."""
+        self._config = config.get_http_client_configuration()
+        self._http_call_back = self.config.http_callback
+        self.api_call = ApiCall(config)
+
+    @property
+    def config(self):
+        """Return Configuration object."""
+        return self._config
+
+    @property
+    def http_call_back(self):
+        """Return HttpCallBack object."""
+        return self._http_call_back
+
+    @property
+    def new_api_call_builder(self):
+        """Return New ApiCallBuilder object."""
+        return self.api_call.new_builder

slackwebapi/controllers/bots_controller.py

@@ -0,0 +1,85 @@
+"""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.bots_info_error_schema_exception import (
+    BotsInfoErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.bots_info_schema import (
+    BotsInfoSchema,
+)
+
+
+class BotsController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize BotsController object."""
+        super(BotsController, self).__init__(config)
+
+    def bots_info(self,
+                  token,
+                  bot=None):
+        """Perform a GET request to /bots.info.
+
+        Gets information about a bot user.
+
+        Args:
+            token (str): Authentication token. Requires scope: `users:read`
+            bot (str, optional): Bot user to get info on
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. When successful,
+                returns bot info by bot ID.
+
+        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("/bots.info")
+            .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("bot")
+                .value(bot))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(BotsInfoSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "When no bot can be found, it returns an error.",
+                BotsInfoErrorSchemaException),
+        ).execute()