Fix #1108 add support for admin.conversations retention (#1109)

Author: ruberVulpes

integration_tests/web/test_admin_conversations_retention.py

@@ -0,0 +1,99 @@
+import asyncio
+import logging
+import os
+import time
+import unittest
+
+from integration_tests.env_variable_names import SLACK_SDK_TEST_GRID_ORG_ADMIN_USER_TOKEN, SLACK_SDK_TEST_GRID_TEAM_ID
+from integration_tests.helpers import async_test
+from slack_sdk.web import WebClient
+from slack_sdk.web.async_client import AsyncWebClient
+
+
+class TestWebClient(unittest.TestCase):
+    """Runs integration tests with real Slack API"""
+
+    def setUp(self):
+        self.logger = logging.getLogger(__name__)
+        self.org_admin_token = os.environ[SLACK_SDK_TEST_GRID_ORG_ADMIN_USER_TOKEN]
+        self.team_id = os.environ[SLACK_SDK_TEST_GRID_TEAM_ID]
+        self.sync_client: WebClient = WebClient(token=self.org_admin_token)
+        self.async_client: AsyncWebClient = AsyncWebClient(token=self.org_admin_token)
+
+        self.channel_name = f"test-channel-{int(round(time.time() * 1000))}"
+
+    def tearDown(self):
+        pass
+
+    def test_sync(self):
+        client = self.sync_client
+
+        conv_creation = client.admin_conversations_create(
+            is_private=False,
+            name=self.channel_name,
+            team_id=self.team_id,
+        )
+        self.assertIsNotNone(conv_creation)
+        created_channel_id = conv_creation.data["channel_id"]
+
+        self.assertIsNotNone(
+            client.admin_conversations_setCustomRetention(
+                channel_id=created_channel_id,
+                duration_days=365,
+            )
+        )
+        self.assertIsNotNone(
+            client.admin_conversations_getCustomRetention(
+                channel_id=created_channel_id,
+            )
+        )
+        self.assertIsNotNone(
+            client.admin_conversations_removeCustomRetention(
+                channel_id=created_channel_id,
+            )
+        )
+
+        time.sleep(2)  # To avoid internal_error
+        self.assertIsNotNone(
+            client.admin_conversations_delete(
+                channel_id=created_channel_id,
+            )
+        )
+
+    @async_test
+    async def test_async(self):
+        # await asyncio.sleep(seconds) are included to avoid rate limiting errors
+
+        client = self.async_client
+
+        conv_creation = await client.admin_conversations_create(
+            is_private=False,
+            name=self.channel_name,
+            team_id=self.team_id,
+        )
+        self.assertIsNotNone(conv_creation)
+        created_channel_id = conv_creation.data["channel_id"]
+
+        self.assertIsNotNone(
+            await client.admin_conversations_setCustomRetention(
+                channel_id=created_channel_id,
+                duration_days=365,
+            )
+        )
+        self.assertIsNotNone(
+            await client.admin_conversations_getCustomRetention(
+                channel_id=created_channel_id,
+            )
+        )
+        self.assertIsNotNone(
+            await client.admin_conversations_removeCustomRetention(
+                channel_id=created_channel_id,
+            )
+        )
+
+        await asyncio.sleep(2)  # To avoid internal_error
+        self.assertIsNotNone(
+            await client.admin_conversations_delete(
+                channel_id=created_channel_id,
+            )
+        )

slack_sdk/web/async_client.py

@@ -777,6 +777,49 @@ async def admin_conversations_getTeams(
         )
         return await self.api_call("admin.conversations.getTeams", params=kwargs)
 
+    async def admin_conversations_getCustomRetention(
+        self,
+        *,
+        channel_id: str,
+        **kwargs,
+    ) -> AsyncSlackResponse:
+        """Get a channel's retention policy
+        https://api.slack.com/methods/admin.conversations.getCustomRetention
+        """
+        kwargs.update({"channel_id": channel_id})
+        return await self.api_call(
+            "admin.conversations.getCustomRetention", params=kwargs
+        )
+
+    async def admin_conversations_removeCustomRetention(
+        self,
+        *,
+        channel_id: str,
+        **kwargs,
+    ) -> AsyncSlackResponse:
+        """Remove a channel's retention policy
+        https://api.slack.com/methods/admin.conversations.removeCustomRetention
+        """
+        kwargs.update({"channel_id": channel_id})
+        return await self.api_call(
+            "admin.conversations.removeCustomRetention", params=kwargs
+        )
+
+    async def admin_conversations_setCustomRetention(
+        self,
+        *,
+        channel_id: str,
+        duration_days: int,
+        **kwargs,
+    ) -> AsyncSlackResponse:
+        """Set a channel's retention policy
+        https://api.slack.com/methods/admin.conversations.setCustomRetention
+        """
+        kwargs.update({"channel_id": channel_id, "duration_days": duration_days})
+        return await self.api_call(
+            "admin.conversations.setCustomRetention", params=kwargs
+        )
+
     async def admin_emoji_add(
         self,
         *,

slack_sdk/web/client.py

@@ -746,6 +746,43 @@ def admin_conversations_getTeams(
         )
         return self.api_call("admin.conversations.getTeams", params=kwargs)
 
+    def admin_conversations_getCustomRetention(
+        self,
+        *,
+        channel_id: str,
+        **kwargs,
+    ) -> SlackResponse:
+        """Get a channel's retention policy
+        https://api.slack.com/methods/admin.conversations.getCustomRetention
+        """
+        kwargs.update({"channel_id": channel_id})
+        return self.api_call("admin.conversations.getCustomRetention", params=kwargs)
+
+    def admin_conversations_removeCustomRetention(
+        self,
+        *,
+        channel_id: str,
+        **kwargs,
+    ) -> SlackResponse:
+        """Remove a channel's retention policy
+        https://api.slack.com/methods/admin.conversations.removeCustomRetention
+        """
+        kwargs.update({"channel_id": channel_id})
+        return self.api_call("admin.conversations.removeCustomRetention", params=kwargs)
+
+    def admin_conversations_setCustomRetention(
+        self,
+        *,
+        channel_id: str,
+        duration_days: int,
+        **kwargs,
+    ) -> SlackResponse:
+        """Set a channel's retention policy
+        https://api.slack.com/methods/admin.conversations.setCustomRetention
+        """
+        kwargs.update({"channel_id": channel_id, "duration_days": duration_days})
+        return self.api_call("admin.conversations.setCustomRetention", params=kwargs)
+
     def admin_emoji_add(
         self,
         *,

slack_sdk/web/legacy_client.py

@@ -757,6 +757,43 @@ def admin_conversations_getTeams(
         )
         return self.api_call("admin.conversations.getTeams", params=kwargs)
 
+    def admin_conversations_getCustomRetention(
+        self,
+        *,
+        channel_id: str,
+        **kwargs,
+    ) -> Union[Future, SlackResponse]:
+        """Get a channel's retention policy
+        https://api.slack.com/methods/admin.conversations.getCustomRetention
+        """
+        kwargs.update({"channel_id": channel_id})
+        return self.api_call("admin.conversations.getCustomRetention", params=kwargs)
+
+    def admin_conversations_removeCustomRetention(
+        self,
+        *,
+        channel_id: str,
+        **kwargs,
+    ) -> Union[Future, SlackResponse]:
+        """Remove a channel's retention policy
+        https://api.slack.com/methods/admin.conversations.removeCustomRetention
+        """
+        kwargs.update({"channel_id": channel_id})
+        return self.api_call("admin.conversations.removeCustomRetention", params=kwargs)
+
+    def admin_conversations_setCustomRetention(
+        self,
+        *,
+        channel_id: str,
+        duration_days: int,
+        **kwargs,
+    ) -> Union[Future, SlackResponse]:
+        """Set a channel's retention policy
+        https://api.slack.com/methods/admin.conversations.setCustomRetention
+        """
+        kwargs.update({"channel_id": channel_id, "duration_days": duration_days})
+        return self.api_call("admin.conversations.setCustomRetention", params=kwargs)
+
     def admin_emoji_add(
         self,
         *,

tests/slack_sdk_async/web/test_web_client_coverage.py

@@ -15,9 +15,9 @@
 
 
 class TestWebClientCoverage(unittest.TestCase):
-    # 247 endpoints as of Aug 10, 2021
+    # 240 endpoints as of Sept 4, 2021
     # Can be fetched by running `var methodNames = [].slice.call(document.getElementsByClassName('apiReferenceFilterableList__listItemLink')).map(e => e.href.replace("https://api.slack.com/methods/", ""));console.log(methodNames.toString());console.log(methodNames.length);` on https://api.slack.com/methods
-    all_api_methods = "admin.analytics.getFile,admin.apps.approve,admin.apps.clearResolution,admin.apps.restrict,admin.apps.uninstall,admin.apps.approved.list,admin.apps.requests.list,admin.apps.restricted.list,admin.auth.policy.assignEntities,admin.auth.policy.getEntities,admin.auth.policy.removeEntities,admin.barriers.create,admin.barriers.delete,admin.barriers.list,admin.barriers.update,admin.conversations.archive,admin.conversations.convertToPrivate,admin.conversations.create,admin.conversations.delete,admin.conversations.disconnectShared,admin.conversations.getConversationPrefs,admin.conversations.getCustomRetention,admin.conversations.getTeams,admin.conversations.invite,admin.conversations.removeCustomRetention,admin.conversations.rename,admin.conversations.search,admin.conversations.setConversationPrefs,admin.conversations.setCustomRetention,admin.conversations.setTeams,admin.conversations.unarchive,admin.conversations.ekm.listOriginalConnectedChannelInfo,admin.conversations.restrictAccess.addGroup,admin.conversations.restrictAccess.listGroups,admin.conversations.restrictAccess.removeGroup,admin.emoji.add,admin.emoji.addAlias,admin.emoji.list,admin.emoji.remove,admin.emoji.rename,admin.inviteRequests.approve,admin.inviteRequests.deny,admin.inviteRequests.list,admin.inviteRequests.approved.list,admin.inviteRequests.denied.list,admin.teams.admins.list,admin.teams.create,admin.teams.list,admin.teams.owners.list,admin.teams.settings.info,admin.teams.settings.setDefaultChannels,admin.teams.settings.setDescription,admin.teams.settings.setDiscoverability,admin.teams.settings.setIcon,admin.teams.settings.setName,admin.usergroups.addChannels,admin.usergroups.addTeams,admin.usergroups.listChannels,admin.usergroups.removeChannels,admin.users.assign,admin.users.invite,admin.users.list,admin.users.remove,admin.users.setAdmin,admin.users.setExpiration,admin.users.setOwner,admin.users.setRegular,admin.users.session.clearSettings,admin.users.session.getSettings,admin.users.session.invalidate,admin.users.session.list,admin.users.session.reset,admin.users.session.setSettings,api.test,apps.connections.open,apps.event.authorizations.list,apps.uninstall,auth.revoke,auth.test,auth.teams.list,bots.info,calls.add,calls.end,calls.info,calls.update,calls.participants.add,calls.participants.remove,chat.delete,chat.deleteScheduledMessage,chat.getPermalink,chat.meMessage,chat.postEphemeral,chat.postMessage,chat.scheduleMessage,chat.unfurl,chat.update,chat.scheduledMessages.list,conversations.acceptSharedInvite,conversations.approveSharedInvite,conversations.archive,conversations.close,conversations.create,conversations.declineSharedInvite,conversations.history,conversations.info,conversations.invite,conversations.inviteShared,conversations.join,conversations.kick,conversations.leave,conversations.list,conversations.listConnectInvites,conversations.mark,conversations.members,conversations.open,conversations.rename,conversations.replies,conversations.setPurpose,conversations.setTopic,conversations.unarchive,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,files.comments.delete,files.delete,files.info,files.list,files.revokePublicURL,files.sharedPublicURL,files.upload,files.remote.add,files.remote.info,files.remote.list,files.remote.remove,files.remote.share,files.remote.update,migration.exchange,oauth.access,oauth.token,oauth.v2.access,oauth.v2.exchange,openid.connect.token,openid.connect.userInfo,pins.add,pins.list,pins.remove,reactions.add,reactions.get,reactions.list,reactions.remove,reminders.add,reminders.complete,reminders.delete,reminders.info,reminders.list,rtm.connect,rtm.start,search.all,search.files,search.messages,stars.add,stars.list,stars.remove,team.accessLogs,team.billableInfo,team.info,team.integrationLogs,team.profile.get,usergroups.create,usergroups.disable,usergroups.enable,usergroups.list,usergroups.update,usergroups.users.list,usergroups.users.update,users.conversations,users.deletePhoto,users.getPresence,users.identity,users.info,users.list,users.lookupByEmail,users.setActive,users.setPhoto,users.setPresence,users.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,workflows.stepCompleted,workflows.stepFailed,workflows.updateStep,apps.permissions.info,apps.permissions.request,apps.permissions.resources.list,apps.permissions.scopes.list,apps.permissions.users.list,apps.permissions.users.request,channels.archive,channels.create,channels.history,channels.info,channels.invite,channels.join,channels.kick,channels.leave,channels.list,channels.mark,channels.rename,channels.replies,channels.setPurpose,channels.setTopic,channels.unarchive,groups.archive,groups.create,groups.createChild,groups.history,groups.info,groups.invite,groups.kick,groups.leave,groups.list,groups.mark,groups.open,groups.rename,groups.replies,groups.setPurpose,groups.setTopic,groups.unarchive,im.close,im.history,im.list,im.mark,im.open,im.replies,mpim.close,mpim.history,mpim.list,mpim.mark,mpim.open,mpim.replies".split(
+    all_api_methods = "admin.analytics.getFile,admin.apps.approve,admin.apps.clearResolution,admin.apps.restrict,admin.apps.uninstall,admin.apps.approved.list,admin.apps.requests.list,admin.apps.restricted.list,admin.auth.policy.assignEntities,admin.auth.policy.getEntities,admin.auth.policy.removeEntities,admin.barriers.create,admin.barriers.delete,admin.barriers.list,admin.barriers.update,admin.conversations.archive,admin.conversations.convertToPrivate,admin.conversations.create,admin.conversations.delete,admin.conversations.disconnectShared,admin.conversations.getConversationPrefs,admin.conversations.getCustomRetention,admin.conversations.getTeams,admin.conversations.invite,admin.conversations.removeCustomRetention,admin.conversations.rename,admin.conversations.search,admin.conversations.setConversationPrefs,admin.conversations.setCustomRetention,admin.conversations.setTeams,admin.conversations.unarchive,admin.conversations.ekm.listOriginalConnectedChannelInfo,admin.conversations.restrictAccess.addGroup,admin.conversations.restrictAccess.listGroups,admin.conversations.restrictAccess.removeGroup,admin.emoji.add,admin.emoji.addAlias,admin.emoji.list,admin.emoji.remove,admin.emoji.rename,admin.inviteRequests.approve,admin.inviteRequests.deny,admin.inviteRequests.list,admin.inviteRequests.approved.list,admin.inviteRequests.denied.list,admin.teams.admins.list,admin.teams.create,admin.teams.list,admin.teams.owners.list,admin.teams.settings.info,admin.teams.settings.setDefaultChannels,admin.teams.settings.setDescription,admin.teams.settings.setDiscoverability,admin.teams.settings.setIcon,admin.teams.settings.setName,admin.usergroups.addChannels,admin.usergroups.addTeams,admin.usergroups.listChannels,admin.usergroups.removeChannels,admin.users.assign,admin.users.invite,admin.users.list,admin.users.remove,admin.users.setAdmin,admin.users.setExpiration,admin.users.setOwner,admin.users.setRegular,admin.users.session.clearSettings,admin.users.session.getSettings,admin.users.session.invalidate,admin.users.session.list,admin.users.session.reset,admin.users.session.setSettings,api.test,apps.connections.open,apps.event.authorizations.list,apps.uninstall,auth.revoke,auth.test,auth.teams.list,bots.info,calls.add,calls.end,calls.info,calls.update,calls.participants.add,calls.participants.remove,chat.delete,chat.deleteScheduledMessage,chat.getPermalink,chat.meMessage,chat.postEphemeral,chat.postMessage,chat.scheduleMessage,chat.unfurl,chat.update,chat.scheduledMessages.list,conversations.acceptSharedInvite,conversations.approveSharedInvite,conversations.archive,conversations.close,conversations.create,conversations.declineSharedInvite,conversations.history,conversations.info,conversations.invite,conversations.inviteShared,conversations.join,conversations.kick,conversations.leave,conversations.list,conversations.listConnectInvites,conversations.mark,conversations.members,conversations.open,conversations.rename,conversations.replies,conversations.setPurpose,conversations.setTopic,conversations.unarchive,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,files.comments.delete,files.delete,files.info,files.list,files.revokePublicURL,files.sharedPublicURL,files.upload,files.remote.add,files.remote.info,files.remote.list,files.remote.remove,files.remote.share,files.remote.update,migration.exchange,oauth.access,oauth.token,oauth.v2.access,oauth.v2.exchange,openid.connect.token,openid.connect.userInfo,pins.add,pins.list,pins.remove,reactions.add,reactions.get,reactions.list,reactions.remove,reminders.add,reminders.complete,reminders.delete,reminders.info,reminders.list,rtm.connect,rtm.start,search.all,search.files,search.messages,stars.add,stars.list,stars.remove,team.accessLogs,team.billableInfo,team.info,team.integrationLogs,team.profile.get,usergroups.create,usergroups.disable,usergroups.enable,usergroups.list,usergroups.update,usergroups.users.list,usergroups.users.update,users.conversations,users.deletePhoto,users.getPresence,users.identity,users.info,users.list,users.lookupByEmail,users.setActive,users.setPhoto,users.setPresence,users.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,workflows.stepCompleted,workflows.stepFailed,workflows.updateStep,apps.permissions.info,apps.permissions.request,apps.permissions.resources.list,apps.permissions.scopes.list,apps.permissions.users.list,apps.permissions.users.request,channels.archive,channels.create,channels.history,channels.info,channels.invite,channels.join,channels.leave,channels.list,channels.mark,channels.replies,channels.setPurpose,channels.setTopic,channels.unarchive,groups.archive,groups.create,groups.history,groups.info,groups.invite,groups.leave,groups.list,groups.mark,groups.open,groups.replies,groups.setPurpose,groups.setTopic,groups.unarchive,im.history,im.list,im.mark,im.open,im.replies,mpim.history,mpim.list,mpim.mark,mpim.open,mpim.replies".split(
         ","
     )
 
@@ -48,9 +48,6 @@ def setUp(self):
                 "openid.connect.token",
                 "openid.connect.userInfo",
                 "users.setActive",
-                "admin.conversations.getCustomRetention",
-                "admin.conversations.removeCustomRetention",
-                "admin.conversations.setCustomRetention",
             ]:
                 continue
             self.api_methods_to_call.append(api_method)
@@ -1017,6 +1014,17 @@ async def run_method(self, method_name, method, async_method):
             ):
                 self.api_methods_to_call.remove(method()["method"])
                 await async_method()
+            elif method_name == "admin_conversations_getCustomRetention":
+                self.api_methods_to_call.remove(method(channel_id="C123")["method"])
+                await async_method(channel_id="C123")
+            elif method_name == "admin_conversations_removeCustomRetention":
+                self.api_methods_to_call.remove(method(channel_id="C123")["method"])
+                await async_method(channel_id="C123")
+            elif method_name == "admin_conversations_setCustomRetention":
+                self.api_methods_to_call.remove(
+                    method(channel_id="C123", duration_days=365)["method"]
+                )
+                await async_method(channel_id="C123", duration_days=365)
             else:
                 self.api_methods_to_call.remove(method(*{})["method"])
                 await async_method(*{})