Skip to content
Merged
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-users-get-expiration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@slack/web-api": minor
---

feat(web-api): add support for [`admin.users.getExpiration`](https://docs.slack.dev/reference/methods/admin.users.getExpiration)
10 changes: 10 additions & 0 deletions packages/web-api/src/methods.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ import type {
AdminUsergroupsListChannelsArguments,
AdminUsergroupsRemoveChannelsArguments,
AdminUsersAssignArguments,
AdminUsersGetExpirationArguments,
AdminUsersInviteArguments,
AdminUsersListArguments,
AdminUsersRemoveArguments,
Expand Down Expand Up @@ -346,6 +347,7 @@ import type {
AdminUsergroupsListChannelsResponse,
AdminUsergroupsRemoveChannelsResponse,
AdminUsersAssignResponse,
AdminUsersGetExpirationResponse,
AdminUsersInviteResponse,
AdminUsersListResponse,
AdminUsersRemoveResponse,
Expand Down Expand Up @@ -1202,6 +1204,14 @@ export abstract class Methods extends EventEmitter<WebClientEvent> {
* @see {@link https://docs.slack.dev/reference/methods/admin.users.assign `admin.users.assign` API reference}.
*/
assign: bindApiCall<AdminUsersAssignArguments, AdminUsersAssignResponse>(this, 'admin.users.assign'),
/**
* @description Fetches the expiration timestamp for a guest.
* @see {@link https://docs.slack.dev/reference/methods/admin.users.getExpiration `admin.users.getExpiration` API reference}.
*/
getExpiration: bindApiCall<AdminUsersGetExpirationArguments, AdminUsersGetExpirationResponse>(
this,
'admin.users.getExpiration',
),
/**
* @description Invite a user to a workspace.
* @see {@link https://docs.slack.dev/reference/methods/admin.users.invite `admin.users.invite` API reference}.
Expand Down
10 changes: 10 additions & 0 deletions packages/web-api/src/types/request/admin/users.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,16 @@ export interface AdminUsersAssignArguments
IsUltraRestricted,
TokenOverridable {}

// https://docs.slack.dev/reference/methods/admin.users.getExpiration
export interface AdminUsersGetExpirationArguments extends TokenOverridable {
/** @description The ID of the guest user to get the expiration for. */
user_id?: string;
/**
* @description If an org token is passed in and this team is on the org, it will operate on the workspace level
* on the specified team. Otherwise it will operate on the org or team in context. */
target_team?: string;
}

// https://docs.slack.dev/reference/methods/admin.users.invite
export interface AdminUsersInviteArguments
extends ChannelIDs,
Expand Down
1 change: 1 addition & 0 deletions packages/web-api/src/types/request/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ export type {
} from './admin/usergroups';
export type {
AdminUsersAssignArguments,
AdminUsersGetExpirationArguments,
AdminUsersInviteArguments,
AdminUsersListArguments,
AdminUsersRemoveArguments,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! 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 AdminUsersGetExpirationResponse = WebAPICallResult & {
error?: string;
needed?: string;
ok?: boolean;
provided?: string;
user?: User;
};

export interface User {
email?: string;
expiration_ts?: number;
id?: string;
is_restricted?: boolean;
is_ultra_restricted?: boolean;
}
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 @@ -81,6 +81,7 @@ export { AdminUsergroupsAddTeamsResponse } from './AdminUsergroupsAddTeamsRespon
export { AdminUsergroupsListChannelsResponse } from './AdminUsergroupsListChannelsResponse';
export { AdminUsergroupsRemoveChannelsResponse } from './AdminUsergroupsRemoveChannelsResponse';
export { AdminUsersAssignResponse } from './AdminUsersAssignResponse';
export { AdminUsersGetExpirationResponse } from './AdminUsersGetExpirationResponse';
export { AdminUsersInviteResponse } from './AdminUsersInviteResponse';
export { AdminUsersListResponse } from './AdminUsersListResponse';
export { AdminUsersRemoveResponse } from './AdminUsersRemoveResponse';
Expand Down