From 0e8a686eff7e40810336d3ebce58cadf1ce2917b Mon Sep 17 00:00:00 2001 From: William Bergamin Date: Fri, 6 Sep 2024 15:35:05 +0000 Subject: [PATCH] feat: add support for `conversations.requestShared` `approve`, `deny` & `list` (#1530) * feat: add support for `conversations.requestShared` `approve` and `deny` APIs * Update the optional message type for approve * Add missing methods * Fix duplicate message field setting --- slack_sdk/web/async_client.py | 69 +++++++++++++++++++ slack_sdk/web/client.py | 69 +++++++++++++++++++ slack_sdk/web/legacy_client.py | 69 +++++++++++++++++++ .../web/test_web_client_coverage.py | 10 ++- 4 files changed, 215 insertions(+), 2 deletions(-) diff --git a/slack_sdk/web/async_client.py b/slack_sdk/web/async_client.py index 2bfc2cfc..7904d3c6 100644 --- a/slack_sdk/web/async_client.py +++ b/slack_sdk/web/async_client.py @@ -8,6 +8,7 @@ # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! """A Python module for interacting with Slack's Web API.""" + import json import os import warnings @@ -3191,6 +3192,74 @@ async def conversations_replies( ) return await self.api_call("conversations.replies", http_verb="GET", params=kwargs) + async def conversations_requestSharedInvite_approve( + self, + *, + invite_id: str, + channel_id: Optional[str] = None, + is_external_limited: Optional[str] = None, + message: Optional[Dict[str, Any]] = None, + **kwargs, + ) -> AsyncSlackResponse: + """Approve a request to add an external user to a channel. This also sends them a Slack Connect invite. + https://api.slack.com/methods/conversations.requestSharedInvite.approve + """ + kwargs.update( + { + "invite_id": invite_id, + "channel_id": channel_id, + "is_external_limited": is_external_limited, + } + ) + if message is not None: + kwargs.update({"message": json.dumps(message)}) + return await self.api_call("conversations.requestSharedInvite.approve", params=kwargs) + + async def conversations_requestSharedInvite_deny( + self, + *, + invite_id: str, + message: Optional[str] = None, + **kwargs, + ) -> AsyncSlackResponse: + """Deny a request to invite an external user to a channel. + https://api.slack.com/methods/conversations.requestSharedInvite.deny + """ + kwargs.update({"invite_id": invite_id, "message": message}) + return await self.api_call("conversations.requestSharedInvite.deny", params=kwargs) + + async def conversations_requestSharedInvite_list( + self, + *, + cursor: Optional[str] = None, + include_approved: Optional[bool] = None, + include_denied: Optional[bool] = None, + include_expired: Optional[bool] = None, + invite_ids: Optional[Union[str, Sequence[str]]] = None, + limit: Optional[int] = None, + user_id: Optional[str] = None, + **kwargs, + ) -> AsyncSlackResponse: + """Lists requests to add external users to channels with ability to filter. + https://api.slack.com/methods/conversations.requestSharedInvite.list + """ + kwargs.update( + { + "cursor": cursor, + "include_approved": include_approved, + "include_denied": include_denied, + "include_expired": include_expired, + "limit": limit, + "user_id": user_id, + } + ) + if invite_ids is not None: + if isinstance(invite_ids, (list, Tuple)): + kwargs.update({"invite_ids": ",".join(invite_ids)}) + else: + kwargs.update({"invite_ids": invite_ids}) + return await self.api_call("conversations.requestSharedInvite.list", params=kwargs) + async def conversations_setPurpose( self, *, diff --git a/slack_sdk/web/client.py b/slack_sdk/web/client.py index af727f6a..6113674e 100644 --- a/slack_sdk/web/client.py +++ b/slack_sdk/web/client.py @@ -1,4 +1,5 @@ """A Python module for interacting with Slack's Web API.""" + import json import os import warnings @@ -3182,6 +3183,74 @@ def conversations_replies( ) return self.api_call("conversations.replies", http_verb="GET", params=kwargs) + def conversations_requestSharedInvite_approve( + self, + *, + invite_id: str, + channel_id: Optional[str] = None, + is_external_limited: Optional[str] = None, + message: Optional[Dict[str, Any]] = None, + **kwargs, + ) -> SlackResponse: + """Approve a request to add an external user to a channel. This also sends them a Slack Connect invite. + https://api.slack.com/methods/conversations.requestSharedInvite.approve + """ + kwargs.update( + { + "invite_id": invite_id, + "channel_id": channel_id, + "is_external_limited": is_external_limited, + } + ) + if message is not None: + kwargs.update({"message": json.dumps(message)}) + return self.api_call("conversations.requestSharedInvite.approve", params=kwargs) + + def conversations_requestSharedInvite_deny( + self, + *, + invite_id: str, + message: Optional[str] = None, + **kwargs, + ) -> SlackResponse: + """Deny a request to invite an external user to a channel. + https://api.slack.com/methods/conversations.requestSharedInvite.deny + """ + kwargs.update({"invite_id": invite_id, "message": message}) + return self.api_call("conversations.requestSharedInvite.deny", params=kwargs) + + def conversations_requestSharedInvite_list( + self, + *, + cursor: Optional[str] = None, + include_approved: Optional[bool] = None, + include_denied: Optional[bool] = None, + include_expired: Optional[bool] = None, + invite_ids: Optional[Union[str, Sequence[str]]] = None, + limit: Optional[int] = None, + user_id: Optional[str] = None, + **kwargs, + ) -> SlackResponse: + """Lists requests to add external users to channels with ability to filter. + https://api.slack.com/methods/conversations.requestSharedInvite.list + """ + kwargs.update( + { + "cursor": cursor, + "include_approved": include_approved, + "include_denied": include_denied, + "include_expired": include_expired, + "limit": limit, + "user_id": user_id, + } + ) + if invite_ids is not None: + if isinstance(invite_ids, (list, Tuple)): + kwargs.update({"invite_ids": ",".join(invite_ids)}) + else: + kwargs.update({"invite_ids": invite_ids}) + return self.api_call("conversations.requestSharedInvite.list", params=kwargs) + def conversations_setPurpose( self, *, diff --git a/slack_sdk/web/legacy_client.py b/slack_sdk/web/legacy_client.py index 79acfc40..ccc7bba4 100644 --- a/slack_sdk/web/legacy_client.py +++ b/slack_sdk/web/legacy_client.py @@ -10,6 +10,7 @@ from asyncio import Future """A Python module for interacting with Slack's Web API.""" + import json import os import warnings @@ -3193,6 +3194,74 @@ def conversations_replies( ) return self.api_call("conversations.replies", http_verb="GET", params=kwargs) + def conversations_requestSharedInvite_approve( + self, + *, + invite_id: str, + channel_id: Optional[str] = None, + is_external_limited: Optional[str] = None, + message: Optional[Dict[str, Any]] = None, + **kwargs, + ) -> Union[Future, SlackResponse]: + """Approve a request to add an external user to a channel. This also sends them a Slack Connect invite. + https://api.slack.com/methods/conversations.requestSharedInvite.approve + """ + kwargs.update( + { + "invite_id": invite_id, + "channel_id": channel_id, + "is_external_limited": is_external_limited, + } + ) + if message is not None: + kwargs.update({"message": json.dumps(message)}) + return self.api_call("conversations.requestSharedInvite.approve", params=kwargs) + + def conversations_requestSharedInvite_deny( + self, + *, + invite_id: str, + message: Optional[str] = None, + **kwargs, + ) -> Union[Future, SlackResponse]: + """Deny a request to invite an external user to a channel. + https://api.slack.com/methods/conversations.requestSharedInvite.deny + """ + kwargs.update({"invite_id": invite_id, "message": message}) + return self.api_call("conversations.requestSharedInvite.deny", params=kwargs) + + def conversations_requestSharedInvite_list( + self, + *, + cursor: Optional[str] = None, + include_approved: Optional[bool] = None, + include_denied: Optional[bool] = None, + include_expired: Optional[bool] = None, + invite_ids: Optional[Union[str, Sequence[str]]] = None, + limit: Optional[int] = None, + user_id: Optional[str] = None, + **kwargs, + ) -> Union[Future, SlackResponse]: + """Lists requests to add external users to channels with ability to filter. + https://api.slack.com/methods/conversations.requestSharedInvite.list + """ + kwargs.update( + { + "cursor": cursor, + "include_approved": include_approved, + "include_denied": include_denied, + "include_expired": include_expired, + "limit": limit, + "user_id": user_id, + } + ) + if invite_ids is not None: + if isinstance(invite_ids, (list, Tuple)): + kwargs.update({"invite_ids": ",".join(invite_ids)}) + else: + kwargs.update({"invite_ids": invite_ids}) + return self.api_call("conversations.requestSharedInvite.list", params=kwargs) + def conversations_setPurpose( self, *, diff --git a/tests/slack_sdk_async/web/test_web_client_coverage.py b/tests/slack_sdk_async/web/test_web_client_coverage.py index d417f391..d56dbf7f 100644 --- a/tests/slack_sdk_async/web/test_web_client_coverage.py +++ b/tests/slack_sdk_async/web/test_web_client_coverage.py @@ -15,9 +15,9 @@ class TestWebClientCoverage(unittest.TestCase): - # 287 endpoints as of July 4, 2024 + # 289 endpoints as of Sept 4, 2024 # 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.activities.list,admin.apps.approve,admin.apps.clearResolution,admin.apps.restrict,admin.apps.uninstall,admin.apps.approved.list,admin.apps.config.lookup,admin.apps.config.set,admin.apps.requests.cancel,admin.apps.requests.list,admin.apps.restricted.list,admin.audit.anomaly.allow.getItem,admin.audit.anomaly.allow.updateItem,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.bulkArchive,admin.conversations.bulkDelete,admin.conversations.bulkMove,admin.conversations.convertToPrivate,admin.conversations.convertToPublic,admin.conversations.create,admin.conversations.delete,admin.conversations.disconnectShared,admin.conversations.getConversationPrefs,admin.conversations.getCustomRetention,admin.conversations.getTeams,admin.conversations.invite,admin.conversations.lookup,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.functions.list,admin.functions.permissions.lookup,admin.functions.permissions.set,admin.inviteRequests.approve,admin.inviteRequests.deny,admin.inviteRequests.list,admin.inviteRequests.approved.list,admin.inviteRequests.denied.list,admin.roles.addAssignments,admin.roles.listAssignments,admin.roles.removeAssignments,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.resetBulk,admin.users.session.setSettings,admin.users.unsupportedVersions.export,admin.workflows.collaborators.add,admin.workflows.collaborators.remove,admin.workflows.permissions.lookup,admin.workflows.search,admin.workflows.unpublish,admin.workflows.triggers.types.permissions.lookup,admin.workflows.triggers.types.permissions.set,api.test,apps.activities.list,apps.auth.external.delete,apps.auth.external.get,apps.connections.open,apps.datastore.bulkDelete,apps.datastore.bulkGet,apps.datastore.bulkPut,apps.datastore.count,apps.datastore.delete,apps.datastore.get,apps.datastore.put,apps.datastore.query,apps.datastore.update,apps.event.authorizations.list,apps.manifest.create,apps.manifest.delete,apps.manifest.export,apps.manifest.update,apps.manifest.validate,apps.uninstall,auth.revoke,auth.test,auth.teams.list,bookmarks.add,bookmarks.edit,bookmarks.list,bookmarks.remove,bots.info,calls.add,calls.end,calls.info,calls.update,calls.participants.add,calls.participants.remove,canvases.access.delete,canvases.access.set,canvases.create,canvases.delete,canvases.edit,canvases.sections.lookup,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,conversations.canvases.create,conversations.externalInvitePermissions.set,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,files.comments.delete,files.completeUploadExternal,files.delete,files.getUploadURLExternal,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,functions.completeError,functions.completeSuccess,functions.distributions.permissions.add,functions.distributions.permissions.list,functions.distributions.permissions.remove,functions.distributions.permissions.set,functions.workflows.steps.list,functions.workflows.steps.responses.export,migration.exchange,oauth.access,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.billing.info,team.externalTeams.disconnect,team.externalTeams.list,team.preferences.list,team.profile.get,tooling.tokens.rotate,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.discoverableContacts.lookup,users.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,workflows.stepCompleted,workflows.stepFailed,workflows.updateStep,workflows.triggers.permissions.add,workflows.triggers.permissions.list,workflows.triggers.permissions.remove,workflows.triggers.permissions.set,channels.create,channels.info,channels.invite,channels.mark,groups.create,groups.info,groups.invite,groups.mark,groups.open,im.list,im.mark,im.open,mpim.list,mpim.mark,mpim.open".split( + all_api_methods = "admin.analytics.getFile,admin.apps.activities.list,admin.apps.approve,admin.apps.clearResolution,admin.apps.restrict,admin.apps.uninstall,admin.apps.approved.list,admin.apps.config.lookup,admin.apps.config.set,admin.apps.requests.cancel,admin.apps.requests.list,admin.apps.restricted.list,admin.audit.anomaly.allow.getItem,admin.audit.anomaly.allow.updateItem,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.bulkArchive,admin.conversations.bulkDelete,admin.conversations.bulkMove,admin.conversations.convertToPrivate,admin.conversations.convertToPublic,admin.conversations.create,admin.conversations.delete,admin.conversations.disconnectShared,admin.conversations.getConversationPrefs,admin.conversations.getCustomRetention,admin.conversations.getTeams,admin.conversations.invite,admin.conversations.lookup,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.functions.list,admin.functions.permissions.lookup,admin.functions.permissions.set,admin.inviteRequests.approve,admin.inviteRequests.deny,admin.inviteRequests.list,admin.inviteRequests.approved.list,admin.inviteRequests.denied.list,admin.roles.addAssignments,admin.roles.listAssignments,admin.roles.removeAssignments,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.resetBulk,admin.users.session.setSettings,admin.users.unsupportedVersions.export,admin.workflows.collaborators.add,admin.workflows.collaborators.remove,admin.workflows.permissions.lookup,admin.workflows.search,admin.workflows.unpublish,admin.workflows.triggers.types.permissions.lookup,admin.workflows.triggers.types.permissions.set,api.test,apps.activities.list,apps.auth.external.delete,apps.auth.external.get,apps.connections.open,apps.uninstall,apps.datastore.bulkDelete,apps.datastore.bulkGet,apps.datastore.bulkPut,apps.datastore.count,apps.datastore.delete,apps.datastore.get,apps.datastore.put,apps.datastore.query,apps.datastore.update,apps.event.authorizations.list,apps.manifest.create,apps.manifest.delete,apps.manifest.export,apps.manifest.update,apps.manifest.validate,auth.revoke,auth.test,auth.teams.list,bookmarks.add,bookmarks.edit,bookmarks.list,bookmarks.remove,bots.info,calls.add,calls.end,calls.info,calls.update,calls.participants.add,calls.participants.remove,canvases.access.delete,canvases.access.set,canvases.create,canvases.delete,canvases.edit,canvases.sections.lookup,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,conversations.canvases.create,conversations.externalInvitePermissions.set,conversations.requestSharedInvite.approve,conversations.requestSharedInvite.deny,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,files.completeUploadExternal,files.delete,files.getUploadURLExternal,files.info,files.list,files.revokePublicURL,files.sharedPublicURL,files.upload,files.comments.delete,files.remote.add,files.remote.info,files.remote.list,files.remote.remove,files.remote.share,files.remote.update,functions.completeError,functions.completeSuccess,functions.distributions.permissions.add,functions.distributions.permissions.list,functions.distributions.permissions.remove,functions.distributions.permissions.set,functions.workflows.steps.list,functions.workflows.steps.responses.export,migration.exchange,oauth.access,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.billing.info,team.externalTeams.disconnect,team.externalTeams.list,team.preferences.list,team.profile.get,tooling.tokens.rotate,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.discoverableContacts.lookup,users.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,workflows.stepCompleted,workflows.stepFailed,workflows.updateStep,workflows.triggers.permissions.add,workflows.triggers.permissions.list,workflows.triggers.permissions.remove,workflows.triggers.permissions.set,channels.create,channels.info,channels.invite,channels.mark,groups.create,groups.info,groups.invite,groups.mark,groups.open,im.list,im.mark,im.open,mpim.list,mpim.mark,mpim.open".split( "," ) @@ -617,6 +617,12 @@ async def run_method(self, method_name, method, async_method): elif method_name == "conversations_replies": self.api_methods_to_call.remove(method(channel="C123", ts="123.123")["method"]) await async_method(channel="C123", ts="123.123") + elif method_name == "conversations_requestSharedInvite_approve": + self.api_methods_to_call.remove(method(invite_id="I123")["method"]) + await async_method(invite_id="I123") + elif method_name == "conversations_requestSharedInvite_deny": + self.api_methods_to_call.remove(method(invite_id="I123")["method"]) + await async_method(invite_id="I123") elif method_name == "conversations_setPurpose": self.api_methods_to_call.remove(method(channel="C123", purpose="The purpose")["method"]) await async_method(channel="C123", purpose="The purpose")