diff --git a/json-logs/samples/api/entity.presentComments.json b/json-logs/samples/api/entity.presentComments.json new file mode 100644 index 000000000..c5e53b5a3 --- /dev/null +++ b/json-logs/samples/api/entity.presentComments.json @@ -0,0 +1,12 @@ +{ + "ok": false, + "error": "", + "needed": "", + "provided": "", + "response_metadata": { + "messages": [ + "" + ] + }, + "warning": "" +} \ No newline at end of file diff --git a/metadata/web-api/rate_limit_tiers.json b/metadata/web-api/rate_limit_tiers.json index 20c67b75e..1914b04a1 100644 --- a/metadata/web-api/rate_limit_tiers.json +++ b/metadata/web-api/rate_limit_tiers.json @@ -222,6 +222,7 @@ "dnd.setSnooze": "Tier2", "dnd.teamInfo": "Tier2", "emoji.list": "Tier2", + "entity.presentComments": "Tier3", "files.comments.delete": "Tier2", "files.completeUploadExternal": "Tier4", "files.delete": "Tier3", diff --git a/slack-api-client/src/main/java/com/slack/api/methods/AsyncMethodsClient.java b/slack-api-client/src/main/java/com/slack/api/methods/AsyncMethodsClient.java index 2d8d708f2..a77d20405 100644 --- a/slack-api-client/src/main/java/com/slack/api/methods/AsyncMethodsClient.java +++ b/slack-api-client/src/main/java/com/slack/api/methods/AsyncMethodsClient.java @@ -99,6 +99,7 @@ import com.slack.api.methods.request.dialog.DialogOpenRequest; import com.slack.api.methods.request.dnd.*; import com.slack.api.methods.request.emoji.EmojiListRequest; +import com.slack.api.methods.request.entity.EntityPresentCommentsRequest; import com.slack.api.methods.request.entity.EntityPresentDetailsRequest; import com.slack.api.methods.request.files.*; import com.slack.api.methods.request.files.remote.*; @@ -267,6 +268,7 @@ import com.slack.api.methods.response.dialog.DialogOpenResponse; import com.slack.api.methods.response.dnd.*; import com.slack.api.methods.response.emoji.EmojiListResponse; +import com.slack.api.methods.response.entity.EntityPresentCommentsResponse; import com.slack.api.methods.response.entity.EntityPresentDetailsResponse; import com.slack.api.methods.response.files.*; import com.slack.api.methods.response.files.remote.*; @@ -1373,6 +1375,10 @@ CompletableFuture // entity // ------------------------------ + CompletableFuture entityPresentComments(EntityPresentCommentsRequest req); + + CompletableFuture entityPresentComments(RequestConfigurator req); + CompletableFuture entityPresentDetails(EntityPresentDetailsRequest req); CompletableFuture entityPresentDetails(RequestConfigurator req); diff --git a/slack-api-client/src/main/java/com/slack/api/methods/Methods.java b/slack-api-client/src/main/java/com/slack/api/methods/Methods.java index fad62c6c4..fb0edb555 100644 --- a/slack-api-client/src/main/java/com/slack/api/methods/Methods.java +++ b/slack-api-client/src/main/java/com/slack/api/methods/Methods.java @@ -514,6 +514,7 @@ private Methods() { // entity // ------------------------------ + public static final String ENTITY_PRESENT_COMMENTS = "entity.presentComments"; public static final String ENTITY_PRESENT_DETAILS = "entity.presentDetails"; // ------------------------------ diff --git a/slack-api-client/src/main/java/com/slack/api/methods/MethodsClient.java b/slack-api-client/src/main/java/com/slack/api/methods/MethodsClient.java index 5b161bfd9..ccdb03bef 100644 --- a/slack-api-client/src/main/java/com/slack/api/methods/MethodsClient.java +++ b/slack-api-client/src/main/java/com/slack/api/methods/MethodsClient.java @@ -106,6 +106,7 @@ import com.slack.api.methods.request.dialog.DialogOpenRequest; import com.slack.api.methods.request.dnd.*; import com.slack.api.methods.request.emoji.EmojiListRequest; +import com.slack.api.methods.request.entity.EntityPresentCommentsRequest; import com.slack.api.methods.request.entity.EntityPresentDetailsRequest; import com.slack.api.methods.request.files.*; import com.slack.api.methods.request.files.comments.FilesCommentsAddRequest; @@ -363,6 +364,7 @@ import com.slack.api.methods.response.workflows.WorkflowsStepCompletedResponse; import com.slack.api.methods.response.workflows.WorkflowsStepFailedResponse; import com.slack.api.methods.response.workflows.WorkflowsUpdateStepResponse; +import com.slack.api.methods.response.entity.EntityPresentCommentsResponse; import com.slack.api.methods.response.entity.EntityPresentDetailsResponse; import com.slack.api.util.http.SlackHttpClient; import okhttp3.FormBody; @@ -2155,6 +2157,13 @@ EmojiListResponse emojiList(RequestConfigurator req) + throws IOException, SlackApiException; + EntityPresentDetailsResponse entityPresentDetails(EntityPresentDetailsRequest req) throws IOException, SlackApiException; diff --git a/slack-api-client/src/main/java/com/slack/api/methods/MethodsRateLimits.java b/slack-api-client/src/main/java/com/slack/api/methods/MethodsRateLimits.java index 7f3e74e63..2031b58b4 100644 --- a/slack-api-client/src/main/java/com/slack/api/methods/MethodsRateLimits.java +++ b/slack-api-client/src/main/java/com/slack/api/methods/MethodsRateLimits.java @@ -400,6 +400,8 @@ public static void setRateLimitTier(String methodName, MethodsRateLimitTier tier setRateLimitTier(EMOJI_LIST, Tier2); + setRateLimitTier(ENTITY_PRESENT_COMMENTS, Tier3); + setRateLimitTier(FILES_COMMENTS_DELETE, Tier2); setRateLimitTier(FILES_DELETE, Tier3); diff --git a/slack-api-client/src/main/java/com/slack/api/methods/RequestFormBuilder.java b/slack-api-client/src/main/java/com/slack/api/methods/RequestFormBuilder.java index efb9d5494..1de749dea 100644 --- a/slack-api-client/src/main/java/com/slack/api/methods/RequestFormBuilder.java +++ b/slack-api-client/src/main/java/com/slack/api/methods/RequestFormBuilder.java @@ -108,6 +108,7 @@ import com.slack.api.methods.request.dialog.DialogOpenRequest; import com.slack.api.methods.request.dnd.*; import com.slack.api.methods.request.emoji.EmojiListRequest; +import com.slack.api.methods.request.entity.EntityPresentCommentsRequest; import com.slack.api.methods.request.entity.EntityPresentDetailsRequest; import com.slack.api.methods.request.files.*; import com.slack.api.methods.request.files.comments.FilesCommentsAddRequest; @@ -2413,6 +2414,23 @@ public static FormBody.Builder toForm(EmojiListRequest req) { return form; } + public static FormBody.Builder toForm(EntityPresentCommentsRequest req) { + FormBody.Builder form = new FormBody.Builder(); + if (req.getComments() != null) { + setIfNotNull("comments", GSON.toJson(req.getComments()), form); + } + setIfNotNull("trigger_id", req.getTriggerId(), form); + setIfNotNull("cursor", req.getCursor(), form); + setIfNotNull("can_post_comment", req.getCanPostComment(), form); + setIfNotNull("delete_action_id", req.getDeleteActionId(), form); + setIfNotNull("user_auth_required", req.getUserAuthRequired(), form); + setIfNotNull("user_auth_url", req.getUserAuthUrl(), form); + if (req.getError() != null) { + setIfNotNull("error", GSON.toJson(req.getError()), form); + } + return form; + } + public static FormBody.Builder toForm(EntityPresentDetailsRequest req) { FormBody.Builder form = new FormBody.Builder(); diff --git a/slack-api-client/src/main/java/com/slack/api/methods/impl/AsyncMethodsClientImpl.java b/slack-api-client/src/main/java/com/slack/api/methods/impl/AsyncMethodsClientImpl.java index 1963837d1..6a051e3cd 100644 --- a/slack-api-client/src/main/java/com/slack/api/methods/impl/AsyncMethodsClientImpl.java +++ b/slack-api-client/src/main/java/com/slack/api/methods/impl/AsyncMethodsClientImpl.java @@ -26,6 +26,7 @@ import com.slack.api.methods.request.admin.conversations.whitelist.AdminConversationsWhitelistListGroupsLinkedToChannelRequest; import com.slack.api.methods.request.admin.conversations.whitelist.AdminConversationsWhitelistRemoveRequest; import com.slack.api.methods.request.admin.emoji.*; +import com.slack.api.methods.request.entity.EntityPresentCommentsRequest; import com.slack.api.methods.request.entity.EntityPresentDetailsRequest; import com.slack.api.methods.request.admin.functions.AdminFunctionsListRequest; import com.slack.api.methods.request.admin.functions.AdminFunctionsPermissionsLookupRequest; @@ -194,6 +195,7 @@ import com.slack.api.methods.response.admin.conversations.whitelist.AdminConversationsWhitelistListGroupsLinkedToChannelResponse; import com.slack.api.methods.response.admin.conversations.whitelist.AdminConversationsWhitelistRemoveResponse; import com.slack.api.methods.response.admin.emoji.*; +import com.slack.api.methods.response.entity.EntityPresentCommentsResponse; import com.slack.api.methods.response.entity.EntityPresentDetailsResponse; import com.slack.api.methods.response.admin.functions.AdminFunctionsListResponse; import com.slack.api.methods.response.admin.functions.AdminFunctionsPermissionsLookupResponse; @@ -2411,6 +2413,16 @@ public CompletableFuture emojiList(RequestConfigurator entityPresentComments(EntityPresentCommentsRequest req) { + return executor.execute(ENTITY_PRESENT_COMMENTS, toMap(req), () -> methods.entityPresentComments(req)); + } + + @Override + public CompletableFuture entityPresentComments(RequestConfigurator req) { + return entityPresentComments(req.configure(EntityPresentCommentsRequest.builder()).build()); + } + @Override public CompletableFuture entityPresentDetails(EntityPresentDetailsRequest req) { return executor.execute(ENTITY_PRESENT_DETAILS, toMap(req), () -> methods.entityPresentDetails(req)); diff --git a/slack-api-client/src/main/java/com/slack/api/methods/impl/MethodsClientImpl.java b/slack-api-client/src/main/java/com/slack/api/methods/impl/MethodsClientImpl.java index 33d598b7b..967a00eb1 100644 --- a/slack-api-client/src/main/java/com/slack/api/methods/impl/MethodsClientImpl.java +++ b/slack-api-client/src/main/java/com/slack/api/methods/impl/MethodsClientImpl.java @@ -107,6 +107,7 @@ import com.slack.api.methods.request.dialog.DialogOpenRequest; import com.slack.api.methods.request.dnd.*; import com.slack.api.methods.request.emoji.EmojiListRequest; +import com.slack.api.methods.request.entity.EntityPresentCommentsRequest; import com.slack.api.methods.request.entity.EntityPresentDetailsRequest; import com.slack.api.methods.request.files.*; import com.slack.api.methods.request.files.comments.FilesCommentsAddRequest; @@ -288,6 +289,7 @@ import com.slack.api.methods.response.dialog.DialogOpenResponse; import com.slack.api.methods.response.dnd.*; import com.slack.api.methods.response.emoji.EmojiListResponse; +import com.slack.api.methods.response.entity.EntityPresentCommentsResponse; import com.slack.api.methods.response.entity.EntityPresentDetailsResponse; import com.slack.api.methods.response.files.*; import com.slack.api.methods.response.files.comments.FilesCommentsAddResponse; @@ -2673,6 +2675,16 @@ public EmojiListResponse emojiList(RequestConfigurator req) throws IOException, SlackApiException { + return entityPresentComments(req.configure(EntityPresentCommentsRequest.builder()).build()); + } + @Override public EntityPresentDetailsResponse entityPresentDetails(EntityPresentDetailsRequest req) throws IOException, SlackApiException { return postFormWithTokenAndParseResponse(toForm(req), Methods.ENTITY_PRESENT_DETAILS, getToken(req), EntityPresentDetailsResponse.class); diff --git a/slack-api-client/src/main/java/com/slack/api/methods/request/entity/EntityPresentCommentsRequest.java b/slack-api-client/src/main/java/com/slack/api/methods/request/entity/EntityPresentCommentsRequest.java new file mode 100644 index 000000000..c593c2941 --- /dev/null +++ b/slack-api-client/src/main/java/com/slack/api/methods/request/entity/EntityPresentCommentsRequest.java @@ -0,0 +1,62 @@ +package com.slack.api.methods.request.entity; + +import com.slack.api.methods.SlackApiRequest; +import com.slack.api.model.EntityComment; +import lombok.Builder; +import lombok.Data; + +import java.util.List; + +/** + * https://docs.slack.dev/reference/methods/entity.presentComments + */ +@Data +@Builder +public class EntityPresentCommentsRequest implements SlackApiRequest { + + /** + * Authentication token. + */ + private String token; + + /** + * Array of comments to present to the user. See the [comment schema](https://docs.slack.dev/messaging/work-objects-comments#entity-present-comments-method) for the full list of properties. + */ + private List comments; + + /** + * A reference to the original user action that initiated the request + */ + private String triggerId; + + /** + * App supplied cursor used for pagination, will be sent in the next request for comments + */ + private String cursor; + + /** + * Indicates whether the user has permissions to post comments + */ + private Boolean canPostComment; + + /** + * The block action id that will be sent when a delete request is initiated for a comment. + */ + private String deleteActionId; + + /** + * Set to true (or 1) to indicate that the user must authenticate to see the comments data. + */ + private Boolean userAuthRequired; + + /** + * A custom URL to which users are directed for authentication if required. + */ + private String userAuthUrl; + + /** + * Error indicating why the comments cannot be provided. It takes the same object as `entity.presentDetails`. + */ + private EntityPresentDetailsRequest.Error error; + +} diff --git a/slack-api-client/src/main/java/com/slack/api/methods/response/entity/EntityPresentCommentsResponse.java b/slack-api-client/src/main/java/com/slack/api/methods/response/entity/EntityPresentCommentsResponse.java new file mode 100644 index 000000000..77e087131 --- /dev/null +++ b/slack-api-client/src/main/java/com/slack/api/methods/response/entity/EntityPresentCommentsResponse.java @@ -0,0 +1,21 @@ +package com.slack.api.methods.response.entity; + +import com.slack.api.methods.SlackApiTextResponse; +import com.slack.api.model.ErrorResponseMetadata; +import lombok.Data; + +import java.util.List; +import java.util.Map; + +@Data +public class EntityPresentCommentsResponse implements SlackApiTextResponse { + + private boolean ok; + private String warning; + private String error; + private String needed; + private String provided; + private transient Map> httpResponseHeaders; + + private ErrorResponseMetadata responseMetadata; +} diff --git a/slack-api-client/src/test/java/test_locally/api/MethodsTest.java b/slack-api-client/src/test/java/test_locally/api/MethodsTest.java index ce0d15d0b..7cb89334d 100644 --- a/slack-api-client/src/test/java/test_locally/api/MethodsTest.java +++ b/slack-api-client/src/test/java/test_locally/api/MethodsTest.java @@ -19,8 +19,8 @@ public class MethodsTest { public void verifyTheCoverage() { // https://docs.slack.dev/reference/methods // var methodNames = [].slice.call(document.getElementsByClassName('apiReferenceFilterableList__listItemLink')).map(e => e.href.replace("https://docs.slack.dev/reference/methods/", ""));console.log(methodNames.toString());console.log(methodNames.length); - // 327 endpoints as of November 12, 2026 (apps.user.connection.bulkUpdate and requestAuth added ahead of their docs.slack.dev pages) - String 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.mcp.servers.list,admin.apps.mcp.servers.permissions.list,admin.apps.mcp.servers.permissions.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.createForObjects,admin.conversations.delete,admin.conversations.disconnectShared,admin.conversations.getConversationPrefs,admin.conversations.getCustomRetention,admin.conversations.getTeams,admin.conversations.invite,admin.conversations.linkObjects,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.unlinkObjects,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.slackbot.skills.list,admin.slackbot.skills.publish,admin.slackbot.skills.setAutoEnabled,admin.slackbot.skills.unpublish,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.getExpiration,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,apps.user.connection.bulkUpdate,apps.user.connection.requestAuth,apps.user.connection.update,assistant.search.context,assistant.threads.setStatus,assistant.threads.setSuggestedPrompts,assistant.threads.setTitle,auth.revoke,auth.test,auth.teams.list,blocks.validate,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.getContent,canvases.sections.lookup,channels.mark,chat.appendStream,chat.delete,chat.deleteScheduledMessage,chat.getPermalink,chat.meMessage,chat.postEphemeral,chat.postMessage,chat.scheduleMessage,chat.startStream,chat.stopStream,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,conversations.requestSharedInvite.list,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,groups.mark,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,slackLists.access.delete,slackLists.access.set,slackLists.create,slackLists.download.get,slackLists.download.start,slackLists.items.create,slackLists.items.delete,slackLists.items.deleteMultiple,slackLists.items.info,slackLists.items.list,slackLists.items.update,slackLists.update,slackbot.skills.create,slackbot.skills.delete,slackbot.skills.info,slackbot.skills.library.add,slackbot.skills.library.remove,slackbot.skills.list,slackbot.skills.update,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.featured.add,workflows.featured.list,workflows.featured.remove,workflows.featured.set,workflows.stepCompleted,workflows.stepFailed,workflows.updateStep,workflows.triggers.permissions.add,workflows.triggers.permissions.list,workflows.triggers.permissions.remove,workflows.triggers.permissions.set,im.list,im.mark,mpim.list,mpim.mark"; + // 328 endpoints as of November 12, 2026 (apps.user.connection.bulkUpdate and requestAuth added ahead of their docs.slack.dev pages) + String 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.mcp.servers.list,admin.apps.mcp.servers.permissions.list,admin.apps.mcp.servers.permissions.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.createForObjects,admin.conversations.delete,admin.conversations.disconnectShared,admin.conversations.getConversationPrefs,admin.conversations.getCustomRetention,admin.conversations.getTeams,admin.conversations.invite,admin.conversations.linkObjects,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.unlinkObjects,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.slackbot.skills.list,admin.slackbot.skills.publish,admin.slackbot.skills.setAutoEnabled,admin.slackbot.skills.unpublish,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.getExpiration,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,apps.user.connection.bulkUpdate,apps.user.connection.requestAuth,apps.user.connection.update,assistant.search.context,assistant.threads.setStatus,assistant.threads.setSuggestedPrompts,assistant.threads.setTitle,auth.revoke,auth.test,auth.teams.list,blocks.validate,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.getContent,canvases.sections.lookup,channels.mark,chat.appendStream,chat.delete,chat.deleteScheduledMessage,chat.getPermalink,chat.meMessage,chat.postEphemeral,chat.postMessage,chat.scheduleMessage,chat.startStream,chat.stopStream,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,conversations.requestSharedInvite.list,dialog.open,dnd.endDnd,dnd.endSnooze,dnd.info,dnd.setSnooze,dnd.teamInfo,emoji.list,entity.presentComments,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,groups.mark,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,slackLists.access.delete,slackLists.access.set,slackLists.create,slackLists.download.get,slackLists.download.start,slackLists.items.create,slackLists.items.delete,slackLists.items.deleteMultiple,slackLists.items.info,slackLists.items.list,slackLists.items.update,slackLists.update,slackbot.skills.create,slackbot.skills.delete,slackbot.skills.info,slackbot.skills.library.add,slackbot.skills.library.remove,slackbot.skills.list,slackbot.skills.update,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.featured.add,workflows.featured.list,workflows.featured.remove,workflows.featured.set,workflows.stepCompleted,workflows.stepFailed,workflows.updateStep,workflows.triggers.permissions.add,workflows.triggers.permissions.list,workflows.triggers.permissions.remove,workflows.triggers.permissions.set,im.list,im.mark,mpim.list,mpim.mark"; final List existingMethods = new ArrayList<>(); for (Field f : Methods.class.getDeclaredFields()) { int modifiers = f.getModifiers(); diff --git a/slack-api-client/src/test/java/test_locally/api/methods/EntityTest.java b/slack-api-client/src/test/java/test_locally/api/methods/EntityTest.java new file mode 100644 index 000000000..289da8f72 --- /dev/null +++ b/slack-api-client/src/test/java/test_locally/api/methods/EntityTest.java @@ -0,0 +1,58 @@ +package test_locally.api.methods; + +import com.slack.api.Slack; +import com.slack.api.SlackConfig; +import com.slack.api.model.EntityComment; +import com.slack.api.model.EntityMetadata; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import util.MockSlackApiServer; + +import java.util.Arrays; +import java.util.Collections; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static util.MockSlackApi.ValidToken; + +public class EntityTest { + + MockSlackApiServer server = new MockSlackApiServer(); + SlackConfig config = new SlackConfig(); + Slack slack = Slack.getInstance(config); + + @Before + public void setup() throws Exception { + server.start(); + config.setMethodsEndpointUrlPrefix(server.getMethodsEndpointPrefix()); + } + + @After + public void tearDown() throws Exception { + server.stop(); + } + + @Test + public void entityPresentComments() throws Exception { + assertThat(slack.methods(ValidToken).entityPresentComments(r -> r + .comments(Arrays.asList(EntityComment.builder() + .id("comment-identifier-002") + .sender(EntityMetadata.EntityPayload.User.builder().userId("U123456789").build()) + .timestamp(1741164358) + .comment(EntityComment.Content.builder().value("Plain text comment").format("markdown").build()) + .build())) + .triggerId("1234567890123.1234567890123.abcdef01234567890abcdef012345689") + .canPostComment(true) + .deleteActionId("your-delete-action-id")).isOk(), is(true)); + } + + @Test + public void entityPresentComments_async() throws Exception { + assertThat(slack.methodsAsync(ValidToken).entityPresentComments(r -> r + .comments(Collections.emptyList()) + .triggerId("1234567890123.1234567890123.abcdef01234567890abcdef012345689") + .userAuthRequired(true) + .userAuthUrl("https://example.com/onboarding?user_id=xxx")).get().isOk(), is(true)); + } +} diff --git a/slack-api-client/src/test/java/test_locally/api/methods/RequestFormBuilderTest.java b/slack-api-client/src/test/java/test_locally/api/methods/RequestFormBuilderTest.java index 8fdb64ac6..5d8e5cc86 100644 --- a/slack-api-client/src/test/java/test_locally/api/methods/RequestFormBuilderTest.java +++ b/slack-api-client/src/test/java/test_locally/api/methods/RequestFormBuilderTest.java @@ -7,14 +7,20 @@ import com.slack.api.methods.request.calls.CallsAddRequest; import com.slack.api.methods.request.chat.ChatPostMessageRequest; import com.slack.api.methods.request.chat.ChatUnfurlRequest; +import com.slack.api.methods.request.entity.EntityPresentCommentsRequest; +import com.slack.api.methods.request.entity.EntityPresentDetailsRequest; import com.slack.api.methods.request.slackbot.skills.SlackbotSkillsUpdateRequest; import com.slack.api.methods.request.team.TeamInfoRequest; import com.slack.api.model.Attachment; import com.slack.api.model.CallParticipant; +import com.slack.api.model.EntityComment; +import com.slack.api.model.EntityMetadata; import com.slack.api.model.block.LayoutBlock; +import com.slack.api.model.block.RichTextBlock; import com.slack.api.model.block.composition.OptionObject; import com.slack.api.model.block.composition.PlainTextObject; import com.slack.api.model.block.element.OverflowMenuElement; +import com.slack.api.model.block.element.RichTextSectionElement; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; @@ -82,6 +88,55 @@ public void slackbotSkillsUpdateMcpServers() { assertThat(declared.value(1), is("[{\"service_type\":\"app\",\"app_id\":\"A0123ABCD\",\"server_id\":\"Amcp0456EFGH\"}]")); } + @Test + public void entityPresentCommentsComments() { + FormBody form = RequestFormBuilder.toForm(EntityPresentCommentsRequest.builder() + .comments(Arrays.asList(EntityComment.builder() + .comment(EntityComment.Content.builder() + .blocks(RichTextBlock.builder() + .elements(Arrays.asList(RichTextSectionElement.builder() + .elements(Arrays.asList(RichTextSectionElement.Text.builder() + .text("Check out these different block types with paragraph breaks between them:\n\n") + .build())) + .build())) + .build()) + .build()) + .id("comment-identifier-001") + .sender(EntityMetadata.EntityPayload.User.builder().userId("U123456789").build()) + .timestamp(1741164235) + .replyUsers(Arrays.asList(EntityMetadata.EntityPayload.User.builder().userId("U234567890").build())) + .build())) + .triggerId("1234567890123.1234567890123.abcdef01234567890abcdef012345689") + .canPostComment(true) + .build()).build(); + assertThat(form.size(), is(3)); + assertThat(form.name(0), is("comments")); + assertThat(form.value(0), is("[{\"comment\":{\"blocks\":{\"type\":\"rich_text\",\"elements\":[{\"type\":\"rich_text_section\",\"elements\":[" + + "{\"type\":\"text\",\"text\":\"Check out these different block types with paragraph breaks between them:\\n\\n\"}]}]}}," + + "\"id\":\"comment-identifier-001\"," + + "\"sender\":{\"user_id\":\"U123456789\"}," + + "\"timestamp\":1741164235," + + "\"reply_users\":[{\"user_id\":\"U234567890\"}]}]")); + assertThat(form.name(1), is("trigger_id")); + assertThat(form.name(2), is("can_post_comment")); + assertThat(form.value(2), is("1")); + } + + @Test + public void entityPresentCommentsError() { + FormBody form = RequestFormBuilder.toForm(EntityPresentCommentsRequest.builder() + .comments(Collections.emptyList()) + .triggerId("1234567890123.1234567890123.abcdef01234567890abcdef012345689") + .error(EntityPresentDetailsRequest.Error.builder() + .status("custom") + .customMessage("The comments could not be loaded") + .build()) + .build()).build(); + assertThat(form.size(), is(3)); + assertThat(form.name(2), is("error")); + assertThat(form.value(2), is("{\"status\":\"custom\",\"custom_message\":\"The comments could not be loaded\"}")); + } + @Test public void testBlocksJsonSerialization() { // GIVEN diff --git a/slack-api-client/src/test/java/test_with_remote_apis/methods/entity_Test.java b/slack-api-client/src/test/java/test_with_remote_apis/methods/entity_Test.java new file mode 100644 index 000000000..5fdf1e751 --- /dev/null +++ b/slack-api-client/src/test/java/test_with_remote_apis/methods/entity_Test.java @@ -0,0 +1,101 @@ +package test_with_remote_apis.methods; + +import com.slack.api.Slack; +import com.slack.api.methods.request.entity.EntityPresentDetailsRequest; +import com.slack.api.methods.response.entity.EntityPresentCommentsResponse; +import com.slack.api.model.EntityComment; +import com.slack.api.model.EntityMetadata; +import com.slack.api.model.block.RichTextBlock; +import com.slack.api.model.block.element.RichTextSectionElement; +import config.Constants; +import config.SlackTestConfig; +import lombok.extern.slf4j.Slf4j; +import org.junit.AfterClass; +import org.junit.BeforeClass; +import org.junit.Test; + +import java.util.Arrays; +import java.util.Collections; + +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +@Slf4j +public class entity_Test { + + static SlackTestConfig testConfig = SlackTestConfig.getInstance(); + static Slack slack = Slack.getInstance(testConfig.getConfig()); + + String botToken = System.getenv(Constants.SLACK_SDK_TEST_BOT_TOKEN); + + @BeforeClass + public static void setUp() throws Exception { + SlackTestConfig.initializeRawJSONDataFiles("entity.*"); + } + + @AfterClass + public static void tearDown() throws InterruptedException { + SlackTestConfig.awaitCompletion(testConfig); + } + + // A trigger_id comes from a comment action in a work object flexpane, so the example from the docs is not found + static String triggerId = "1234567890123.1234567890123.abcdef01234567890abcdef012345689"; + + @Test + public void presentComments() throws Exception { + EntityPresentCommentsResponse response = slack.methods(botToken).entityPresentComments(r -> r + .comments(Arrays.asList( + EntityComment.builder() + .sender(EntityMetadata.EntityPayload.User.builder().userId("U123456789").build()) + .timestamp(1741164235) + .id("comment-identifier-001") + .url("your.app/item/1/comment/1") + .canEdit(true) + .canDelete(true) + .canReply(true) + .replyCount(2) + .replyUsers(Arrays.asList(EntityMetadata.EntityPayload.User.builder().userId("U234567890").build())) + .latestReplyTs(1741165000) + .lastEditTs(1741164300) + .comment(EntityComment.Content.builder() + .blocks(RichTextBlock.builder() + .elements(Arrays.asList(RichTextSectionElement.builder() + .elements(Arrays.asList(RichTextSectionElement.Text.builder() + .text("Check out these different block types with paragraph breaks between them:\n\n") + .build())) + .build())) + .build()) + .build()) + .build(), + EntityComment.builder() + .sender(EntityMetadata.EntityPayload.User.builder() + .text("UserFirstName UserLastName") + .url("your.app/user/userId") + .email("firstname.lastname@domain.com") + .build()) + .timestamp(1741164358) + .id("comment-identifier-002") + .url("your.app/item/1/comment/2") + .threadRootId("comment-identifier-001") + .comment(EntityComment.Content.builder().value("Plain text comment").format("markdown").build()) + .build())) + .canPostComment(true) + .deleteActionId("your-delete-action-id") + .triggerId(triggerId)); + assertThat(response.getError(), is("invalid_trigger_id")); + } + + @Test + public void presentCommentsError() throws Exception { + // The error is the same object entity.presentDetails takes, and a string returns invalid_arguments + EntityPresentCommentsResponse response = slack.methods(botToken).entityPresentComments(r -> r + .comments(Collections.emptyList()) + .triggerId(triggerId) + .error(EntityPresentDetailsRequest.Error.builder() + .status("custom") + .customTitle("Comments unavailable") + .customMessage("The comments could not be loaded") + .build())); + assertThat(response.getError(), is("invalid_trigger_id")); + } +} diff --git a/slack-api-model/src/main/java/com/slack/api/model/EntityComment.java b/slack-api-model/src/main/java/com/slack/api/model/EntityComment.java new file mode 100644 index 000000000..8cbbce12f --- /dev/null +++ b/slack-api-model/src/main/java/com/slack/api/model/EntityComment.java @@ -0,0 +1,112 @@ +package com.slack.api.model; + +import com.slack.api.model.block.RichTextBlock; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Data; +import lombok.NoArgsConstructor; + +import java.util.List; + +/** + * A comment on a work object, shown in the comments tab of its flexpane. + * https://docs.slack.dev/reference/methods/entity.presentComments#comment-schema + */ +@Data +@Builder +@NoArgsConstructor +@AllArgsConstructor +public class EntityComment { + + /** + * The comment content. Provide one of `comment.blocks` or `comment.value`. + */ + private Content comment; + + /** + * A unique ID sourced from your app and associated with the comment. It will be used if editing a comment. + */ + private String id; + + /** + * Same User type used in a Work Object's fields. + */ + private EntityMetadata.EntityPayload.User sender; + + /** + * Epoch timestamp in seconds. + */ + private Integer timestamp; + + /** + * If present and `true`, renders the delete button on that comment. When `true`, `delete_action_id` should also be present, otherwise the delete button will render but do nothing when clicked. Empty strings are not supported. + */ + private Boolean canDelete; + + /** + * If present and `true`, indicates that the comment is editable in the user's flexpane. + */ + private Boolean canEdit; + + /** + * If present and `true`, allows users to reply to this comment in a thread. + */ + private Boolean canReply; + + /** + * Pagination cursor associated with this comment's position in the list. + */ + private String cursor; + + /** + * Epoch timestamp in seconds of the last edit to this comment. + */ + private Integer lastEditTs; + + /** + * Epoch timestamp in seconds of the most recent reply in the thread. + */ + private Integer latestReplyTs; + + /** + * Number of replies in the thread under this comment. + */ + private Integer replyCount; + + /** + * Up to two users who have replied to this comment thread. Same User type as `sender`. + */ + private List replyUsers; + + /** + * The `id` of the parent comment. If present, this comment is a threaded reply. + */ + private String threadRootId; + + /** + * URL which directs to the comment. + */ + private String url; + + @Data + @Builder + @NoArgsConstructor + @AllArgsConstructor + public static class Content { + + /** + * A rich text block containing the comment content. + */ + private RichTextBlock blocks; + + /** + * If set to `"markdown"`, the `comment.value` will be formatted as markdown. + */ + private String format; + + /** + * Plain or markdown string containing the comment content. This will be used if `blocks` is not present on the comment object. + */ + private String value; + } +}