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

slackwebapi/controllers/users_controller.py

@@ -0,0 +1,639 @@
+"""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.users_conversations_error_schema_exception import (
+    UsersConversationsErrorSchemaException,
+)
+from slackwebapi.exceptions.users_counts_error_schema_exception import (
+    UsersCountsErrorSchemaException,
+)
+from slackwebapi.exceptions.users_delete_photo_error_schema_exception import (
+    UsersDeletePhotoErrorSchemaException,
+)
+from slackwebapi.exceptions.users_identity_error_schema_exception import (
+    UsersIdentityErrorSchemaException,
+)
+from slackwebapi.exceptions.users_info_error_schema_exception import (
+    UsersInfoErrorSchemaException,
+)
+from slackwebapi.exceptions.users_list_error_schema_exception import (
+    UsersListErrorSchemaException,
+)
+from slackwebapi.exceptions.users_lookup_by_email_error_schema_exception import (
+    UsersLookupByEmailErrorSchemaException,
+)
+from slackwebapi.exceptions.users_set_active_error_schema_exception import (
+    UsersSetActiveErrorSchemaException,
+)
+from slackwebapi.exceptions.users_set_photo_error_schema_exception import (
+    UsersSetPhotoErrorSchemaException,
+)
+from slackwebapi.exceptions.users_set_presence_error_schema_exception import (
+    UsersSetPresenceErrorSchemaException,
+)
+from slackwebapi.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from slackwebapi.models.api_method_users_get_presence import (
+    ApiMethodUsersGetPresence,
+)
+from slackwebapi.models.users_conversations_success_schema import (
+    UsersConversationsSuccessSchema,
+)
+from slackwebapi.models.users_delete_photo_schema import (
+    UsersDeletePhotoSchema,
+)
+from slackwebapi.models.users_info_success_schema import (
+    UsersInfoSuccessSchema,
+)
+from slackwebapi.models.users_list_schema import (
+    UsersListSchema,
+)
+from slackwebapi.models.users_lookup_by_email_success_schema import (
+    UsersLookupByEmailSuccessSchema,
+)
+from slackwebapi.models.users_set_active_schema import (
+    UsersSetActiveSchema,
+)
+from slackwebapi.models.users_set_photo_schema import (
+    UsersSetPhotoSchema,
+)
+from slackwebapi.models.users_set_presence_schema import (
+    UsersSetPresenceSchema,
+)
+
+
+class UsersController(BaseController):
+    """A Controller to access Endpoints in the slackwebapi API."""
+
+    def __init__(self, config):
+        """Initialize UsersController object."""
+        super(UsersController, self).__init__(config)
+
+    def users_conversations(self,
+                            token=None,
+                            user=None,
+                            types=None,
+                            exclude_archived=None,
+                            limit=None,
+                            cursor=None):
+        """Perform a GET request to /users.conversations.
+
+        List conversations the calling user may access.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `conversations:read`
+            user (str, optional): Browse conversations by a specific user ID's
+                membership. Non-public channels are restricted to those where the
+                calling user shares membership.
+            types (str, optional): Mix and match channel types by providing a
+                comma-separated list of any combination of `public_channel`,
+                `private_channel`, `mpim`, `im`
+            exclude_archived (bool, optional): Set to `true` to exclude archived
+                channels from the list
+            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. Must be an integer no larger than 1000.
+            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.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Typical success
+                response with only public channels. Note how `num_members` and
+                `is_member` are not returned like typical `conversations` objects.
+
+        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("/users.conversations")
+            .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("types")
+                .value(types))
+            .query_param(Parameter()
+                .key("exclude_archived")
+                .value(exclude_archived))
+            .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(UsersConversationsSuccessSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersConversationsErrorSchemaException),
+        ).execute()
+
+    def users_delete_photo(self,
+                           token):
+        """Perform a POST request to /users.deletePhoto.
+
+        Delete the user profile photo
+
+        Args:
+            token (str): Authentication token. Requires scope: `users.profile:write`
+
+        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("/users.deletePhoto")
+            .http_method(HttpMethodEnum.POST)
+            .form_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(UsersDeletePhotoSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersDeletePhotoErrorSchemaException),
+        ).execute()
+
+    def users_get_presence(self,
+                           token,
+                           user=None):
+        """Perform a GET request to /users.getPresence.
+
+        Gets user presence information.
+
+        Args:
+            token (str): Authentication token. Requires scope: `users:read`
+            user (str, optional): User to get presence info on. Defaults to the
+                authed user.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. When requesting
+                information for a different user, this method just returns the
+                current presence (either `active` or `away`).
+
+        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("/users.getPresence")
+            .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(ApiMethodUsersGetPresence.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersCountsErrorSchemaException),
+        ).execute()
+
+    def users_identity(self,
+                       token=None):
+        """Perform a GET request to /users.identity.
+
+        Get a user's identity.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope:
+                `identity.basic`
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. You will receive at a
+                minimum the following information:
+
+        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("/users.identity")
+            .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.dynamic_deserialize)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersIdentityErrorSchemaException),
+        ).execute()
+
+    def users_info(self,
+                   token,
+                   include_locale=None,
+                   user=None):
+        """Perform a GET request to /users.info.
+
+        Gets information about a user.
+
+        Args:
+            token (str): Authentication token. Requires scope: `users:read`
+            include_locale (bool, optional): Set this to `true` to receive the locale
+                for this user. Defaults to `false`
+            user (str, optional): 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. 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("/users.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("include_locale")
+                .value(include_locale))
+            .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(UsersInfoSuccessSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersInfoErrorSchemaException),
+        ).execute()
+
+    def users_list(self,
+                   token=None,
+                   limit=None,
+                   cursor=None,
+                   include_locale=None):
+        """Perform a GET request to /users.list.
+
+        Lists all users in a Slack team.
+
+        Args:
+            token (str, optional): Authentication token. Requires scope: `users:read`
+            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
+                users list hasn't been reached. Providing no `limit` value will
+                result in Slack attempting to deliver you the entire result set. If
+                the collection is too large you may experience `limit_required` or
+                HTTP 500 errors.
+            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.
+            include_locale (bool, optional): Set this to `true` to receive the locale
+                for users. Defaults to `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("/users.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("limit")
+                .value(limit))
+            .query_param(Parameter()
+                .key("cursor")
+                .value(cursor))
+            .query_param(Parameter()
+                .key("include_locale")
+                .value(include_locale))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .auth(Single("slackAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(UsersListSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersListErrorSchemaException),
+        ).execute()
+
+    def users_lookup_by_email(self,
+                              token,
+                              email):
+        """Perform a GET request to /users.lookupByEmail.
+
+        Find a user with an email address.
+
+        Args:
+            token (str): Authentication token. Requires scope: `users:read.email`
+            email (str): An email address belonging to a user in the workspace
+
+        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("/users.lookupByEmail")
+            .http_method(HttpMethodEnum.GET)
+            .query_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .query_param(Parameter()
+                .key("email")
+                .value(email)
+                .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(UsersLookupByEmailSuccessSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersLookupByEmailErrorSchemaException),
+        ).execute()
+
+    def users_set_active(self,
+                         token):
+        """Perform a POST request to /users.setActive.
+
+        Marked a user as active. Deprecated and non-functional.
+
+        Args:
+            token (str): Authentication token. Requires scope: `users:write`
+
+        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("/users.setActive")
+            .http_method(HttpMethodEnum.POST)
+            .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(UsersSetActiveSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersSetActiveErrorSchemaException),
+        ).execute()
+
+    def users_set_photo(self,
+                        token,
+                        crop_w=None,
+                        crop_x=None,
+                        crop_y=None,
+                        image=None):
+        """Perform a POST request to /users.setPhoto.
+
+        Set the user profile photo
+
+        Args:
+            token (str): Authentication token. Requires scope: `users.profile:write`
+            crop_w (str, optional): Width/height of crop box (always square)
+            crop_x (str, optional): X coordinate of top-left corner of crop box
+            crop_y (str, optional): Y coordinate of top-left corner of crop box
+            image (str, optional): File contents via `multipart/form-data`.
+
+        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("/users.setPhoto")
+            .http_method(HttpMethodEnum.POST)
+            .form_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("crop_w")
+                .value(crop_w))
+            .form_param(Parameter()
+                .key("crop_x")
+                .value(crop_x))
+            .form_param(Parameter()
+                .key("crop_y")
+                .value(crop_y))
+            .form_param(Parameter()
+                .key("image")
+                .value(image))
+            .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(UsersSetPhotoSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersSetPhotoErrorSchemaException),
+        ).execute()
+
+    def users_set_presence(self,
+                           token,
+                           presence):
+        """Perform a POST request to /users.setPresence.
+
+        Manually sets user presence.
+
+        Args:
+            token (str): Authentication token. Requires scope: `users:write`
+            presence (str): Either `auto` or `away`
+
+        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("/users.setPresence")
+            .http_method(HttpMethodEnum.POST)
+            .header_param(Parameter()
+                .key("token")
+                .value(token)
+                .is_required(True))
+            .form_param(Parameter()
+                .key("presence")
+                .value(presence)
+                .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(UsersSetPresenceSchema.from_dictionary)
+            .is_api_response(True)
+            .local_error("default",
+                "Typical error response",
+                UsersSetPresenceErrorSchemaException),
+        ).execute()