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
50 changes: 50 additions & 0 deletions json-logs/samples/api/admin.analytics.members.metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
{
"ok": false,
"members": [
{
"user_id": "U00000000",
"team_id": "T00000000",
"enterprise_id": "E00000000",
"date_created": 12345,
"date_deleted": 12345,
"username": "",
"real_name": "",
"display_name": "",
"user_title": "",
"email": "",
"alternate_email": "",
"workspaces": {
"0": "",
"1": ""
},
"department": "",
"cost_center": "",
"division": "",
"primary_phone": "",
"mobile_phone": "",
"role": "",
"user_type": "",
"employee_number": "",
"locale": "",
"honorific_prefix": "",
"manager_id": "U00000000",
"organization": "",
"preferred_language": "",
"street_address": "",
"country": "",
"city": "",
"zip_code": ""
}
],
"total_count": 12345,
"response_metadata": {
"messages": [
""
],
"next_cursor": ""
},
"error": "",
"needed": "",
"provided": "",
"warning": ""
}
1 change: 1 addition & 0 deletions metadata/web-api/rate_limit_tiers.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"admin.analytics.getFile": "Tier2",
"admin.analytics.members.metadata": "Tier2",
"admin.apps.activities.list": "Tier3",
"admin.apps.approve": "Tier2",
"admin.apps.approved.list": "Tier2",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import com.slack.api.RequestConfigurator;
import com.slack.api.methods.request.admin.analytics.AdminAnalyticsGetFileRequest;
import com.slack.api.methods.request.admin.analytics.members.AdminAnalyticsMembersMetadataRequest;
import com.slack.api.methods.request.admin.apps.*;
import com.slack.api.methods.request.admin.apps.mcp.servers.AdminAppsMcpServersListRequest;
import com.slack.api.methods.request.admin.apps.mcp.servers.permissions.AdminAppsMcpServersPermissionsListRequest;
Expand Down Expand Up @@ -171,6 +172,7 @@
import com.slack.api.methods.request.workflows.WorkflowsStepFailedRequest;
import com.slack.api.methods.request.workflows.WorkflowsUpdateStepRequest;
import com.slack.api.methods.response.admin.analytics.AdminAnalyticsGetFileResponse;
import com.slack.api.methods.response.admin.analytics.members.AdminAnalyticsMembersMetadataResponse;
import com.slack.api.methods.response.admin.apps.*;
import com.slack.api.methods.response.admin.apps.mcp.servers.AdminAppsMcpServersListResponse;
import com.slack.api.methods.response.admin.apps.mcp.servers.permissions.AdminAppsMcpServersPermissionsListResponse;
Expand Down Expand Up @@ -360,6 +362,14 @@ public interface AsyncMethodsClient {

CompletableFuture<AdminAnalyticsGetFileResponse> adminAnalyticsGetFile(RequestConfigurator<AdminAnalyticsGetFileRequest.AdminAnalyticsGetFileRequestBuilder> req);

// ------------------------------
// admin.analytics.members
// ------------------------------

CompletableFuture<AdminAnalyticsMembersMetadataResponse> adminAnalyticsMembersMetadata(AdminAnalyticsMembersMetadataRequest req);

CompletableFuture<AdminAnalyticsMembersMetadataResponse> adminAnalyticsMembersMetadata(RequestConfigurator<AdminAnalyticsMembersMetadataRequest.AdminAnalyticsMembersMetadataRequestBuilder> req);

// ------------------------------
// admin.apps
// ------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ private Methods() {

public static final String ADMIN_ANALYTICS_GET_FILE = "admin.analytics.getFile";

// ------------------------------
// admin.analytics.members
// ------------------------------

public static final String ADMIN_ANALYTICS_MEMBERS_METADATA = "admin.analytics.members.metadata";

// ------------------------------
// admin.apps
// ------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import com.slack.api.RequestConfigurator;
import com.slack.api.methods.request.admin.analytics.AdminAnalyticsGetFileRequest;
import com.slack.api.methods.request.admin.analytics.members.AdminAnalyticsMembersMetadataRequest;
import com.slack.api.methods.request.admin.apps.*;
import com.slack.api.methods.request.admin.apps.mcp.servers.AdminAppsMcpServersListRequest;
import com.slack.api.methods.request.admin.apps.mcp.servers.permissions.AdminAppsMcpServersPermissionsListRequest;
Expand Down Expand Up @@ -184,6 +185,7 @@
import com.slack.api.methods.request.workflows.WorkflowsStepFailedRequest;
import com.slack.api.methods.request.workflows.WorkflowsUpdateStepRequest;
import com.slack.api.methods.response.admin.analytics.AdminAnalyticsGetFileResponse;
import com.slack.api.methods.response.admin.analytics.members.AdminAnalyticsMembersMetadataResponse;
import com.slack.api.methods.response.admin.apps.*;
import com.slack.api.methods.response.admin.apps.mcp.servers.AdminAppsMcpServersListResponse;
import com.slack.api.methods.response.admin.apps.mcp.servers.permissions.AdminAppsMcpServersPermissionsListResponse;
Expand Down Expand Up @@ -439,6 +441,15 @@ AdminAnalyticsGetFileResponse adminAnalyticsGetFile(
RequestConfigurator<AdminAnalyticsGetFileRequest.AdminAnalyticsGetFileRequestBuilder> req)
throws IOException, SlackApiException;

// ------------------------------
// admin.analytics.members
// ------------------------------

AdminAnalyticsMembersMetadataResponse adminAnalyticsMembersMetadata(AdminAnalyticsMembersMetadataRequest req) throws IOException, SlackApiException;

AdminAnalyticsMembersMetadataResponse adminAnalyticsMembersMetadata(RequestConfigurator<AdminAnalyticsMembersMetadataRequest.AdminAnalyticsMembersMetadataRequestBuilder> req)
throws IOException, SlackApiException;

// ------------------------------
// admin.apps
// ------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ public static void setRateLimitTier(String methodName, MethodsRateLimitTier tier
// Tier2
final List<String> adminApiMethods_Tier2 = Arrays.asList(
ADMIN_ANALYTICS_GET_FILE,
ADMIN_ANALYTICS_MEMBERS_METADATA,

ADMIN_APPS_APPROVE,
ADMIN_APPS_CLEAR_RESOLUTION,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.slack.api.methods.request.admin.analytics.AdminAnalyticsGetFileRequest;
import com.slack.api.methods.request.admin.analytics.members.AdminAnalyticsMembersMetadataRequest;
import com.slack.api.methods.request.admin.apps.*;
import com.slack.api.methods.request.admin.apps.mcp.servers.AdminAppsMcpServersListRequest;
import com.slack.api.methods.request.admin.apps.mcp.servers.permissions.AdminAppsMcpServersPermissionsListRequest;
Expand Down Expand Up @@ -219,6 +220,19 @@ public static FormBody.Builder toForm(AdminAnalyticsGetFileRequest req) {
return form;
}

public static FormBody.Builder toForm(AdminAnalyticsMembersMetadataRequest req) {
FormBody.Builder form = new FormBody.Builder();
setIfNotNull("include_deactivated_since", req.getIncludeDeactivatedSince(), form);
setIfNotNull("team_id", req.getTeamId(), form);
if (req.getMemberTypes() != null) {
setIfNotNull("member_types", req.getMemberTypes().stream().collect(joining(",")), form);
}
setIfNotNull("query", req.getQuery(), form);
setIfNotNull("cursor", req.getCursor(), form);
setIfNotNull("limit", req.getLimit(), form);
return form;
}

public static FormBody.Builder toForm(AdminUsersSessionResetRequest req) {
FormBody.Builder form = new FormBody.Builder();
setIfNotNull("user_id", req.getUserId(), form);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import com.slack.api.methods.MethodsClient;
import com.slack.api.methods.SlackApiRequest;
import com.slack.api.methods.request.admin.analytics.AdminAnalyticsGetFileRequest;
import com.slack.api.methods.request.admin.analytics.members.AdminAnalyticsMembersMetadataRequest;
import com.slack.api.methods.request.admin.apps.*;
import com.slack.api.methods.request.admin.apps.mcp.servers.AdminAppsMcpServersListRequest;
import com.slack.api.methods.request.admin.apps.mcp.servers.permissions.AdminAppsMcpServersPermissionsListRequest;
Expand Down Expand Up @@ -175,6 +176,7 @@
import com.slack.api.methods.request.workflows.WorkflowsStepFailedRequest;
import com.slack.api.methods.request.workflows.WorkflowsUpdateStepRequest;
import com.slack.api.methods.response.admin.analytics.AdminAnalyticsGetFileResponse;
import com.slack.api.methods.response.admin.analytics.members.AdminAnalyticsMembersMetadataResponse;
import com.slack.api.methods.response.admin.apps.*;
import com.slack.api.methods.response.admin.apps.mcp.servers.AdminAppsMcpServersListResponse;
import com.slack.api.methods.response.admin.apps.mcp.servers.permissions.AdminAppsMcpServersPermissionsListResponse;
Expand Down Expand Up @@ -397,6 +399,16 @@ public CompletableFuture<AdminAnalyticsGetFileResponse> adminAnalyticsGetFile(Re
return adminAnalyticsGetFile(req.configure(AdminAnalyticsGetFileRequest.builder()).build());
}

@Override
public CompletableFuture<AdminAnalyticsMembersMetadataResponse> adminAnalyticsMembersMetadata(AdminAnalyticsMembersMetadataRequest req) {
return executor.execute(ADMIN_ANALYTICS_MEMBERS_METADATA, toMap(req), () -> methods.adminAnalyticsMembersMetadata(req));
}

@Override
public CompletableFuture<AdminAnalyticsMembersMetadataResponse> adminAnalyticsMembersMetadata(RequestConfigurator<AdminAnalyticsMembersMetadataRequest.AdminAnalyticsMembersMetadataRequestBuilder> req) {
return adminAnalyticsMembersMetadata(req.configure(AdminAnalyticsMembersMetadataRequest.builder()).build());
}

@Override
public CompletableFuture<AdminAppsApproveResponse> adminAppsApprove(AdminAppsApproveRequest req) {
return executor.execute(ADMIN_APPS_APPROVE, toMap(req), () -> methods.adminAppsApprove(req));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import com.slack.api.RequestConfigurator;
import com.slack.api.methods.*;
import com.slack.api.methods.request.admin.analytics.AdminAnalyticsGetFileRequest;
import com.slack.api.methods.request.admin.analytics.members.AdminAnalyticsMembersMetadataRequest;
import com.slack.api.methods.request.admin.apps.*;
import com.slack.api.methods.request.admin.apps.mcp.servers.AdminAppsMcpServersListRequest;
import com.slack.api.methods.request.admin.apps.mcp.servers.permissions.AdminAppsMcpServersPermissionsListRequest;
Expand Down Expand Up @@ -185,6 +186,7 @@
import com.slack.api.methods.request.workflows.WorkflowsStepFailedRequest;
import com.slack.api.methods.request.workflows.WorkflowsUpdateStepRequest;
import com.slack.api.methods.response.admin.analytics.AdminAnalyticsGetFileResponse;
import com.slack.api.methods.response.admin.analytics.members.AdminAnalyticsMembersMetadataResponse;
import com.slack.api.methods.response.admin.apps.*;
import com.slack.api.methods.response.admin.apps.mcp.servers.AdminAppsMcpServersListResponse;
import com.slack.api.methods.response.admin.apps.mcp.servers.permissions.AdminAppsMcpServersPermissionsListResponse;
Expand Down Expand Up @@ -4269,6 +4271,16 @@ public AdminAnalyticsGetFileResponse adminAnalyticsGetFile(RequestConfigurator<A
return adminAnalyticsGetFile(req.configure(AdminAnalyticsGetFileRequest.builder()).build());
}

@Override
public AdminAnalyticsMembersMetadataResponse adminAnalyticsMembersMetadata(AdminAnalyticsMembersMetadataRequest req) throws IOException, SlackApiException {
return postFormWithTokenAndParseResponse(toForm(req), Methods.ADMIN_ANALYTICS_MEMBERS_METADATA, getToken(req), AdminAnalyticsMembersMetadataResponse.class);
}

@Override
public AdminAnalyticsMembersMetadataResponse adminAnalyticsMembersMetadata(RequestConfigurator<AdminAnalyticsMembersMetadataRequest.AdminAnalyticsMembersMetadataRequestBuilder> req) throws IOException, SlackApiException {
return adminAnalyticsMembersMetadata(req.configure(AdminAnalyticsMembersMetadataRequest.builder()).build());
}

@Override
public <T extends SlackApiTextResponse> T postFormWithTokenAndParseResponse(
RequestConfigurator<FormBody.Builder> form,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
package com.slack.api.methods.request.admin.analytics.members;

import com.slack.api.methods.SlackApiRequest;
import lombok.Builder;
import lombok.Data;

import java.util.List;

/**
* https://docs.slack.dev/reference/methods/admin.analytics.members.metadata
*/
@Data
@Builder
public class AdminAnalyticsMembersMetadataRequest implements SlackApiRequest {

/**
* Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
*/
private String token;

/**
* Also return members deactivated on or after this day, as `YYYY-MM-DD` in UTC.
*/
private String includeDeactivatedSince;

/**
* Workspace ID to scope the results to. With an organization-level token, omit it for organization-wide results.
*/
private String teamId;

/**
* Member types to include: `regular_members`, `single_channel_guests`, `multi_channel_guests`, `frontline_members`,
* `org_owners`, `org_admins`, `workspace_owners`, `workspace_admins`, or `invited`. Omit to include every member type.
*/
private List<String> memberTypes;

/**
* Space-delimited search terms matched against member names, and against email addresses when the organization shows them.
*/
private String query;

/**
* Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
*/
private String cursor;

/**
* Maximum number of members to return. Max allowed is 500.
*/
private Integer limit;

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
package com.slack.api.methods.response.admin.analytics.members;

import com.slack.api.methods.SlackApiTextResponse;
import com.slack.api.model.ResponseMetadata;
import lombok.Data;

import java.util.List;
import java.util.Map;

@Data
public class AdminAnalyticsMembersMetadataResponse 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 List<Member> members;
private Integer totalCount;
private ResponseMetadata responseMetadata;

@Data
public static class Member {
private String userId;
private String teamId;
private String enterpriseId;
private Integer dateCreated;
private Integer dateDeleted;
private String username;
private String realName;
private String displayName;
private String userTitle;
private String email;
private String alternateEmail;
private Map<String, String> workspaces;
private String department;
private String costCenter;
private String division;
private String primaryPhone;
private String mobilePhone;
private String role;
private String userType;
private String employeeNumber;
private String locale;
private String honorificPrefix;
private String managerId;
private String organization;
private String preferredLanguage;
private String streetAddress;
private String country;
private String city;
private String zipCode;
}
}
Loading
Loading