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

slackwebapi/controllers/admin_users_session_controller.py

@@ -0,0 +1,151 @@
+"""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 AdminUsersSessionController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AdminUsersSessionController object."""
+        super(AdminUsersSessionController, self).__init__(config)
+
+    def admin_users_session_invalidate(self,
+                                       token,
+                                       team_id,
+                                       session_id):
+        """Perform a POST request to /admin.users.session.invalidate.
+
+        Invalidate a single session for a user by session_id
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.users:write`
+            team_id (str): ID of the team that the session belongs to
+            session_id (int): The request form parameter.
+
+        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.users.session.invalidate")
+            .http_method(HttpMethodEnum.POST)
+            .header_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("session_id")
+                .value(session_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()
+
+    def admin_users_session_reset(self,
+                                  token,
+                                  user_id,
+                                  mobile_only=None,
+                                  web_only=None):
+        """Perform a POST request to /admin.users.session.reset.
+
+        Wipes all valid sessions on all devices for a given user
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin.users:write`
+            user_id (str): The ID of the user to wipe sessions for
+            mobile_only (bool, optional): Only expire mobile sessions (default: false)
+            web_only (bool, optional): Only expire web sessions (default: false)
+
+        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.users.session.reset")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("user_id")
+                .value(user_id)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("mobile_only")
+                .value(mobile_only))
+            .form_param(Parameter()
+                .key("web_only")
+                .value(web_only))
+            .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/api_controller.py

@@ -0,0 +1,84 @@
+"""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.api_test_error_schema_exception import (
+    ApiTestErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.api_test_success_schema import (
+    ApiTestSuccessSchema,
+)
+
+
+class ApiController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize ApiController object."""
+        super(ApiController, self).__init__(config)
+
+    def api_test(self,
+                 error=None,
+                 foo=None):
+        """Perform a GET request to /api.test.
+
+        Checks API calling code.
+
+        Args:
+            error (str, optional): Error response to return
+            foo (str, optional): example property to return
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Standard 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("/api.test")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("error")
+                .value(error))
+            .query_param(Parameter()
+                .key("foo")
+                .value(foo))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(ApiTestSuccessSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Artificial error response",
+                ApiTestErrorSchemaException),
+        ).execute()

slackwebapi/controllers/apps_controller.py

@@ -0,0 +1,88 @@
+"""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_uninstall_error_schema_exception import (
+    AppsUninstallErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.apps_uninstall_schema import (
+    AppsUninstallSchema,
+)
+
+
+class AppsController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AppsController object."""
+        super(AppsController, self).__init__(config)
+
+    def apps_uninstall(self,
+                       token=None,
+                       client_id=None,
+                       client_secret=None):
+        """Perform a GET request to /apps.uninstall.
+
+        Uninstalls your app from a workspace.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope: `none`
+            client_id (str, optional): Issued when you created your application.
+            client_secret (str, optional): Issued when you created your application.
+
+        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("/apps.uninstall")
+            .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("client_id")
+                .value(client_id))
+            .query_param(Parameter()
+                .key("client_secret")
+                .value(client_secret))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(AppsUninstallSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                AppsUninstallErrorSchemaException),
+        ).execute()

slackwebapi/controllers/apps_event_authorizations_controller.py

@@ -0,0 +1,96 @@
+"""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 AppsEventAuthorizationsController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AppsEventAuthorizationsController object."""
+        super(AppsEventAuthorizationsController, self).__init__(config)
+
+    def apps_event_authorizations_list(self,
+                                       token,
+                                       event_context,
+                                       cursor=None,
+                                       limit=None):
+        """Perform a GET request to /apps.event.authorizations.list.
+
+        Get a list of authorizations for the given event context. Each authorization
+        represents an app installation that the event is visible to.
+
+        Args:
+            token (str): Authentication token. Requires scope: `authorizations:read`
+            event_context (str): The request query parameter.
+            cursor (str, optional): The request query parameter.
+            limit (int, optional): The request query parameter.
+
+        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("/apps.event.authorizations.list")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("event_context")
+                .value(event_context)
+                .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()

slackwebapi/controllers/apps_permissions_controller.py

@@ -0,0 +1,142 @@
+"""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_info_error_schema_exception import (
+    AppsPermissionsInfoErrorSchemaException,
+)
+from slackwebapi.exceptions.apps_permissions_request_error_schema_exception import (
+    AppsPermissionsRequestErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.apps_permissions_info_schema import (
+    AppsPermissionsInfoSchema,
+)
+from slackwebapi.models.apps_permissions_request_schema import (
+    AppsPermissionsRequestSchema,
+)
+
+
+class AppsPermissionsController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AppsPermissionsController object."""
+        super(AppsPermissionsController, self).__init__(config)
+
+    def apps_permissions_info(self,
+                              token=None):
+        """Perform a GET request to /apps.permissions.info.
+
+        Returns list of permissions this app has on a team.
+
+        Args:
+            token (str, optional): 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("/apps.permissions.info")
+            .http_method(HttpMethodEnum.GET)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/x-www-form-urlencoded"))
+            .query_param(Parameter()
+                .key("token")
+                .value(token))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(AppsPermissionsInfoSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Standard failure response when used with an invalid token",
+                AppsPermissionsInfoErrorSchemaException),
+        ).execute()
+
+    def apps_permissions_request(self,
+                                 token,
+                                 scopes,
+                                 trigger_id):
+        """Perform a GET request to /apps.permissions.request.
+
+        Allows an app to request additional scopes
+
+        Args:
+            token (str): Authentication token. Requires scope: `none`
+            scopes (str): A comma separated list of scopes to request for
+            trigger_id (str): Token used to trigger the permissions API
+
+        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.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))
+            .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(AppsPermissionsRequestSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Standard failure response when trigger_id is invalid",
+                AppsPermissionsRequestErrorSchemaException),
+        ).execute()

slackwebapi/controllers/apps_permissions_resources_controller.py

@@ -0,0 +1,94 @@
+"""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_resources_list_error_schema_exception import (  # noqa: E501
+    AppsPermissionsResourcesListErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.apps_permissions_resources_list_success_schema import (
+    AppsPermissionsResourcesListSuccessSchema,
+)
+
+
+class AppsPermissionsResourcesController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize AppsPermissionsResourcesController object."""
+        super(AppsPermissionsResourcesController, self).__init__(config)
+
+    def apps_permissions_resources_list(self,
+                                        token,
+                                        cursor=None,
+                                        limit=None):
+        """Perform a GET request to /apps.permissions.resources.list.
+
+        Returns list of resource grants 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.resources.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(AppsPermissionsResourcesListSuccessSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                AppsPermissionsResourcesListErrorSchemaException),
+        ).execute()