Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat (web-api / types): Add support for assistant.threads.* API #2033

Merged
merged 6 commits into from
Sep 17, 2024
Merged

feat (web-api / types): Add support for assistant.threads.* API #2033

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
13e2461
Add ai.assistant.* APIs for AI apps
misscoded Aug 14, 2024
efc53eb
Update endpoints by removing ai
misscoded Sep 4, 2024
39fb2ba
Add Assistant types
misscoded Sep 16, 2024
cf02773
Run response generation script; swap out placeholders
misscoded Sep 17, 2024
cfaf1d6
Run linter to undo previous styling changes
misscoded Sep 17, 2024
2bfcfa3
Incorporate PR feedback
misscoded Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
29 changes: 29 additions & 0 deletions packages/types/src/events/assistant.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
export interface AssistantThreadStartedEvent {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@filmaj These are used in the implementation for Bolt, but figured they should go in now. Let me know if you prefer these to be separate!

type: 'assistant_thread_started';
assistant_thread: {
user_id: string;
context: {
channel_id?: string;
team_id?: string;
enterprise_id?: string | null;
};
channel_id: string;
thread_ts: string;
};
event_ts: string;
}

export interface AssistantThreadContextChangedEvent {
type: 'assistant_thread_context_changed';
assistant_thread: {
user_id: string;
context: {
channel_id?: string;
team_id?: string;
enterprise_id?: string | null;
};
channel_id: string;
thread_ts: string;
};
event_ts: string;
}
4 changes: 4 additions & 0 deletions packages/types/src/events/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import type {
AppUninstalledEvent,
AppUninstalledTeamEvent,
} from './app';
import type { AssistantThreadContextChangedEvent, AssistantThreadStartedEvent } from './assistant';
import type { CallRejectedEvent } from './call';
import type {
ChannelArchiveEvent,
Expand Down Expand Up @@ -86,6 +87,7 @@ import type { TokensRevokedEvent } from './token';
import type { UserChangeEvent, UserHuddleChangedEvent, UserProfileChangedEvent, UserStatusChangedEvent } from './user';

export * from './app';
export * from './assistant';
export * from './call';
export * from './channel';
export * from './dnd';
Expand Down Expand Up @@ -125,6 +127,8 @@ export type SlackEvent =
| AppRequestedEvent
| AppUninstalledTeamEvent
| AppUninstalledEvent
| AssistantThreadContextChangedEvent
| AssistantThreadStartedEvent
| CallRejectedEvent
| ChannelArchiveEvent
| ChannelCreatedEvent
Expand Down
16 changes: 2 additions & 14 deletions packages/web-api/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,10 @@
"description": "Official library for using the Slack Platform's Web API",
"author": "Slack Technologies, LLC",
"license": "MIT",
"keywords": [
"slack",
"web-api",
"bot",
"client",
"http",
"api",
"proxy",
"rate-limiting",
"pagination"
],
"keywords": ["slack", "web-api", "bot", "client", "http", "api", "proxy", "rate-limiting", "pagination"],
"main": "dist/index.js",
"types": "./dist/index.d.ts",
"files": [
"dist/**/*"
],
"files": ["dist/**/*"],
"engines": {
"node": ">= 18",
"npm": ">= 8.6.0"
Expand Down
35 changes: 35 additions & 0 deletions packages/web-api/src/methods.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,9 @@ import type {
AppsManifestUpdateArguments,
AppsManifestValidateArguments,
AppsUninstallArguments,
AssistantThreadsSetStatusArguments,
AssistantThreadsSetSuggestedPromptsArguments,
AssistantThreadsSetTitleArguments,
AuthRevokeArguments,
AuthTeamsListArguments,
AuthTestArguments,
Expand Down Expand Up @@ -357,6 +360,9 @@ import type {
AppsManifestUpdateResponse,
AppsManifestValidateResponse,
AppsUninstallResponse,
AssistantThreadsSetStatusResponse,
AssistantThreadsSetSuggestedPromptsResponse,
AssistantThreadsSetTitleResponse,
AuthRevokeResponse,
AuthTeamsListResponse,
AuthTestResponse,
Expand Down Expand Up @@ -1332,6 +1338,35 @@ export abstract class Methods extends EventEmitter<WebClientEvent> {
test: bindApiCallWithOptionalArgument<APITestArguments, ApiTestResponse>(this, 'api.test'),
};

public readonly assistant = {
threads: {
/**
* @description Set loading status to indicate that the app is building a response.
* @see {@link https://api.slack.com/methods/assistant.threads.setStatus `assistant.threads.setStatus` API reference}.
*/
setStatus: bindApiCall<AssistantThreadsSetStatusArguments, AssistantThreadsSetStatusResponse>(
this,
'assistant.threads.setStatus',
),
/**
* @description Set suggested prompts for the user. Can suggest up to four prompts.
* @see {@link https://api.slack.com/methods/assistant.threads.setSuggestedPrompts `assistant.threads.setSuggestedPrompts` API reference}.
*/
setSuggestedPrompts: bindApiCall<
AssistantThreadsSetSuggestedPromptsArguments,
AssistantThreadsSetSuggestedPromptsResponse
>(this, 'assistant.threads.setSuggestedPrompts'),
/**
* @description Set the title of the thread. This is shown when a user views the app's chat history.
* @see {@link https://api.slack.com/methods/assistant.threads.setTitle `assistant.threads.setTitle` API reference}.
*/
setTitle: bindApiCall<AssistantThreadsSetTitleArguments, AssistantThreadsSetTitleResponse>(
this,
'assistant.threads.setTitle',
),
},
};

public readonly apps = {
connections: {
/**
Expand Down
40 changes: 40 additions & 0 deletions packages/web-api/src/types/request/assistant.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import type { TokenOverridable } from './common';

// https://api.slack.com/methods/assistant.threads.setStatus
export interface AssistantThreadsSetStatusArguments extends TokenOverridable {
/** @description Channel ID containing the assistant thread. */
channel_id: string;
/** @description Status of the assistant (e.g. 'is thinking...') */
status: string;
/** @description Message timestamp of the thread. */
thread_ts: string;
}

// https://api.slack.com/methods/assistant.threads.setSuggestedPrompts
export interface AssistantThreadsSetSuggestedPromptsArguments extends TokenOverridable {
/** @description Channel ID containing the assistant thread. */
channel_id: string;
/** @description Prompt suggestions that appear when opening assistant thread. */
prompts: [AssistantPrompt, ...AssistantPrompt[]];
/** @description Message timestamp of the thread. */
thread_ts: string;
/** @description Title for the prompts. */
title?: string;
}

interface AssistantPrompt {
/** @description Title of the prompt. */
title: string;
/** @description Message of the prompt. */
message: string;
}

// https://api.slack.com/methods/assistant.threads.setTitle
export interface AssistantThreadsSetTitleArguments extends TokenOverridable {
/** @description Channel ID containing the assistant thread. */
channel_id: string;
/** @description Message timestamp of the thread. */
thread_ts: string;
/** @description Title of the thread. */
title: string;
}
5 changes: 5 additions & 0 deletions packages/web-api/src/types/request/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,11 @@ export type {
AppsUninstallArguments,
} from './apps';
export type { APITestArguments } from './api';
export type {
AssistantThreadsSetStatusArguments,
AssistantThreadsSetSuggestedPromptsArguments,
AssistantThreadsSetTitleArguments,
} from './assistant';
export type { AdminAnalyticsGetFileArguments } from './admin/analytics';
export type {
AdminAppsActivitiesListArguments,
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminAppsActivitiesListResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminAppsApproveResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
2 changes: 1 addition & 1 deletion packages/web-api/src/types/response/AdminAppsApprovedListResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down Expand Up @@ -35,6 +34,7 @@ export interface App {
icons?: Icons;
id?: string;
is_app_directory_approved?: boolean;
is_granular_bot_app?: boolean;
is_internal?: boolean;
name?: string;
privacy_policy_url?: string;
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminAppsClearResolutionResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminAppsConfigLookupResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminAppsConfigSetResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminAppsRequestsCancelResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
2 changes: 1 addition & 1 deletion packages/web-api/src/types/response/AdminAppsRequestsListResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down Expand Up @@ -40,6 +39,7 @@ export interface App {
icons?: Icons;
id?: string;
is_app_directory_approved?: boolean;
is_granular_bot_app?: boolean;
is_internal?: boolean;
name?: string;
privacy_policy_url?: string;
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminAppsRestrictResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
2 changes: 1 addition & 1 deletion packages/web-api/src/types/response/AdminAppsRestrictedListResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down Expand Up @@ -41,6 +40,7 @@ export interface App {
icons?: Icons;
id?: string;
is_app_directory_approved?: boolean;
is_granular_bot_app?: boolean;
is_internal?: boolean;
name?: string;
privacy_policy_url?: string;
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminAppsUninstallResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminAuthPolicyAssignEntitiesResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminAuthPolicyGetEntitiesResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminAuthPolicyRemoveEntitiesResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminBarriersCreateResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminBarriersDeleteResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminBarriersListResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminBarriersUpdateResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsArchiveResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsBulkArchiveResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsBulkDeleteResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsBulkMoveResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsConvertToPrivateResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsConvertToPublicResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsCreateResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsDeleteResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsDisconnectSharedResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion ...b-api/src/types/response/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsGetConversationPrefsResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsGetCustomRetentionResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsGetTeamsResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsInviteResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsLookupResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsRemoveCustomRetentionResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsRenameResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsRestrictAccessAddGroupResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
1 change: 0 additions & 1 deletion packages/web-api/src/types/response/AdminConversationsRestrictAccessListGroupsResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-disable */
/////////////////////////////////////////////////////////////////////////////////////////
// //
// !!! DO NOT EDIT THIS FILE !!! //
Expand Down
Loading