From 3d053cdbc19bd8421a9cffc35c043b6983e8d38e Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Wed, 18 Nov 2026 13:09:56 -0800 Subject: [PATCH] feat(web-api): add admin.analytics.members.metadata method Co-authored-by: Claude --- .../admin-analytics-members-metadata.md | 5 ++ packages/web-api/src/methods.ts | 12 ++++ .../src/types/request/admin/analytics.ts | 28 ++++++++- packages/web-api/src/types/request/index.ts | 2 +- .../AdminAnalyticsMembersMetadataResponse.ts | 57 +++++++++++++++++++ packages/web-api/src/types/response/index.ts | 1 + .../types/methods/admin.analytics.test-d.ts | 21 +++++++ 7 files changed, 124 insertions(+), 2 deletions(-) create mode 100644 .changeset/admin-analytics-members-metadata.md create mode 100644 packages/web-api/src/types/response/AdminAnalyticsMembersMetadataResponse.ts diff --git a/.changeset/admin-analytics-members-metadata.md b/.changeset/admin-analytics-members-metadata.md new file mode 100644 index 000000000..bcd0c6059 --- /dev/null +++ b/.changeset/admin-analytics-members-metadata.md @@ -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 diff --git a/packages/web-api/src/methods.ts b/packages/web-api/src/methods.ts index 9c6fceb5e..2e299e45d 100644 --- a/packages/web-api/src/methods.ts +++ b/packages/web-api/src/methods.ts @@ -3,6 +3,7 @@ import { EventEmitter } from 'eventemitter3'; // Request, followed by response, types import type { AdminAnalyticsGetFileArguments, + AdminAnalyticsMembersMetadataArguments, AdminAppsActivitiesListArguments, AdminAppsApproveArguments, AdminAppsApprovedListArguments, @@ -303,6 +304,7 @@ import type { } from './types/request/index'; import type { AdminAnalyticsGetFileResponse, + AdminAnalyticsMembersMetadataResponse, AdminAppsActivitiesListResponse, AdminAppsApprovedListResponse, AdminAppsApproveResponse, @@ -671,6 +673,16 @@ export abstract class Methods extends EventEmitter { 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: { diff --git a/packages/web-api/src/types/request/admin/analytics.ts b/packages/web-api/src/types/request/admin/analytics.ts index 496dd6620..ec116a7b4 100644 --- a/packages/web-api/src/types/request/admin/analytics.ts +++ b/packages/web-api/src/types/request/admin/analytics.ts @@ -1,4 +1,5 @@ -import type { TokenOverridable } from '../common'; +import type { OptionalArgument } from '../../helpers'; +import type { CursorPaginationEnabled, TokenOverridable } from '../common'; interface Date { /** @@ -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; + } +>; diff --git a/packages/web-api/src/types/request/index.ts b/packages/web-api/src/types/request/index.ts index 6f5c96deb..08f0d1f2c 100644 --- a/packages/web-api/src/types/request/index.ts +++ b/packages/web-api/src/types/request/index.ts @@ -1,4 +1,4 @@ -export type { AdminAnalyticsGetFileArguments } from './admin/analytics'; +export type { AdminAnalyticsGetFileArguments, AdminAnalyticsMembersMetadataArguments } from './admin/analytics'; export type { AdminAppsActivitiesListArguments, AdminAppsApproveArguments, diff --git a/packages/web-api/src/types/response/AdminAnalyticsMembersMetadataResponse.ts b/packages/web-api/src/types/response/AdminAnalyticsMembersMetadataResponse.ts new file mode 100644 index 000000000..7f76c85b8 --- /dev/null +++ b/packages/web-api/src/types/response/AdminAnalyticsMembersMetadataResponse.ts @@ -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; +} diff --git a/packages/web-api/src/types/response/index.ts b/packages/web-api/src/types/response/index.ts index a2037ddf5..f74b197d5 100644 --- a/packages/web-api/src/types/response/index.ts +++ b/packages/web-api/src/types/response/index.ts @@ -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'; diff --git a/packages/web-api/test/types/methods/admin.analytics.test-d.ts b/packages/web-api/test/types/methods/admin.analytics.test-d.ts index 65ef19c03..30ba4e736 100644 --- a/packages/web-api/test/types/methods/admin.analytics.test-d.ts +++ b/packages/web-api/test/types/methods/admin.analytics.test-d.ts @@ -61,3 +61,24 @@ expectAssignable>([ 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>([]); // no arg is fine +expectAssignable>([{}]); // empty arg is fine +expectAssignable>([ + { + include_deactivated_since: '2026-09-30', + team_id: 'T1234', + member_types: ['regular_members', 'single_channel_guests'], + query: 'alex', + limit: 100, + cursor: '5c3e53d5', + }, +]);