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

slackapi · Sep 17, 2024 · 571bc3a · 571bc3a
1 parent 072abd1
commit 571bc3a
Show file tree

Hide file tree

Showing 313 changed files with 1,244 additions and 1,243 deletions.
diff --git a/packages/types/src/events/assistant.ts b/packages/types/src/events/assistant.ts
@@ -0,0 +1,29 @@
+export interface AssistantThreadStartedEvent {
+  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;
+}
diff --git a/packages/types/src/events/index.ts b/packages/types/src/events/index.ts
@@ -8,6 +8,7 @@ import type {
   AppUninstalledEvent,
   AppUninstalledTeamEvent,
 } from './app';
+import type { AssistantThreadContextChangedEvent, AssistantThreadStartedEvent } from './assistant';
 import type { CallRejectedEvent } from './call';
 import type {
   ChannelArchiveEvent,
@@ -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';
@@ -125,6 +127,8 @@ export type SlackEvent =
   | AppRequestedEvent
   | AppUninstalledTeamEvent
   | AppUninstalledEvent
+  | AssistantThreadContextChangedEvent
+  | AssistantThreadStartedEvent
   | CallRejectedEvent
   | ChannelArchiveEvent
   | ChannelCreatedEvent

diff --git a/packages/web-api/package.json b/packages/web-api/package.json
@@ -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"

diff --git a/packages/web-api/src/methods.ts b/packages/web-api/src/methods.ts
@@ -108,6 +108,9 @@ import type {
   AppsManifestUpdateArguments,
   AppsManifestValidateArguments,
   AppsUninstallArguments,
+  AssistantThreadsSetStatusArguments,
+  AssistantThreadsSetSuggestedPromptsArguments,
+  AssistantThreadsSetTitleArguments,
   AuthRevokeArguments,
   AuthTeamsListArguments,
   AuthTestArguments,
@@ -357,6 +360,9 @@ import type {
   AppsManifestUpdateResponse,
   AppsManifestValidateResponse,
   AppsUninstallResponse,
+  AssistantThreadsSetStatusResponse,
+  AssistantThreadsSetSuggestedPromptsResponse,
+  AssistantThreadsSetTitleResponse,
   AuthRevokeResponse,
   AuthTeamsListResponse,
   AuthTestResponse,
@@ -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: {
       /**

diff --git a/packages/web-api/src/types/request/assistant.ts b/packages/web-api/src/types/request/assistant.ts
@@ -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;
+}
diff --git a/packages/web-api/src/types/request/index.ts b/packages/web-api/src/types/request/index.ts
@@ -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,

diff --git a/packages/web-api/src/types/response/AdminAppsActivitiesListResponse.ts b/packages/web-api/src/types/response/AdminAppsActivitiesListResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminAppsApproveResponse.ts b/packages/web-api/src/types/response/AdminAppsApproveResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminAppsApprovedListResponse.ts b/packages/web-api/src/types/response/AdminAppsApprovedListResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //
@@ -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;

diff --git a/packages/web-api/src/types/response/AdminAppsClearResolutionResponse.ts b/packages/web-api/src/types/response/AdminAppsClearResolutionResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminAppsConfigLookupResponse.ts b/packages/web-api/src/types/response/AdminAppsConfigLookupResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminAppsConfigSetResponse.ts b/packages/web-api/src/types/response/AdminAppsConfigSetResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminAppsRequestsCancelResponse.ts b/packages/web-api/src/types/response/AdminAppsRequestsCancelResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminAppsRequestsListResponse.ts b/packages/web-api/src/types/response/AdminAppsRequestsListResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //
@@ -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;

diff --git a/packages/web-api/src/types/response/AdminAppsRestrictResponse.ts b/packages/web-api/src/types/response/AdminAppsRestrictResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminAppsRestrictedListResponse.ts b/packages/web-api/src/types/response/AdminAppsRestrictedListResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //
@@ -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;

diff --git a/packages/web-api/src/types/response/AdminAppsUninstallResponse.ts b/packages/web-api/src/types/response/AdminAppsUninstallResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminAuthPolicyAssignEntitiesResponse.ts b/packages/web-api/src/types/response/AdminAuthPolicyAssignEntitiesResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminAuthPolicyGetEntitiesResponse.ts b/packages/web-api/src/types/response/AdminAuthPolicyGetEntitiesResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminAuthPolicyRemoveEntitiesResponse.ts b/packages/web-api/src/types/response/AdminAuthPolicyRemoveEntitiesResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminBarriersCreateResponse.ts b/packages/web-api/src/types/response/AdminBarriersCreateResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminBarriersDeleteResponse.ts b/packages/web-api/src/types/response/AdminBarriersDeleteResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminBarriersListResponse.ts b/packages/web-api/src/types/response/AdminBarriersListResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminBarriersUpdateResponse.ts b/packages/web-api/src/types/response/AdminBarriersUpdateResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsArchiveResponse.ts b/packages/web-api/src/types/response/AdminConversationsArchiveResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsBulkArchiveResponse.ts b/packages/web-api/src/types/response/AdminConversationsBulkArchiveResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsBulkDeleteResponse.ts b/packages/web-api/src/types/response/AdminConversationsBulkDeleteResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsBulkMoveResponse.ts b/packages/web-api/src/types/response/AdminConversationsBulkMoveResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsConvertToPrivateResponse.ts b/packages/web-api/src/types/response/AdminConversationsConvertToPrivateResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsConvertToPublicResponse.ts b/packages/web-api/src/types/response/AdminConversationsConvertToPublicResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsCreateResponse.ts b/packages/web-api/src/types/response/AdminConversationsCreateResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsDeleteResponse.ts b/packages/web-api/src/types/response/AdminConversationsDeleteResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsDisconnectSharedResponse.ts b/packages/web-api/src/types/response/AdminConversationsDisconnectSharedResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/...b-api/src/types/response/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.ts b/...b-api/src/types/response/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsGetConversationPrefsResponse.ts b/packages/web-api/src/types/response/AdminConversationsGetConversationPrefsResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsGetCustomRetentionResponse.ts b/packages/web-api/src/types/response/AdminConversationsGetCustomRetentionResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsGetTeamsResponse.ts b/packages/web-api/src/types/response/AdminConversationsGetTeamsResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsInviteResponse.ts b/packages/web-api/src/types/response/AdminConversationsInviteResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsLookupResponse.ts b/packages/web-api/src/types/response/AdminConversationsLookupResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsRemoveCustomRetentionResponse.ts b/packages/web-api/src/types/response/AdminConversationsRemoveCustomRetentionResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsRenameResponse.ts b/packages/web-api/src/types/response/AdminConversationsRenameResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsRestrictAccessAddGroupResponse.ts b/packages/web-api/src/types/response/AdminConversationsRestrictAccessAddGroupResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //

diff --git a/packages/web-api/src/types/response/AdminConversationsRestrictAccessListGroupsResponse.ts b/packages/web-api/src/types/response/AdminConversationsRestrictAccessListGroupsResponse.ts
@@ -1,4 +1,3 @@
-/* eslint-disable */
 /////////////////////////////////////////////////////////////////////////////////////////
 //                                                                                     //
 // !!! DO NOT EDIT THIS FILE !!!                                                       //