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
5 changes: 5 additions & 0 deletions .changeset/admin-analytics-members-metadata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@slack/web-api": minor
---

feat(web-api): add [`admin.analytics.members.metadata`](https://docs.slack.dev/reference/methods/admin.analytics.members.metadata) method
12 changes: 12 additions & 0 deletions packages/web-api/src/methods.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { EventEmitter } from 'eventemitter3';
// Request, followed by response, types
import type {
AdminAnalyticsGetFileArguments,
AdminAnalyticsMembersMetadataArguments,
AdminAppsActivitiesListArguments,
AdminAppsApproveArguments,
AdminAppsApprovedListArguments,
Expand Down Expand Up @@ -303,6 +304,7 @@ import type {
} from './types/request/index';
import type {
AdminAnalyticsGetFileResponse,
AdminAnalyticsMembersMetadataResponse,
AdminAppsActivitiesListResponse,
AdminAppsApprovedListResponse,
AdminAppsApproveResponse,
Expand Down Expand Up @@ -671,6 +673,16 @@ export abstract class Methods extends EventEmitter<WebClientEvent> {
this,
'admin.analytics.getFile',
),
members: {
/**
* @description Retrieves profile metadata for each member of an organization or workspace.
* @see {@link https://docs.slack.dev/reference/methods/admin.analytics.members.metadata `admin.analytics.members.metadata` API reference}.
*/
metadata: bindApiCallWithOptionalArgument<
AdminAnalyticsMembersMetadataArguments,
AdminAnalyticsMembersMetadataResponse
>(this, 'admin.analytics.members.metadata'),
},
},
apps: {
activities: {
Expand Down
28 changes: 27 additions & 1 deletion packages/web-api/src/types/request/admin/analytics.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { TokenOverridable } from '../common';
import type { OptionalArgument } from '../../helpers';
import type { CursorPaginationEnabled, TokenOverridable } from '../common';

interface Date {
/**
Expand Down Expand Up @@ -42,3 +43,28 @@ type PublicChannelArgs = PublicChannelWithDate | PublicChannelWithMetadata;

// https://docs.slack.dev/reference/methods/admin.analytics.getFile
export type AdminAnalyticsGetFileArguments = TokenOverridable & (MemberArgs | PublicChannelArgs);

// https://docs.slack.dev/reference/methods/admin.analytics.members.metadata
export type AdminAnalyticsMembersMetadataArguments = OptionalArgument<
TokenOverridable &
CursorPaginationEnabled & {
/** @description Also return members deactivated on or after this day, as `YYYY-MM-DD` in UTC. */
include_deactivated_since?: string;
/** @description Workspace ID to scope the results to. With an organization-level token, omit it for organization-wide results. */
team_id?: string;
/** @description Member types to include. Omit to include every member type. */
member_types?: (
| 'regular_members'
| 'single_channel_guests'
| 'multi_channel_guests'
| 'frontline_members'
| 'org_owners'
| 'org_admins'
| 'workspace_owners'
| 'workspace_admins'
| 'invited'
)[];
/** @description Space-delimited search terms matched against member names, and against email addresses when the organization shows them. */
query?: string;
}
>;
2 changes: 1 addition & 1 deletion packages/web-api/src/types/request/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export type { AdminAnalyticsGetFileArguments } from './admin/analytics';
export type { AdminAnalyticsGetFileArguments, AdminAnalyticsMembersMetadataArguments } from './admin/analytics';
export type {
AdminAppsActivitiesListArguments,
AdminAppsApproveArguments,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
// //
// This file is auto-generated by scripts/generate-web-api-types.sh in the repository. //
// Please refer to the script code to learn how to update the source data. //
// //
/////////////////////////////////////////////////////////////////////////////////////////

import type { WebAPICallResult } from '../../WebClient';
export type AdminAnalyticsMembersMetadataResponse = WebAPICallResult & {
error?: string;
members?: Member[];
needed?: string;
ok?: boolean;
provided?: string;
response_metadata?: ResponseMetadata;
total_count?: number;
warning?: string;
};

export interface Member {
alternate_email?: string;
city?: string;
cost_center?: string;
country?: string;
date_created?: number;
date_deleted?: number;
department?: string;
display_name?: string;
division?: string;
email?: string;
employee_number?: string;
enterprise_id?: string;
honorific_prefix?: string;
locale?: string;
manager_id?: string;
mobile_phone?: string;
organization?: string;
preferred_language?: string;
primary_phone?: string;
real_name?: string;
role?: string;
street_address?: string;
team_id?: string;
user_id?: string;
user_title?: string;
user_type?: string;
username?: string;
workspaces?: { [key: string]: string };
zip_code?: string;
}

export interface ResponseMetadata {
messages?: string[];
next_cursor?: string;
}
1 change: 1 addition & 0 deletions packages/web-api/src/types/response/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export {
AdminAnalyticsPublicChannelDetails,
AdminAnalyticsPublicChannelMetadataDetails,
} from './AdminAnalyticsGetFileResponse';
export { AdminAnalyticsMembersMetadataResponse } from './AdminAnalyticsMembersMetadataResponse';
export { AdminAppsActivitiesListResponse } from './AdminAppsActivitiesListResponse';
export { AdminAppsApprovedListResponse } from './AdminAppsApprovedListResponse';
export { AdminAppsApproveResponse } from './AdminAppsApproveResponse';
Expand Down
21 changes: 21 additions & 0 deletions packages/web-api/test/types/methods/admin.analytics.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,24 @@ expectAssignable<Parameters<typeof web.admin.analytics.getFile>>([
metadata_only: true,
},
]);

// admin.analytics.members.metadata
// -- sad path
expectError(
web.admin.analytics.members.metadata({
member_types: ['not_a_member_type'], // unknown member type
}),
);
// -- happy path
expectAssignable<Parameters<typeof web.admin.analytics.members.metadata>>([]); // no arg is fine
expectAssignable<Parameters<typeof web.admin.analytics.members.metadata>>([{}]); // empty arg is fine
expectAssignable<Parameters<typeof web.admin.analytics.members.metadata>>([
{
include_deactivated_since: '2026-09-30',
team_id: 'T1234',
member_types: ['regular_members', 'single_channel_guests'],
query: 'alex',
limit: 100,
cursor: '5c3e53d5',
},
]);
Loading