Add support for functions.* (complete) methods (#1702)

slackapi · Dec 7, 2023 · 4f39371 · 4f39371
1 parent b18a32b
commit 4f39371
Show file tree

Hide file tree

Showing 31 changed files with 546 additions and 254 deletions.
diff --git a/packages/web-api/src/methods.ts b/packages/web-api/src/methods.ts
@@ -155,6 +155,8 @@ import {
   FilesRevokePublicURLResponse,
   FilesSharedPublicURLResponse,
   FilesUploadResponse,
+  FunctionsCompleteErrorResponse,
+  FunctionsCompleteSuccessResponse,
   MigrationExchangeResponse,
   OauthAccessResponse,
   OauthV2AccessResponse,
@@ -752,6 +754,14 @@ export abstract class Methods extends EventEmitter<WebClientEvent> {
     },
   };
 
+  public readonly functions = {
+    completeError: bindApiCall<FunctionsCompleteErrorArguments, FunctionsCompleteErrorResponse>(this, 'functions.completeError'),
+    completeSuccess: bindApiCall<FunctionsCompleteSuccessArguments, FunctionsCompleteSuccessResponse>(
+      this,
+      'functions.completeSuccess',
+    ),
+  };
+
   public readonly migration = {
     exchange: bindApiCall<MigrationExchangeArguments, MigrationExchangeResponse>(this, 'migration.exchange'),
   };
@@ -2077,6 +2087,19 @@ export interface FilesRemoteShareArguments extends WebAPICallOptions, TokenOverr
   external_id?: string;
 }
 
+/*
+ * `functions.*`
+ */
+export interface FunctionsCompleteErrorArguments extends WebAPICallOptions, TokenOverridable {
+  function_execution_id: string;
+  error: string;
+}
+
+export interface FunctionsCompleteSuccessArguments extends WebAPICallOptions, TokenOverridable {
+  function_execution_id: string;
+  outputs: Record<string, unknown>;
+}
+
 /*
  * `groups.*`
  */

diff --git a/packages/web-api/src/response/AdminFunctionsListResponse.ts b/packages/web-api/src/response/AdminFunctionsListResponse.ts
@@ -25,6 +25,7 @@ export interface Function {
   date_deleted?:      number;
   date_updated?:      number;
   description?:       string;
+  form_enabled?:      boolean;
   id?:                string;
   input_parameters?:  PutParameter[];
   output_parameters?: PutParameter[];

diff --git a/packages/web-api/src/response/AppsManifestExportResponse.ts b/packages/web-api/src/response/AppsManifestExportResponse.ts
@@ -21,13 +21,14 @@ export interface Manifest {
   _metadata?:           Metadata;
   display_information?: DisplayInformation;
   features?:            Features;
+  functions?:           { [key: string]: Function };
   oauth_config?:        OauthConfig;
   settings?:            Settings;
 }
 
 export interface Metadata {
-  major_version?: string;
-  minor_version?: string;
+  major_version?: number;
+  minor_version?: number;
 }
 
 export interface DisplayInformation {
@@ -71,9 +72,30 @@ export interface SlashCommand {
   usage_hint?:    string;
 }
 
+export interface Function {
+  description?:       string;
+  input_parameters?:  { [key: string]: PutParameter };
+  output_parameters?: { [key: string]: PutParameter };
+  title?:             string;
+}
+
+export interface PutParameter {
+  description?: string;
+  hint?:        string;
+  is_required?: boolean;
+  maxLength?:   number;
+  maximum?:     number;
+  minLength?:   number;
+  minimum?:     number;
+  name?:        string;
+  title?:       string;
+  type?:        string;
+}
+
 export interface OauthConfig {
-  redirect_urls?: string[];
-  scopes?:        Scopes;
+  redirect_urls?:            string[];
+  scopes?:                   Scopes;
+  token_management_enabled?: boolean;
 }
 
 export interface Scopes {
@@ -86,6 +108,8 @@ export interface Settings {
   background_color?:          string;
   description?:               string;
   event_subscriptions?:       EventSubscriptions;
+  function_runtime?:          string;
+  hermes_app_type?:           string;
   interactivity?:             Interactivity;
   long_description?:          string;
   org_deploy_enabled?:        boolean;

diff --git a/packages/web-api/src/response/AppsManifestValidateResponse.ts b/packages/web-api/src/response/AppsManifestValidateResponse.ts
@@ -19,9 +19,10 @@ export type AppsManifestValidateResponse = WebAPICallResult & {
 };
 
 export interface Error {
-  code?:    string;
-  message?: string;
-  pointer?: string;
+  code?:              string;
+  message?:           string;
+  pointer?:           string;
+  related_component?: string;
 }
 
 export interface ResponseMetadata {

diff --git a/packages/web-api/src/response/AuthTestResponse.ts b/packages/web-api/src/response/AuthTestResponse.ts
@@ -15,6 +15,7 @@ export type AuthTestResponse = WebAPICallResult & {
   bot_id?:                string;
   enterprise_id?:         string;
   error?:                 string;
+  expires_in?:            number;
   is_enterprise_install?: boolean;
   needed?:                string;
   ok?:                    boolean;

diff --git a/packages/web-api/src/response/ChatPostMessageResponse.ts b/packages/web-api/src/response/ChatPostMessageResponse.ts
@@ -426,6 +426,7 @@ export interface FileElement {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;
@@ -548,11 +549,13 @@ export interface Shares {
 export interface Private {
   access?:            string;
   channel_name?:      string;
+  date_last_shared?:  number;
   latest_reply?:      string;
   reply_count?:       number;
   reply_users?:       string[];
   reply_users_count?: number;
   share_user_id?:     string;
+  source?:            string;
   team_id?:           string;
   thread_ts?:         string;
   ts?:                string;
@@ -768,6 +771,7 @@ export interface MessageFile {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;

diff --git a/packages/web-api/src/response/ChatScheduleMessageResponse.ts b/packages/web-api/src/response/ChatScheduleMessageResponse.ts
@@ -358,6 +358,7 @@ export interface File {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;

diff --git a/packages/web-api/src/response/ChatUpdateResponse.ts b/packages/web-api/src/response/ChatUpdateResponse.ts
@@ -370,6 +370,7 @@ export interface BlockFile {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;
@@ -580,6 +581,7 @@ export interface FileElement {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;
@@ -672,11 +674,13 @@ export interface Shares {
 export interface Private {
   access?:            string;
   channel_name?:      string;
+  date_last_shared?:  number;
   latest_reply?:      string;
   reply_count?:       number;
   reply_users?:       string[];
   reply_users_count?: number;
   share_user_id?:     string;
+  source?:            string;
   team_id?:           string;
   thread_ts?:         string;
   ts?:                string;

diff --git a/packages/web-api/src/response/ConversationsHistoryResponse.ts b/packages/web-api/src/response/ConversationsHistoryResponse.ts
@@ -442,6 +442,7 @@ export interface FileElement {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;
@@ -564,11 +565,13 @@ export interface Shares {
 export interface Private {
   access?:            string;
   channel_name?:      string;
+  date_last_shared?:  number;
   latest_reply?:      string;
   reply_count?:       number;
   reply_users?:       string[];
   reply_users_count?: number;
   share_user_id?:     string;
+  source?:            string;
   team_id?:           string;
   thread_ts?:         string;
   ts?:                string;
@@ -784,6 +787,7 @@ export interface BlockFile {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;

diff --git a/packages/web-api/src/response/ConversationsOpenResponse.ts b/packages/web-api/src/response/ConversationsOpenResponse.ts
@@ -374,6 +374,7 @@ export interface File {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;

diff --git a/packages/web-api/src/response/ConversationsRepliesResponse.ts b/packages/web-api/src/response/ConversationsRepliesResponse.ts
@@ -431,6 +431,7 @@ export interface FileElement {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;
@@ -553,11 +554,13 @@ export interface Shares {
 export interface Private {
   access?:            string;
   channel_name?:      string;
+  date_last_shared?:  number;
   latest_reply?:      string;
   reply_count?:       number;
   reply_users?:       string[];
   reply_users_count?: number;
   share_user_id?:     string;
+  source?:            string;
   team_id?:           string;
   thread_ts?:         string;
   ts?:                string;
@@ -773,6 +776,7 @@ export interface BlockFile {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;

diff --git a/packages/web-api/src/response/FilesCompleteUploadExternalResponse.ts b/packages/web-api/src/response/FilesCompleteUploadExternalResponse.ts
@@ -18,6 +18,7 @@ export type FilesCompleteUploadExternalResponse = WebAPICallResult & {
 };
 
 export interface File {
+  alt_txt?:              string;
   channels?:             string[];
   comments_count?:       number;
   created?:              number;
@@ -41,6 +42,8 @@ export interface File {
   mimetype?:             string;
   mode?:                 string;
   name?:                 string;
+  original_h?:           number;
+  original_w?:           number;
   permalink?:            string;
   permalink_public?:     string;
   pretty_type?:          string;
@@ -50,6 +53,13 @@ export interface File {
   public_url_shared?:    boolean;
   shares?:               Shares;
   size?:                 number;
+  thumb_160?:            string;
+  thumb_360?:            string;
+  thumb_360_h?:          number;
+  thumb_360_w?:          number;
+  thumb_64?:             string;
+  thumb_80?:             string;
+  thumb_tiny?:           string;
   timestamp?:            number;
   title?:                string;
   url_private?:          string;
@@ -65,10 +75,13 @@ export interface Shares {
 
 export interface Public {
   channel_name?:      string;
+  latest_reply?:      string;
   reply_count?:       number;
   reply_users?:       string[];
   reply_users_count?: number;
   share_user_id?:     string;
+  source?:            string;
   team_id?:           string;
+  thread_ts?:         string;
   ts?:                string;
 }
diff --git a/packages/web-api/src/response/FilesRemoteAddResponse.ts b/packages/web-api/src/response/FilesRemoteAddResponse.ts
@@ -102,6 +102,7 @@ export interface File {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;
@@ -224,11 +225,13 @@ export interface Shares {
 export interface Private {
   access?:            string;
   channel_name?:      string;
+  date_last_shared?:  number;
   latest_reply?:      string;
   reply_count?:       number;
   reply_users?:       string[];
   reply_users_count?: number;
   share_user_id?:     string;
+  source?:            string;
   team_id?:           string;
   thread_ts?:         string;
   ts?:                string;

diff --git a/packages/web-api/src/response/FilesRemoteInfoResponse.ts b/packages/web-api/src/response/FilesRemoteInfoResponse.ts
@@ -102,6 +102,7 @@ export interface File {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;
@@ -224,11 +225,13 @@ export interface Shares {
 export interface Private {
   access?:            string;
   channel_name?:      string;
+  date_last_shared?:  number;
   latest_reply?:      string;
   reply_count?:       number;
   reply_users?:       string[];
   reply_users_count?: number;
   share_user_id?:     string;
+  source?:            string;
   team_id?:           string;
   thread_ts?:         string;
   ts?:                string;

diff --git a/packages/web-api/src/response/FilesRemoteShareResponse.ts b/packages/web-api/src/response/FilesRemoteShareResponse.ts
@@ -102,6 +102,7 @@ export interface File {
   source_team?:                             string;
   subject?:                                 string;
   subtype?:                                 string;
+  team_pref_version_history_enabled?:       boolean;
   teams_shared_with?:                       any[];
   template_conversion_ts?:                  number;
   template_description?:                    string;
@@ -224,11 +225,13 @@ export interface Shares {
 export interface Private {
   access?:            string;
   channel_name?:      string;
+  date_last_shared?:  number;
   latest_reply?:      string;
   reply_count?:       number;
   reply_users?:       string[];
   reply_users_count?: number;
   share_user_id?:     string;
+  source?:            string;
   team_id?:           string;
   thread_ts?:         string;
   ts?:                string;