@slack/bolt 3.9.0 → 3.11.1

package/dist/types/events/base-events.d.ts

@@ -2,10 +2,11 @@ import { View, MessageAttachment, KnownBlock, Block } from '@slack/types';
 import { MessageEvent as AllMessageEvents } from './message-events';
 /**
  * All known event types in Slack's Events API
+ * Please refer to https://api.slack.com/events for more details
  *
  * This is a discriminated union. The discriminant is the `type` property.
  */
-export declare type SlackEvent = AppRequestedEvent | AppHomeOpenedEvent | AppMentionEvent | AppUninstalledEvent | CallRejectedEvent | ChannelArchiveEvent | ChannelCreatedEvent | ChannelDeletedEvent | ChannelHistoryChangedEvent | ChannelLeftEvent | ChannelRenameEvent | ChannelSharedEvent | ChannelUnarchiveEvent | ChannelUnsharedEvent | DNDUpdatedEvent | DNDUpdatedUserEvent | EmailDomainChangedEvent | EmojiChangedEvent | FileChangeEvent | FileCommentDeletedEvent | FileCreatedEvent | FileDeletedEvent | FilePublicEvent | FileSharedEvent | FileUnsharedEvent | GridMigrationFinishedEvent | GridMigrationStartedEvent | GroupArchiveEvent | GroupCloseEvent | GroupDeletedEvent | GroupHistoryChangedEvent | GroupLeftEvent | GroupOpenEvent | GroupRenameEvent | GroupUnarchiveEvent | IMCloseEvent | IMCreatedEvent | IMHistoryChangedEvent | IMOpenEvent | InviteRequestedEvent | LinkSharedEvent | MemberJoinedChannelEvent | MemberLeftChannelEvent | MessageEvent | PinAddedEvent | PinRemovedEvent | ReactionAddedEvent | ReactionRemovedEvent | SharedChannelInviteReceived | SharedChannelInviteAccepted | SharedChannelInviteApproved | SharedChannelInviteDeclined | StarAddedEvent | StarRemovedEvent | SubteamCreated | SubteamMembersChanged | SubteamSelfAddedEvent | SubteamSelfRemovedEvent | SubteamUpdatedEvent | TeamDomainChangedEvent | TeamJoinEvent | TeamRenameEvent | TokensRevokedEvent | UserChangeEvent | WorkflowDeletedEvent | WorkflowPublishedEvent | WorkflowUnpublishedEvent | WorkflowStepDeletedEvent | WorkflowStepExecuteEvent;
+export declare type SlackEvent = AppRequestedEvent | AppHomeOpenedEvent | AppMentionEvent | AppRateLimitedEvent | AppUninstalledEvent | CallRejectedEvent | ChannelArchiveEvent | ChannelCreatedEvent | ChannelDeletedEvent | ChannelHistoryChangedEvent | ChannelIDChangedEvent | ChannelLeftEvent | ChannelRenameEvent | ChannelSharedEvent | ChannelUnarchiveEvent | ChannelUnsharedEvent | DNDUpdatedEvent | DNDUpdatedUserEvent | EmailDomainChangedEvent | EmojiChangedEvent | FileChangeEvent | FileCommentDeletedEvent | FileCreatedEvent | FileDeletedEvent | FilePublicEvent | FileSharedEvent | FileUnsharedEvent | GridMigrationFinishedEvent | GridMigrationStartedEvent | GroupArchiveEvent | GroupCloseEvent | GroupDeletedEvent | GroupHistoryChangedEvent | GroupLeftEvent | GroupOpenEvent | GroupRenameEvent | GroupUnarchiveEvent | IMCloseEvent | IMCreatedEvent | IMHistoryChangedEvent | IMOpenEvent | InviteRequestedEvent | LinkSharedEvent | MemberJoinedChannelEvent | MemberLeftChannelEvent | MessageEvent | PinAddedEvent | PinRemovedEvent | ReactionAddedEvent | ReactionRemovedEvent | SharedChannelInviteReceived | SharedChannelInviteAccepted | SharedChannelInviteApproved | SharedChannelInviteDeclined | StarAddedEvent | StarRemovedEvent | SubteamCreated | SubteamMembersChanged | SubteamSelfAddedEvent | SubteamSelfRemovedEvent | SubteamUpdatedEvent | TeamAccessGrantedEvent | TeamAccessRevokedEvent | TeamDomainChangedEvent | TeamJoinEvent | TeamRenameEvent | TokensRevokedEvent | UserChangeEvent | UserHuddleChangedEvent | UserProfileChangedEvent | UserStatusChangedEvent | WorkflowDeletedEvent | WorkflowPublishedEvent | WorkflowUnpublishedEvent | WorkflowStepDeletedEvent | WorkflowStepExecuteEvent;
 export declare type EventTypePattern = string | RegExp;
 /**
  * Any event in Slack's Events API
@@ -17,6 +18,17 @@ export declare type EventTypePattern = string | RegExp;
 export interface BasicSlackEvent<Type extends string = string> {
     type: Type;
 }
+interface BotProfile {
+    id: string;
+    name: string;
+    app_id: string;
+    team_id: string;
+    icons: {
+        [size: string]: string;
+    };
+    updated: number;
+    deleted: boolean;
+}
 export interface AppRequestedEvent {
     type: 'app_requested';
     app_request: {
@@ -32,6 +44,19 @@ export interface AppRequestedEvent {
             is_app_directory_approved: boolean;
             is_internal: boolean;
             additional_info: string;
+            icons?: {
+                image_32?: string;
+                image_36?: string;
+                image_48?: string;
+                image_64?: string;
+                image_72?: string;
+                image_96?: string;
+                image_128?: string;
+                image_192?: string;
+                image_512?: string;
+                image_1024?: string;
+                image_original?: string;
+            };
         };
     };
     previous_resolution: {
@@ -43,6 +68,7 @@ export interface AppRequestedEvent {
             token_type: 'bot' | 'user' | 'app' | null;
         };
     } | null;
+    is_user_app_collaborator: boolean;
     user: {
         id: string;
         name: string;
@@ -74,7 +100,9 @@ export interface AppMentionEvent {
     type: 'app_mention';
     subtype?: string;
     bot_id?: string;
+    bot_profile?: BotProfile;
     username: string;
+    team?: string;
     user?: string;
     text: string;
     attachments?: MessageAttachment[];
@@ -86,7 +114,14 @@ export interface AppMentionEvent {
     ts: string;
     channel: string;
     event_ts: string;
-    thread_ts: string;
+    thread_ts?: string;
+}
+export interface AppRateLimitedEvent {
+    type: 'app_rate_limited';
+    token: string;
+    team_id: string;
+    minute_rate_limited: number;
+    api_app_id: string;
 }
 export interface AppUninstalledEvent {
     type: 'app_uninstalled';
@@ -102,14 +137,20 @@ export interface ChannelArchiveEvent {
     type: 'channel_archive';
     channel: string;
     user: string;
+    is_moved?: number;
+    event_ts: string;
 }
 export interface ChannelCreatedEvent {
     type: 'channel_created';
     channel: {
         id: string;
+        is_channel: boolean;
         name: string;
+        name_normalized: string;
         created: number;
         creator: string;
+        is_shared: boolean;
+        is_org_shared: boolean;
     };
 }
 export interface ChannelDeletedEvent {
@@ -131,14 +172,20 @@ export interface ChannelIDChangedEvent {
 export interface ChannelLeftEvent {
     type: 'channel_left';
     channel: string;
+    actor_id: string;
+    event_ts: string;
 }
 export interface ChannelRenameEvent {
     type: 'channel_rename';
     channel: {
         id: string;
         name: string;
+        name_normalized: string;
         created: number;
+        is_channel: boolean;
+        is_mpim: boolean;
     };
+    event_ts: string;
 }
 export interface ChannelSharedEvent {
     type: 'channel_shared';
@@ -150,6 +197,7 @@ export interface ChannelUnarchiveEvent {
     type: 'channel_unarchive';
     channel: string;
     user: string;
+    event_ts: string;
 }
 export interface ChannelUnsharedEvent {
     type: 'channel_unshared';
@@ -169,6 +217,7 @@ export interface DNDUpdatedEvent {
         snooze_endtime: number;
         snooze_remaining: number;
     };
+    event_ts: string;
 }
 export interface DNDUpdatedUserEvent {
     type: 'dnd_updated_user';
@@ -178,6 +227,7 @@ export interface DNDUpdatedUserEvent {
         next_dnd_start_ts: number;
         next_dnd_end_ts: number;
     };
+    event_ts: string;
 }
 export interface EmailDomainChangedEvent {
     type: 'email_domain_changed';
@@ -186,10 +236,12 @@ export interface EmailDomainChangedEvent {
 }
 export interface EmojiChangedEvent {
     type: 'emoji_changed';
-    subtype: 'add' | 'remove';
+    subtype: 'add' | 'remove' | 'rename';
     names?: string[];
     name?: string;
     value?: string;
+    old_name?: string;
+    new_name?: string;
     event_ts: string;
 }
 export interface FileChangeEvent {
@@ -210,35 +262,46 @@ export interface FileCommentDeletedEvent {
 export interface FileCreatedEvent {
     type: 'file_created';
     file_id: string;
+    user_id: string;
     file: {
         id: string;
     };
+    event_ts: string;
 }
 export interface FileDeletedEvent {
     type: 'file_deleted';
     file_id: string;
+    channel_ids?: string[];
     event_ts: string;
 }
 export interface FilePublicEvent {
     type: 'file_public';
     file_id: string;
+    user_id: string;
     file: {
         id: string;
     };
+    event_ts: string;
 }
 export interface FileSharedEvent {
     type: 'file_shared';
     file_id: string;
+    user_id: string;
     file: {
         id: string;
     };
+    channel_id: string;
+    event_ts: string;
 }
 export interface FileUnsharedEvent {
     type: 'file_unshared';
     file_id: string;
+    user_id: string;
     file: {
         id: string;
     };
+    channel_id: string;
+    event_ts: string;
 }
 export interface GridMigrationFinishedEvent {
     type: 'grid_migration_finished';
@@ -251,6 +314,9 @@ export interface GridMigrationStartedEvent {
 export interface GroupArchiveEvent {
     type: 'group_archive';
     channel: string;
+    user: string;
+    is_moved: number;
+    event_ts: string;
 }
 export interface GroupCloseEvent {
     type: 'group_close';
@@ -260,6 +326,9 @@ export interface GroupCloseEvent {
 export interface GroupDeletedEvent {
     type: 'group_deleted';
     channel: string;
+    date_deleted: number;
+    actor_id: string;
+    event_ts: string;
 }
 export interface GroupHistoryChangedEvent {
     type: 'group_history_changed';
@@ -270,6 +339,8 @@ export interface GroupHistoryChangedEvent {
 export interface GroupLeftEvent {
     type: 'group_left';
     channel: string;
+    actor_id: string;
+    event_ts: string;
 }
 export interface GroupOpenEvent {
     type: 'group_open';
@@ -281,17 +352,24 @@ export interface GroupRenameEvent {
     channel: {
         id: string;
         name: string;
+        name_normalized: string;
         created: number;
+        is_channel: boolean;
+        is_mpim: boolean;
     };
+    event_ts: string;
 }
 export interface GroupUnarchiveEvent {
     type: 'group_unarchive';
     channel: string;
+    actor_id: string;
+    event_ts: string;
 }
 export interface IMCloseEvent {
     type: 'im_close';
     user: string;
     channel: string;
+    event_ts: string;
 }
 export interface IMCreatedEvent {
     type: 'im_created';
@@ -310,6 +388,7 @@ export interface IMOpenEvent {
     type: 'im_open';
     user: string;
     channel: string;
+    event_ts: string;
 }
 export interface InviteRequestedEvent {
     type: 'invite_requested';
@@ -337,11 +416,13 @@ export interface LinkSharedEvent {
     user: string;
     message_ts: string;
     thread_ts?: string;
-    event_ts: string;
     links: {
         domain: string;
         url: string;
     }[];
+    unfurl_id?: string;
+    source?: string;
+    event_ts: string;
 }
 export interface MemberJoinedChannelEvent {
     type: 'member_joined_channel';
@@ -350,6 +431,7 @@ export interface MemberJoinedChannelEvent {
     channel_type: string;
     team: string;
     inviter?: string;
+    event_ts: string;
 }
 export interface MemberLeftChannelEvent {
     type: 'member_left_channel';
@@ -357,6 +439,7 @@ export interface MemberLeftChannelEvent {
     channel: string;
     channel_type: string;
     team: string;
+    event_ts: string;
 }
 export declare type MessageEvent = AllMessageEvents;
 export interface PinAddedEvent {
@@ -364,12 +447,27 @@ export interface PinAddedEvent {
     user: string;
     channel_id: string;
     item: Record<string, unknown>;
+    item_user: string;
+    pin_count: string;
+    pinned_info: {
+        channel: string;
+        pinned_by: string;
+        pinned_ts: number;
+    };
+    event_ts: string;
 }
 export interface PinRemovedEvent {
     type: 'pin_removed';
     user: string;
     channel_id: string;
     item: Record<string, unknown>;
+    item_user: string;
+    pin_count: string;
+    pinned_info: {
+        channel: string;
+        pinned_by: string;
+        pinned_ts: number;
+    };
     has_pins: boolean;
     event_ts: string;
 }
@@ -492,12 +590,34 @@ export interface StarRemovedEvent {
     item: Record<string, unknown>;
     event_ts: string;
 }
+interface Subteam {
+    id: string;
+    team_id?: string;
+    is_usergroup: boolean;
+    is_subteam: boolean;
+    name: string;
+    description?: string;
+    handle: string;
+    is_external: boolean;
+    date_create: number;
+    date_update?: number;
+    date_delete?: number;
+    auto_provision: boolean;
+    enterprise_subteam_id?: string;
+    created_by: string;
+    updated_by?: string;
+    prefs?: {
+        channels?: string[];
+        groups?: string[];
+    };
+    users: string[];
+    user_count: number;
+    channel_count?: number;
+}
 export interface SubteamCreated {
     type: 'subteam_created';
-    subteam: {
-        id: string;
-        created_by: string;
-    };
+    subteam: Subteam;
+    event_ts: string;
 }
 export interface SubteamMembersChanged {
     type: 'subteam_members_changed';
@@ -505,25 +625,36 @@ export interface SubteamMembersChanged {
     team_id: string;
     date_previous_update: number;
     date_update: number;
-    added_users: string[];
-    added_users_count: number;
-    removed_users: string[];
-    removed_users_count: number;
+    added_users?: string[];
+    added_users_count?: number;
+    removed_users?: string[];
+    removed_users_count?: number;
+    event_ts: string;
 }
 export interface SubteamSelfAddedEvent {
     type: 'subteam_self_added';
     subteam_id: string;
+    event_ts: string;
 }
 export interface SubteamSelfRemovedEvent {
     type: 'subteam_self_removed';
     subteam_id: string;
+    event_ts: string;
 }
 export interface SubteamUpdatedEvent {
     type: 'subteam_updated';
-    subteam: {
-        id: string;
-        created_by: string;
-    };
+    subteam: Subteam;
+    event_ts: string;
+}
+export interface TeamAccessGrantedEvent {
+    type: 'team_access_granted';
+    team_ids: string[];
+    event_ts: string;
+}
+export interface TeamAccessRevokedEvent {
+    type: 'team_access_revoked';
+    team_ids: string[];
+    event_ts: string;
 }
 export interface TeamDomainChangedEvent {
     type: 'team_domain_changed';
@@ -543,10 +674,15 @@ export interface TeamRenameEvent {
 export interface TokensRevokedEvent {
     type: 'tokens_revoked';
     tokens: {
-        oauth: string[];
-        bot: string[];
+        oauth?: string[];
+        bot?: string[];
     };
 }
+export interface StatusEmojiDisplayInfo {
+    emoji_name?: string;
+    display_alias?: string;
+    display_url?: string;
+}
 export interface UserChangeEvent {
     type: 'user_change';
     user: {
@@ -570,11 +706,14 @@ export interface UserChangeEvent {
             status_text: string;
             status_text_canonical: string;
             status_emoji: string;
+            status_emoji_display_info: StatusEmojiDisplayInfo[];
             status_expiration: number;
             avatar_hash: string;
+            huddle_state?: string;
+            huddle_state_expiration_ts?: number;
             first_name: string;
             last_name: string;
-            email: string;
+            email?: string;
             image_original?: string;
             is_custom_image?: boolean;
             image_24: string;
@@ -599,12 +738,13 @@ export interface UserChangeEvent {
         is_ultra_restricted: boolean;
         is_bot: boolean;
         is_stranger?: boolean;
-        updated: string;
+        updated: number;
         is_email_confirmed: boolean;
         is_app_user: boolean;
         is_invited_user?: boolean;
         has_2fa?: boolean;
         locale: string;
+        presence?: string;
         enterprise_user?: {
             id: string;
             enterprise_id: string;
@@ -613,7 +753,245 @@ export interface UserChangeEvent {
             is_owner: boolean;
             teams: string[];
         };
+        two_factor_type?: string;
+        has_files?: boolean;
+        is_workflow_bot?: boolean;
+        who_can_share_contact_card: string;
     };
+    cache_ts: number;
+    event_ts: string;
+}
+export interface UserHuddleChangedEvent {
+    type: 'user_huddle_changed';
+    user: {
+        id: string;
+        team_id: string;
+        name: string;
+        deleted: boolean;
+        color: string;
+        real_name: string;
+        tz: string;
+        tz_label: string;
+        tz_offset: number;
+        profile: {
+            title: string;
+            phone: string;
+            skype: string;
+            real_name: string;
+            real_name_normalized: string;
+            display_name: string;
+            display_name_normalized: string;
+            status_text: string;
+            status_text_canonical: string;
+            status_emoji: string;
+            status_emoji_display_info: StatusEmojiDisplayInfo[];
+            status_expiration: number;
+            avatar_hash: string;
+            huddle_state: string;
+            huddle_state_expiration_ts: number;
+            first_name: string;
+            last_name: string;
+            email?: string;
+            image_original?: string;
+            is_custom_image?: boolean;
+            image_24: string;
+            image_32: string;
+            image_48: string;
+            image_72: string;
+            image_192: string;
+            image_512: string;
+            image_1024?: string;
+            team: string;
+            fields: {
+                [key: string]: {
+                    value: string;
+                    alt: string;
+                };
+            } | [] | null;
+        };
+        is_admin: boolean;
+        is_owner: boolean;
+        is_primary_owner: boolean;
+        is_restricted: boolean;
+        is_ultra_restricted: boolean;
+        is_bot: boolean;
+        is_stranger?: boolean;
+        updated: number;
+        is_email_confirmed: boolean;
+        is_app_user: boolean;
+        is_invited_user?: boolean;
+        has_2fa?: boolean;
+        locale: string;
+        presence?: string;
+        enterprise_user?: {
+            id: string;
+            enterprise_id: string;
+            enterprise_name: string;
+            is_admin: boolean;
+            is_owner: boolean;
+            teams: string[];
+        };
+        two_factor_type?: string;
+        has_files?: boolean;
+        is_workflow_bot?: boolean;
+        who_can_share_contact_card: string;
+    };
+    cache_ts: number;
+    event_ts: string;
+}
+export interface UserProfileChangedEvent {
+    type: 'user_profile_changed';
+    user: {
+        id: string;
+        team_id: string;
+        name: string;
+        deleted: boolean;
+        color: string;
+        real_name: string;
+        tz: string;
+        tz_label: string;
+        tz_offset: number;
+        profile: {
+            title: string;
+            phone: string;
+            skype: string;
+            real_name: string;
+            real_name_normalized: string;
+            display_name: string;
+            display_name_normalized: string;
+            status_text: string;
+            status_text_canonical: string;
+            status_emoji: string;
+            status_emoji_display_info: StatusEmojiDisplayInfo[];
+            status_expiration: number;
+            avatar_hash: string;
+            huddle_state: string;
+            huddle_state_expiration_ts: number;
+            first_name: string;
+            last_name: string;
+            email?: string;
+            image_original?: string;
+            is_custom_image?: boolean;
+            image_24: string;
+            image_32: string;
+            image_48: string;
+            image_72: string;
+            image_192: string;
+            image_512: string;
+            image_1024?: string;
+            team: string;
+            fields: {
+                [key: string]: {
+                    value: string;
+                    alt: string;
+                };
+            } | [] | null;
+        };
+        is_admin: boolean;
+        is_owner: boolean;
+        is_primary_owner: boolean;
+        is_restricted: boolean;
+        is_ultra_restricted: boolean;
+        is_bot: boolean;
+        is_stranger?: boolean;
+        updated: number;
+        is_email_confirmed: boolean;
+        is_app_user: boolean;
+        is_invited_user?: boolean;
+        has_2fa?: boolean;
+        locale: string;
+        presence?: string;
+        enterprise_user?: {
+            id: string;
+            enterprise_id: string;
+            enterprise_name: string;
+            is_admin: boolean;
+            is_owner: boolean;
+            teams: string[];
+        };
+        two_factor_type?: string;
+        has_files?: boolean;
+        is_workflow_bot?: boolean;
+        who_can_share_contact_card: string;
+    };
+    cache_ts: number;
+    event_ts: string;
+}
+export interface UserStatusChangedEvent {
+    type: 'user_status_changed';
+    user: {
+        id: string;
+        team_id: string;
+        name: string;
+        deleted: boolean;
+        color: string;
+        real_name: string;
+        tz: string;
+        tz_label: string;
+        tz_offset: number;
+        profile: {
+            title: string;
+            phone: string;
+            skype: string;
+            real_name: string;
+            real_name_normalized: string;
+            display_name: string;
+            display_name_normalized: string;
+            status_text: string;
+            status_text_canonical: string;
+            status_emoji: string;
+            status_emoji_display_info: StatusEmojiDisplayInfo[];
+            status_expiration: number;
+            avatar_hash: string;
+            first_name: string;
+            last_name: string;
+            email?: string;
+            image_original?: string;
+            is_custom_image?: boolean;
+            image_24: string;
+            image_32: string;
+            image_48: string;
+            image_72: string;
+            image_192: string;
+            image_512: string;
+            image_1024?: string;
+            team: string;
+            fields: {
+                [key: string]: {
+                    value: string;
+                    alt: string;
+                };
+            } | [] | null;
+        };
+        is_admin: boolean;
+        is_owner: boolean;
+        is_primary_owner: boolean;
+        is_restricted: boolean;
+        is_ultra_restricted: boolean;
+        is_bot: boolean;
+        is_stranger?: boolean;
+        updated: number;
+        is_email_confirmed: boolean;
+        is_app_user: boolean;
+        is_invited_user?: boolean;
+        has_2fa?: boolean;
+        locale: string;
+        presence?: string;
+        enterprise_user?: {
+            id: string;
+            enterprise_id: string;
+            enterprise_name: string;
+            is_admin: boolean;
+            is_owner: boolean;
+            teams: string[];
+        };
+        two_factor_type?: string;
+        has_files?: boolean;
+        is_workflow_bot?: boolean;
+        who_can_share_contact_card: string;
+    };
+    cache_ts: number;
+    event_ts: string;
 }
 export interface WorkflowDeletedEvent {
     type: 'workflow_deleted';
@@ -696,4 +1074,5 @@ export interface WorkflowStepExecuteEvent {
     };
     event_ts: string;
 }
+export {};
 //# sourceMappingURL=base-events.d.ts.map