Add bookmarks.* API support

slack_sdk/web/async_client.py

@@ -1601,6 +1601,83 @@ async def auth_test(
         """
         return await self.api_call("auth.test", params=kwargs)
 
+    async def bookmarks_add(
+        self,
+        *,
+        channel_id: str,
+        title: str,
+        type: str,
+        emoji: Optional[str] = None,
+        entity_id: Optional[str] = None,
+        link: Optional[str] = None,  # include when type is 'link'
+        parent_id: Optional[str] = None,
+        **kwargs,
+    ) -> AsyncSlackResponse:
+        """Add bookmark to a channel.
+        https://api.slack.com/methods/bookmarks.add
+        """
+        kwargs.update(
+            {
+                "channel_id": channel_id,
+                "title": title,
+                "type": type,
+                "emoji": emoji,
+                "entity_id": entity_id,
+                "link": link,
+                "parent_id": parent_id,
+            }
+        )
+        return await self.api_call("bookmarks.add", http_verb="POST", params=kwargs)
+
+    async def bookmarks_edit(
+        self,
+        *,
+        bookmark_id: str,
+        channel_id: str,
+        emoji: Optional[str] = None,
+        link: Optional[str] = None,
+        title: Optional[str] = None,
+        **kwargs,
+    ) -> AsyncSlackResponse:
+        """Edit bookmark.
+        https://api.slack.com/methods/bookmarks.edit
+        """
+        kwargs.update(
+            {
+                "bookmark_id": bookmark_id,
+                "channel_id": channel_id,
+                "emoji": emoji,
+                "link": link,
+                "title": title,
+            }
+        )
+        return await self.api_call("bookmarks.edit", http_verb="POST", params=kwargs)
+
+    async def bookmarks_list(
+        self,
+        *,
+        channel_id: str,
+        **kwargs,
+    ) -> AsyncSlackResponse:
+        """List bookmark for the channel.
+        https://api.slack.com/methods/bookmarks.list
+        """
+        kwargs.update({"channel_id": channel_id})
+        return await self.api_call("bookmarks.list", http_verb="POST", params=kwargs)
+
+    async def bookmarks_remove(
+        self,
+        *,
+        bookmark_id: str,
+        channel_id: str,
+        **kwargs,
+    ) -> AsyncSlackResponse:
+        """Remove bookmark from the channel.
+        https://api.slack.com/methods/bookmarks.remove
+        """
+        kwargs.update({"bookmark_id": bookmark_id, "channel_id": channel_id})
+        return await self.api_call("bookmarks.remove", http_verb="POST", params=kwargs)
+
     async def bots_info(
         self,
         *,

slack_sdk/web/client.py

@@ -1552,6 +1552,83 @@ def auth_test(
         """
         return self.api_call("auth.test", params=kwargs)
 
+    def bookmarks_add(
+        self,
+        *,
+        channel_id: str,
+        title: str,
+        type: str,
+        emoji: Optional[str] = None,
+        entity_id: Optional[str] = None,
+        link: Optional[str] = None,
+        parent_id: Optional[str] = None,
+        **kwargs,
+    ) -> SlackResponse:
+        """Add bookmark to a channel.
+        https://api.slack.com/methods/bookmarks.add
+        """
+        kwargs.update(
+            {
+                "channel_id": channel_id,
+                "title": title,
+                "type": type,
+                "emoji": emoji,
+                "entity_id": entity_id,
+                "link": link,
+                "parent_id": parent_id,
+            }
+        )
+        return self.api_call("bookmarks.add", http_verb="POST", params=kwargs)
+
+    def bookmarks_edit(
+        self,
+        *,
+        bookmark_id: str,
+        channel_id: str,
+        emoji: Optional[str] = None,
+        link: Optional[str] = None,
+        title: Optional[str] = None,
+        **kwargs,
+    ) -> SlackResponse:
+        """Edit bookmark.
+        https://api.slack.com/methods/bookmarks.edit
+        """
+        kwargs.update(
+            {
+                "bookmark_id": bookmark_id,
+                "channel_id": channel_id,
+                "emoji": emoji,
+                "link": link,
+                "title": title,
+            }
+        )
+        return self.api_call("bookmarks.edit", http_verb="POST", params=kwargs)
+
+    def bookmarks_list(
+        self,
+        *,
+        channel_id: str,
+        **kwargs,
+    ) -> SlackResponse:
+        """List bookmark for the channel.
+        https://api.slack.com/methods/bookmarks.list
+        """
+        kwargs.update({"channel_id": channel_id})
+        return self.api_call("bookmarks.list", http_verb="POST", params=kwargs)
+
+    def bookmarks_remove(
+        self,
+        *,
+        bookmark_id: str,
+        channel_id: str,
+        **kwargs,
+    ) -> SlackResponse:
+        """Remove bookmark from the channel.
+        https://api.slack.com/methods/bookmarks.remove
+        """
+        kwargs.update({"bookmark_id": bookmark_id, "channel_id": channel_id})
+        return self.api_call("bookmarks.remove", http_verb="POST", params=kwargs)
+
     def bots_info(
         self,
         *,

slack_sdk/web/legacy_client.py

@@ -1563,6 +1563,83 @@ def auth_test(
         """
         return self.api_call("auth.test", params=kwargs)
 
+    def bookmarks_add(
+        self,
+        *,
+        channel_id: str,
+        title: str,
+        type: str,
+        emoji: Optional[str] = None,
+        entity_id: Optional[str] = None,
+        link: Optional[str] = None,
+        parent_id: Optional[str] = None,
+        **kwargs,
+    ) -> Union[Future, SlackResponse]:
+        """Add bookmark to a channel.
+        https://api.slack.com/methods/bookmarks.add
+        """
+        kwargs.update(
+            {
+                "channel_id": channel_id,
+                "title": title,
+                "type": type,
+                "emoji": emoji,
+                "entity_id": entity_id,
+                "link": link,
+                "parent_id": parent_id,
+            }
+        )
+        return self.api_call("bookmarks.add", http_verb="POST", params=kwargs)
+
+    def bookmarks_edit(
+        self,
+        *,
+        bookmark_id: str,
+        channel_id: str,
+        emoji: Optional[str] = None,
+        link: Optional[str] = None,
+        title: Optional[str] = None,
+        **kwargs,
+    ) -> Union[Future, SlackResponse]:
+        """Edit bookmark.
+        https://api.slack.com/methods/bookmarks.edit
+        """
+        kwargs.update(
+            {
+                "bookmark_id": bookmark_id,
+                "channel_id": channel_id,
+                "emoji": emoji,
+                "link": link,
+                "title": title,
+            }
+        )
+        return self.api_call("bookmarks.edit", http_verb="POST", params=kwargs)
+
+    def bookmarks_list(
+        self,
+        *,
+        channel_id: str,
+        **kwargs,
+    ) -> Union[Future, SlackResponse]:
+        """List bookmark for the channel.
+        https://api.slack.com/methods/bookmarks.list
+        """
+        kwargs.update({"channel_id": channel_id})
+        return self.api_call("bookmarks.list", http_verb="POST", params=kwargs)
+
+    def bookmarks_remove(
+        self,
+        *,
+        bookmark_id: str,
+        channel_id: str,
+        **kwargs,
+    ) -> Union[Future, SlackResponse]:
+        """Remove bookmark from the channel.
+        https://api.slack.com/methods/bookmarks.remove
+        """
+        kwargs.update({"bookmark_id": bookmark_id, "channel_id": channel_id})
+        return self.api_call("bookmarks.remove", http_verb="POST", params=kwargs)
+
     def bots_info(
         self,
         *,

tests/slack_sdk_async/web/test_web_client_coverage.py

@@ -15,7 +15,7 @@
 
 
 class TestWebClientCoverage(unittest.TestCase):
-    # 222 endpoints as of Jan 11, 2022
+    # 227 endpoints as of Feb 16, 2022
     # 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.cancel,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.resetBulk,admin.users.session.setSettings,admin.users.unsupportedVersions.export,api.test,apps.connections.open,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,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.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.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.profile.get,users.profile.set,views.open,views.publish,views.push,views.update,workflows.stepCompleted,workflows.stepFailed,workflows.updateStep,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(
         ","
@@ -55,11 +55,6 @@ def setUp(self):
                 "apps.manifest.update",
                 "apps.manifest.validate",
                 "tooling.tokens.rotate",
-                # TODO: bookmarks.*
-                "bookmarks.add",
-                "bookmarks.edit",
-                "bookmarks.list",
-                "bookmarks.remove",
             ]:
                 continue
             self.api_methods_to_call.append(api_method)
@@ -392,6 +387,28 @@ async def run_method(self, method_name, method, async_method):
                     method(client_id="111.222", client_secret="xxx")["method"]
                 )
                 await async_method(client_id="111.222", client_secret="xxx")
+            elif method_name == "bookmarks_add":
+                self.api_methods_to_call.remove(
+                    method(channel_id="C1234", title="bedtime story", type="article")[
+                        "method"
+                    ]
+                )
+                await async_method(
+                    channel_id="C1234", title="bedtime story", type="article"
+                )
+            elif method_name == "bookmarks_edit":
+                self.api_methods_to_call.remove(
+                    method(bookmark_id="B1234", channel_id="C1234")["method"]
+                )
+                await async_method(bookmark_id="B1234", channel_id="C1234")
+            elif method_name == "bookmarks_list":
+                self.api_methods_to_call.remove(method(channel_id="C1234")["method"])
+                await async_method(channel_id="C1234")
+            elif method_name == "bookmarks_remove":
+                self.api_methods_to_call.remove(
+                    method(bookmark_id="B1234", channel_id="C1234")["method"]
+                )
+                await async_method(bookmark_id="B1234", channel_id="C1234")
             elif method_name == "calls_add":
                 self.api_methods_to_call.remove(
                     method(