Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions json-logs/samples/api/entity.presentComments.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"ok": false,
"error": "",
"needed": "",
"provided": "",
"response_metadata": {
"messages": [
""
]
},
"warning": ""
}
1 change: 1 addition & 0 deletions metadata/web-api/rate_limit_tiers.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.*;
Expand Down Expand Up @@ -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.*;
Expand Down Expand Up @@ -1373,6 +1375,10 @@ CompletableFuture<AdminConversationsWhitelistListGroupsLinkedToChannelResponse>
// entity
// ------------------------------

CompletableFuture<EntityPresentCommentsResponse> entityPresentComments(EntityPresentCommentsRequest req);

CompletableFuture<EntityPresentCommentsResponse> entityPresentComments(RequestConfigurator<EntityPresentCommentsRequest.EntityPresentCommentsRequestBuilder> req);

CompletableFuture<EntityPresentDetailsResponse> entityPresentDetails(EntityPresentDetailsRequest req);

CompletableFuture<EntityPresentDetailsResponse> entityPresentDetails(RequestConfigurator<EntityPresentDetailsRequest.EntityPresentDetailsRequestBuilder> req);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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";

// ------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -2155,6 +2157,13 @@ EmojiListResponse emojiList(RequestConfigurator<EmojiListRequest.EmojiListReques
// entity
// ------------------------------

EntityPresentCommentsResponse entityPresentComments(EntityPresentCommentsRequest req)
throws IOException, SlackApiException;

EntityPresentCommentsResponse entityPresentComments(
RequestConfigurator<EntityPresentCommentsRequest.EntityPresentCommentsRequestBuilder> req)
throws IOException, SlackApiException;

EntityPresentDetailsResponse entityPresentDetails(EntityPresentDetailsRequest req)
throws IOException, SlackApiException;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -2411,6 +2413,16 @@ public CompletableFuture<EmojiListResponse> emojiList(RequestConfigurator<EmojiL
return emojiList(req.configure(EmojiListRequest.builder()).build());
}

@Override
public CompletableFuture<EntityPresentCommentsResponse> entityPresentComments(EntityPresentCommentsRequest req) {
return executor.execute(ENTITY_PRESENT_COMMENTS, toMap(req), () -> methods.entityPresentComments(req));
}

@Override
public CompletableFuture<EntityPresentCommentsResponse> entityPresentComments(RequestConfigurator<EntityPresentCommentsRequest.EntityPresentCommentsRequestBuilder> req) {
return entityPresentComments(req.configure(EntityPresentCommentsRequest.builder()).build());
}

@Override
public CompletableFuture<EntityPresentDetailsResponse> entityPresentDetails(EntityPresentDetailsRequest req) {
return executor.execute(ENTITY_PRESENT_DETAILS, toMap(req), () -> methods.entityPresentDetails(req));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -2673,6 +2675,16 @@ public EmojiListResponse emojiList(RequestConfigurator<EmojiListRequest.EmojiLis
return emojiList(req.configure(EmojiListRequest.builder()).build());
}

@Override
public EntityPresentCommentsResponse entityPresentComments(EntityPresentCommentsRequest req) throws IOException, SlackApiException {
return postFormWithTokenAndParseResponse(toForm(req), Methods.ENTITY_PRESENT_COMMENTS, getToken(req), EntityPresentCommentsResponse.class);
}

@Override
public EntityPresentCommentsResponse entityPresentComments(RequestConfigurator<EntityPresentCommentsRequest.EntityPresentCommentsRequestBuilder> 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);
Expand Down
Original file line number Diff line number Diff line change
@@ -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<EntityComment> 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;

}
Original file line number Diff line number Diff line change
@@ -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<String, List<String>> httpResponseHeaders;

private ErrorResponseMetadata responseMetadata;
}
Loading
Loading