Update web-api response data types (as of 2025-05-17) (#2244)

Author: seratch

packages/web-api/src/types/response/AdminConversationsSearchResponse.ts

@@ -87,6 +87,7 @@ export interface Properties {
   huddles_restricted?: boolean;
   posting_restricted_to?: PostingRestrictedTo;
   tabs?: Tab[];
+  tabz?: Tab[];
   threads_restricted_to?: ThreadsRestrictedTo;
 }
 

packages/web-api/src/types/response/AdminFunctionsPermissionsLookupResponse.ts

@@ -11,6 +11,7 @@ import type { WebAPICallResult } from '../../WebClient';
 export type AdminFunctionsPermissionsLookupResponse = WebAPICallResult & {
   error?: string;
   errors?: Errors;
+  metadata?: { [key: string]: Errors };
   needed?: string;
   ok?: boolean;
   permissions?: { [key: string]: Permission };

packages/web-api/src/types/response/AppsManifestCreateResponse.ts

@@ -18,6 +18,8 @@ export type AppsManifestCreateResponse = WebAPICallResult & {
   ok?: boolean;
   provided?: string;
   response_metadata?: ResponseMetadata;
+  team_domain?: string;
+  team_id?: string;
 };
 
 export interface Credentials {

packages/web-api/src/types/response/ChatPostMessageResponse.ts

@@ -66,6 +66,7 @@ export interface AssistantAppThreadBlock {
   dispatch_action?: boolean;
   element?: Accessory;
   elements?: Accessory[];
+  expand?: boolean;
   external_id?: string;
   fallback?: string;
   fields?: DescriptionElement[];
@@ -109,7 +110,7 @@ export interface Accessory {
   default_to_current_conversation?: boolean;
   elements?: AccessoryElement[];
   fallback?: string;
-  filter?: Filter;
+  filter?: AccessoryFilter;
   focus_on_load?: boolean;
   image_bytes?: number;
   image_height?: number;
@@ -138,7 +139,7 @@ export interface Accessory {
   style?: string;
   text?: DescriptionElement;
   timezone?: string;
-  type?: string;
+  type?: AccessoryType;
   url?: string;
   value?: string;
   workflow?: Workflow;
@@ -170,7 +171,7 @@ export interface AccessoryElement {
   indent?: number;
   offset?: number;
   style?: string;
-  type?: FluffyType;
+  type?: AccessoryType;
 }
 
 export interface PurpleElement {
@@ -216,14 +217,33 @@ export enum PurpleType {
   Usergroup = 'usergroup',
 }
 
-export enum FluffyType {
+export enum AccessoryType {
+  Button = 'button',
+  ChannelsSelect = 'channels_select',
+  Checkboxes = 'checkboxes',
+  ConversationsSelect = 'conversations_select',
+  Datepicker = 'datepicker',
+  Datetimepicker = 'datetimepicker',
+  ExternalSelect = 'external_select',
+  Image = 'image',
+  MultiChannelsSelect = 'multi_channels_select',
+  MultiConversationsSelect = 'multi_conversations_select',
+  MultiExternalSelect = 'multi_external_select',
+  MultiStaticSelect = 'multi_static_select',
+  MultiUsersSelect = 'multi_users_select',
+  Overflow = 'overflow',
+  RadioButtons = 'radio_buttons',
   RichTextList = 'rich_text_list',
   RichTextPreformatted = 'rich_text_preformatted',
   RichTextQuote = 'rich_text_quote',
   RichTextSection = 'rich_text_section',
+  StaticSelect = 'static_select',
+  Timepicker = 'timepicker',
+  UsersSelect = 'users_select',
+  WorkflowButton = 'workflow_button',
 }
 
-export interface Filter {
+export interface AccessoryFilter {
   exclude_bot_users?: boolean;
   exclude_external_shared_channels?: boolean;
   include?: any[];
@@ -313,9 +333,10 @@ export interface FileElement {
   app_id?: string;
   app_name?: string;
   attachments?: any[];
-  blocks?: FileBlock[];
+  blocks?: DescriptionBlockElement[];
   bot_id?: string;
   can_toggle_canvas_lock?: boolean;
+  canvas_printing_enabled?: boolean;
   canvas_template_mode?: string;
   cc?: Cc[];
   channel_actions_count?: number;
@@ -362,6 +383,7 @@ export interface FileElement {
   lines?: number;
   lines_more?: number;
   linked_channel_id?: string;
+  list_csv_download_url?: string;
   list_limits?: ListLimits;
   list_metadata?: ListMetadata;
   media_display_type?: string;
@@ -454,7 +476,7 @@ export interface FileElement {
   thumb_video_w?: number;
   timestamp?: number;
   title?: string;
-  title_blocks?: FileBlock[];
+  title_blocks?: DescriptionBlockElement[];
   to?: Cc[];
   transcription?: Transcription;
   update_notification?: number;
@@ -468,7 +490,7 @@ export interface FileElement {
   vtt?: string;
 }
 
-export interface FileBlock {
+export interface DescriptionBlockElement {
   accessory?: Accessory;
   alt_text?: string;
   app_collaborators?: string[];
@@ -480,6 +502,7 @@ export interface FileBlock {
   description?: DescriptionElement | string;
   developer_trace_id?: string;
   elements?: Accessory[];
+  expand?: boolean;
   fallback?: string;
   fields?: DescriptionElement[];
   function_trigger_id?: string;
@@ -555,6 +578,7 @@ export interface InitialComment {
 export interface ListLimits {
   column_count?: number;
   column_count_limit?: number;
+  max_attachments_per_cell?: number;
   over_column_maximum?: boolean;
   over_row_maximum?: boolean;
   over_view_maximum?: boolean;
@@ -567,6 +591,7 @@ export interface ListLimits {
 export interface ListMetadata {
   creation_source?: CreationSource;
   description?: string;
+  description_blocks?: DescriptionBlockElement[];
   icon?: string;
   icon_team_id?: string;
   icon_url?: string;
@@ -633,11 +658,15 @@ export interface View {
   columns?: Column[];
   created_by?: string;
   date_created?: number;
+  default_view_key?: string;
+  filters?: FilterElement[];
+  grouping?: Grouping;
   id?: string;
   is_all_items_view?: boolean;
   is_locked?: boolean;
   name?: string;
   position?: string;
+  show_completed_items?: boolean;
   stick_column_left?: boolean;
   type?: string;
 }
@@ -650,6 +679,19 @@ export interface Column {
   width?: number;
 }
 
+export interface FilterElement {
+  column_id?: string;
+  key?: string;
+  operator?: string;
+  typed_values?: any[];
+  values?: string[];
+}
+
+export interface Grouping {
+  group_by?: string;
+  group_by_column_id?: string;
+}
+
 export interface MediaProgress {
   duration_ms?: number;
   max_offset_ms?: number;
@@ -711,8 +753,9 @@ export interface Attachment {
   author_link?: string;
   author_name?: string;
   author_subname?: string;
-  blocks?: FileBlock[];
+  blocks?: DescriptionBlockElement[];
   bot_id?: string;
+  bot_team_id?: string;
   callback_id?: string;
   channel_id?: string;
   channel_name?: string;
@@ -783,7 +826,7 @@ export interface Action {
   selected_options?: SelectedOptionElement[];
   style?: string;
   text?: string;
-  type?: string;
+  type?: AccessoryType;
   url?: string;
   value?: string;
 }
@@ -888,7 +931,7 @@ export interface FieldMessage {
   app_id?: string;
   assistant_app_thread?: AssistantAppThread;
   attachments?: any[];
-  blocks?: FileBlock[];
+  blocks?: DescriptionBlockElement[];
   bot_id?: string;
   bot_link?: string;
   bot_profile?: BotProfile;
@@ -1005,6 +1048,7 @@ export interface MessageFile {
   blocks?: any[];
   bot_id?: string;
   can_toggle_canvas_lock?: boolean;
+  canvas_printing_enabled?: boolean;
   canvas_template_mode?: string;
   cc?: any[];
   channel_actions_count?: number;
@@ -1051,6 +1095,7 @@ export interface MessageFile {
   lines?: number;
   lines_more?: number;
   linked_channel_id?: string;
+  list_csv_download_url?: string;
   list_limits?: ListLimits;
   list_metadata?: ListMetadata;
   media_display_type?: string;
@@ -1183,6 +1228,7 @@ export interface Room {
   display_id?: string;
   external_unique_id?: string;
   has_ended?: boolean;
+  huddle_link?: string;
   id?: string;
   is_dm_call?: boolean;
   is_prewarmed?: boolean;
@@ -1199,12 +1245,21 @@ export interface Room {
   participants_screenshare_off?: string[];
   participants_screenshare_on?: string[];
   pending_invitees?: EventPayload;
+  recording?: Recording;
   thread_root_ts?: string;
   was_accepted?: boolean;
   was_missed?: boolean;
   was_rejected?: boolean;
 }
 
+export interface Recording {
+  can_record_summary?: string;
+  notetaking?: boolean;
+  summary?: boolean;
+  summary_status?: string;
+  transcript?: boolean;
+}
+
 export interface PurpleRoot {
   bot_id?: string;
   bot_profile?: BotProfile;