feat(web-api): generate Web API response types

slackapi · Oct 30, 2024 · 8dcdb22 · 8dcdb22
1 parent 1be7a9e
commit 8dcdb22
Show file tree

Hide file tree

Showing 25 changed files with 216 additions and 20 deletions.
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,4 @@ tmp/
 *.bk
 
 .DS_Store
+.nyc_output/
diff --git a/packages/web-api/src/types/response/ChatPostMessageResponse.ts b/packages/web-api/src/types/response/ChatPostMessageResponse.ts
@@ -355,6 +355,7 @@ export interface FileElement {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -652,6 +653,7 @@ export interface Column {
 export interface MediaProgress {
   duration_ms?: number;
   max_offset_ms?: number;
+  media_watched?: boolean;
   offset_ms?: number;
 }
 
@@ -691,9 +693,15 @@ export interface Private {
 
 export interface Transcription {
   locale?: string;
+  preview?: TranscriptionPreview;
   status?: string;
 }
 
+export interface TranscriptionPreview {
+  content?: string;
+  has_more?: boolean;
+}
+
 export interface Attachment {
   actions?: Action[];
   app_id?: string;
@@ -745,7 +753,7 @@ export interface Attachment {
   msg_subtype?: string;
   original_url?: string;
   pretext?: string;
-  preview?: Preview;
+  preview?: AttachmentPreview;
   service_icon?: string;
   service_name?: string;
   service_url?: string;
@@ -1036,6 +1044,7 @@ export interface MessageFile {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -1265,7 +1274,7 @@ export interface AttachmentMetadata {
   thumb_tiny?: string;
 }
 
-export interface Preview {
+export interface AttachmentPreview {
   can_remove?: boolean;
   icon_url?: string;
   subtitle?: DescriptionElement;

diff --git a/packages/web-api/src/types/response/ChatScheduleMessageResponse.ts b/packages/web-api/src/types/response/ChatScheduleMessageResponse.ts
@@ -346,6 +346,7 @@ export interface File {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -643,6 +644,7 @@ export interface Column {
 export interface MediaProgress {
   duration_ms?: number;
   max_offset_ms?: number;
+  media_watched?: boolean;
   offset_ms?: number;
 }
 
@@ -682,9 +684,15 @@ export interface Private {
 
 export interface Transcription {
   locale?: string;
+  preview?: Preview;
   status?: string;
 }
 
+export interface Preview {
+  content?: string;
+  has_more?: boolean;
+}
+
 export interface BotProfile {
   app_id?: string;
   deleted?: boolean;

diff --git a/packages/web-api/src/types/response/ChatUpdateResponse.ts b/packages/web-api/src/types/response/ChatUpdateResponse.ts
@@ -351,6 +351,7 @@ export interface File {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -648,6 +649,7 @@ export interface Column {
 export interface MediaProgress {
   duration_ms?: number;
   max_offset_ms?: number;
+  media_watched?: boolean;
   offset_ms?: number;
 }
 
@@ -687,9 +689,15 @@ export interface Private {
 
 export interface Transcription {
   locale?: string;
+  preview?: Preview;
   status?: string;
 }
 
+export interface Preview {
+  content?: string;
+  has_more?: boolean;
+}
+
 export interface BotProfile {
   app_id?: string;
   deleted?: boolean;

diff --git a/packages/web-api/src/types/response/ConversationsHistoryResponse.ts b/packages/web-api/src/types/response/ConversationsHistoryResponse.ts
@@ -371,6 +371,7 @@ export interface FileElement {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -668,6 +669,7 @@ export interface Column {
 export interface MediaProgress {
   duration_ms?: number;
   max_offset_ms?: number;
+  media_watched?: boolean;
   offset_ms?: number;
 }
 
@@ -707,9 +709,15 @@ export interface Private {
 
 export interface Transcription {
   locale?: string;
+  preview?: TranscriptionPreview;
   status?: string;
 }
 
+export interface TranscriptionPreview {
+  content?: string;
+  has_more?: boolean;
+}
+
 export interface Attachment {
   actions?: Action[];
   app_id?: string;
@@ -761,7 +769,7 @@ export interface Attachment {
   msg_subtype?: string;
   original_url?: string;
   pretext?: string;
-  preview?: Preview;
+  preview?: AttachmentPreview;
   service_icon?: string;
   service_name?: string;
   service_url?: string;
@@ -1052,6 +1060,7 @@ export interface PurpleFile {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -1278,7 +1287,7 @@ export interface AttachmentMetadata {
   thumb_tiny?: string;
 }
 
-export interface Preview {
+export interface AttachmentPreview {
   can_remove?: boolean;
   icon_url?: string;
   subtitle?: DescriptionElement;

diff --git a/packages/web-api/src/types/response/ConversationsOpenResponse.ts b/packages/web-api/src/types/response/ConversationsOpenResponse.ts
@@ -362,6 +362,7 @@ export interface File {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -659,6 +660,7 @@ export interface Column {
 export interface MediaProgress {
   duration_ms?: number;
   max_offset_ms?: number;
+  media_watched?: boolean;
   offset_ms?: number;
 }
 
@@ -698,9 +700,15 @@ export interface Private {
 
 export interface Transcription {
   locale?: string;
+  preview?: Preview;
   status?: string;
 }
 
+export interface Preview {
+  content?: string;
+  has_more?: boolean;
+}
+
 export interface BotProfile {
   app_id?: string;
   deleted?: boolean;

diff --git a/packages/web-api/src/types/response/ConversationsRepliesResponse.ts b/packages/web-api/src/types/response/ConversationsRepliesResponse.ts
@@ -360,6 +360,7 @@ export interface FileElement {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -657,6 +658,7 @@ export interface Column {
 export interface MediaProgress {
   duration_ms?: number;
   max_offset_ms?: number;
+  media_watched?: boolean;
   offset_ms?: number;
 }
 
@@ -696,9 +698,15 @@ export interface Private {
 
 export interface Transcription {
   locale?: string;
+  preview?: TranscriptionPreview;
   status?: string;
 }
 
+export interface TranscriptionPreview {
+  content?: string;
+  has_more?: boolean;
+}
+
 export interface Attachment {
   actions?: Action[];
   app_id?: string;
@@ -750,7 +758,7 @@ export interface Attachment {
   msg_subtype?: string;
   original_url?: string;
   pretext?: string;
-  preview?: Preview;
+  preview?: AttachmentPreview;
   service_icon?: string;
   service_name?: string;
   service_url?: string;
@@ -1041,6 +1049,7 @@ export interface PurpleFile {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -1267,7 +1276,7 @@ export interface AttachmentMetadata {
   thumb_tiny?: string;
 }
 
-export interface Preview {
+export interface AttachmentPreview {
   can_remove?: boolean;
   icon_url?: string;
   subtitle?: DescriptionElement;

diff --git a/packages/web-api/src/types/response/ConversationsRequestSharedInviteListResponse.ts b/packages/web-api/src/types/response/ConversationsRequestSharedInviteListResponse.ts
@@ -9,8 +9,11 @@
 
 import type { WebAPICallResult } from '../../WebClient';
 export type ConversationsRequestSharedInviteListResponse = WebAPICallResult & {
+  error?: string;
   invite_requests?: InviteRequest[];
+  needed?: string;
   ok?: boolean;
+  provided?: string;
 };
 
 export interface InviteRequest {
@@ -32,8 +35,8 @@ export interface Channel {
   is_im?: boolean;
   is_private?: boolean;
   name?: string;
-  pending_connections?: any[];
-  previous_connections?: any[];
+  pending_connections?: Connection[];
+  previous_connections?: Connection[];
 }
 
 export interface Connection {

diff --git a/packages/web-api/src/types/response/FilesInfoResponse.ts b/packages/web-api/src/types/response/FilesInfoResponse.ts
@@ -79,6 +79,7 @@ export interface File {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -316,6 +317,7 @@ export interface Column {
 export interface MediaProgress {
   duration_ms?: number;
   max_offset_ms?: number;
+  media_watched?: boolean;
   offset_ms?: number;
 }
 
@@ -547,9 +549,15 @@ export interface CustomizableInputParameter {
 
 export interface Transcription {
   locale?: string;
+  preview?: Preview;
   status?: string;
 }
 
+export interface Preview {
+  content?: string;
+  has_more?: boolean;
+}
+
 export interface Paging {
   count?: number;
   page?: number;

diff --git a/packages/web-api/src/types/response/FilesListResponse.ts b/packages/web-api/src/types/response/FilesListResponse.ts
@@ -63,6 +63,7 @@ export interface File {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -310,6 +311,7 @@ export interface Column {
 export interface MediaProgress {
   duration_ms?: number;
   max_offset_ms?: number;
+  media_watched?: boolean;
   offset_ms?: number;
 }
 
@@ -541,9 +543,15 @@ export interface CustomizableInputParameter {
 
 export interface Transcription {
   locale?: string;
+  preview?: Preview;
   status?: string;
 }
 
+export interface Preview {
+  content?: string;
+  has_more?: boolean;
+}
+
 export interface Paging {
   count?: number;
   page?: number;

diff --git a/packages/web-api/src/types/response/FilesRemoteAddResponse.ts b/packages/web-api/src/types/response/FilesRemoteAddResponse.ts
@@ -62,6 +62,7 @@ export interface File {
   is_channel_space?: boolean;
   is_external?: boolean;
   is_public?: boolean;
+  is_restricted_sharing_enabled?: boolean;
   is_starred?: boolean;
   last_editor?: string;
   last_read?: number;
@@ -309,6 +310,7 @@ export interface Column {
 export interface MediaProgress {
   duration_ms?: number;
   max_offset_ms?: number;
+  media_watched?: boolean;
   offset_ms?: number;
 }
 
@@ -540,5 +542,11 @@ export interface CustomizableInputParameter {
 
 export interface Transcription {
   locale?: string;
+  preview?: Preview;
   status?: string;
 }
+
+export interface Preview {
+  content?: string;
+  has_more?: boolean;
+}