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

slackwebapi/controllers/team_controller.py

@@ -0,0 +1,294 @@
+"""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.exceptions.team_access_logs_error_schema_exception import (
+    TeamAccessLogsErrorSchemaException,
+)
+from slackwebapi.exceptions.team_info_error_schema_exception import (
+    TeamInfoErrorSchemaException,
+)
+from slackwebapi.exceptions.team_integration_logs_error_schema_exception import (
+    TeamIntegrationLogsErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.default_success_template import (
+    DefaultSuccessTemplate,
+)
+from slackwebapi.models.team_access_logs_schema import (
+    TeamAccessLogsSchema,
+)
+from slackwebapi.models.team_info_schema import (
+    TeamInfoSchema,
+)
+from slackwebapi.models.team_integration_logs_schema import (
+    TeamIntegrationLogsSchema,
+)
+
+
+class TeamController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize TeamController object."""
+        super(TeamController, self).__init__(config)
+
+    def team_access_logs(self,
+                         token,
+                         before=None,
+                         count=None,
+                         page=None):
+        """Perform a GET request to /team.accessLogs.
+
+        Gets the access logs for the current team.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin`
+            before (str, optional): End of time range of logs to include in results
+                (inclusive).
+            count (str, optional): The request query parameter.
+            page (str, 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. This response
+                demonstrates pagination and two access log entries.
+
+        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("/team.accessLogs")
+            .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("before")
+                .value(before))
+            .query_param(Parameter()
+                .key("count")
+                .value(count))
+            .query_param(Parameter()
+                .key("page")
+                .value(page))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(TeamAccessLogsSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "A workspace must be on a paid plan to use this method, otherwise the"
+                " `paid_only` error is thrown:",
+                TeamAccessLogsErrorSchemaException),
+        ).execute()
+
+    def team_billable_info(self,
+                           token,
+                           user=None):
+        """Perform a GET request to /team.billableInfo.
+
+        Gets billable users information for the current team.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin`
+            user (str, optional): A user to retrieve the billable information for.
+                Defaults to all users.
+
+        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("/team.billableInfo")
+            .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("user")
+                .value(user))
+            .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 team_info(self,
+                  token,
+                  team=None):
+        """Perform a GET request to /team.info.
+
+        Gets information about the current team.
+
+        Args:
+            token (str): Authentication token. Requires scope: `team:read`
+            team (str, optional): Team to get info on, if omitted, will return
+                information about the current team. Will only return team that the
+                authenticated token is allowed to see through external shared channels
+
+        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("/team.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("team")
+                .value(team))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(TeamInfoSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                TeamInfoErrorSchemaException),
+        ).execute()
+
+    def team_integration_logs(self,
+                              token,
+                              app_id=None,
+                              change_type=None,
+                              count=None,
+                              page=None,
+                              service_id=None,
+                              user=None):
+        """Perform a GET request to /team.integrationLogs.
+
+        Gets the integration logs for the current team.
+
+        Args:
+            token (str): Authentication token. Requires scope: `admin`
+            app_id (str, optional): Filter logs to this Slack app. Defaults to all
+                logs.
+            change_type (str, optional): Filter logs with this change type. Defaults
+                to all logs.
+            count (str, optional): The request query parameter.
+            page (str, optional): The request query parameter.
+            service_id (str, optional): Filter logs to this service. Defaults to all
+                logs.
+            user (str, optional): Filter logs generated by this user’s actions.
+                Defaults to all logs.
+
+        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("/team.integrationLogs")
+            .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("app_id")
+                .value(app_id))
+            .query_param(Parameter()
+                .key("change_type")
+                .value(change_type))
+            .query_param(Parameter()
+                .key("count")
+                .value(count))
+            .query_param(Parameter()
+                .key("page")
+                .value(page))
+            .query_param(Parameter()
+                .key("service_id")
+                .value(service_id))
+            .query_param(Parameter()
+                .key("user")
+                .value(user))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(TeamIntegrationLogsSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                TeamIntegrationLogsErrorSchemaException),
+        ).execute()

slackwebapi/controllers/team_profile_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.team_profile_get_error_schema_exception import (
+    TeamProfileGetErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.team_profile_get_success_schema import (
+    TeamProfileGetSuccessSchema,
+)
+
+
+class TeamProfileController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize TeamProfileController object."""
+        super(TeamProfileController, self).__init__(config)
+
+    def team_profile_get(self,
+                         token,
+                         visibility=None):
+        """Perform a GET request to /team.profile.get.
+
+        Retrieve a team's profile.
+
+        Args:
+            token (str): Authentication token. Requires scope: `users.profile:read`
+            visibility (str, optional): Filter by visibility.
+
+        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("/team.profile.get")
+            .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("visibility")
+                .value(visibility))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(TeamProfileGetSuccessSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                TeamProfileGetErrorSchemaException),
+        ).execute()