@slack/bolt 4.0.0-nextGen.9 → 4.0.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (218) hide show
  1. package/README.md +22 -16
  2. package/dist/App.d.ts +39 -80
  3. package/dist/App.d.ts.map +1 -1
  4. package/dist/App.js +223 -234
  5. package/dist/App.js.map +1 -1
  6. package/dist/CustomFunction.d.ts +58 -0
  7. package/dist/CustomFunction.d.ts.map +1 -0
  8. package/dist/CustomFunction.js +144 -0
  9. package/dist/CustomFunction.js.map +1 -0
  10. package/dist/WorkflowStep.d.ts +89 -36
  11. package/dist/WorkflowStep.d.ts.map +1 -1
  12. package/dist/WorkflowStep.js +29 -8
  13. package/dist/WorkflowStep.js.map +1 -1
  14. package/dist/conversation-store.d.ts +1 -1
  15. package/dist/conversation-store.d.ts.map +1 -1
  16. package/dist/conversation-store.js +3 -3
  17. package/dist/conversation-store.js.map +1 -1
  18. package/dist/errors.d.ts +12 -7
  19. package/dist/errors.d.ts.map +1 -1
  20. package/dist/errors.js +42 -53
  21. package/dist/errors.js.map +1 -1
  22. package/dist/helpers.d.ts +16 -3
  23. package/dist/helpers.d.ts.map +1 -1
  24. package/dist/helpers.js +43 -11
  25. package/dist/helpers.js.map +1 -1
  26. package/dist/index.d.ts +4 -5
  27. package/dist/index.d.ts.map +1 -1
  28. package/dist/index.js +16 -11
  29. package/dist/index.js.map +1 -1
  30. package/dist/middleware/builtin.d.ts +20 -23
  31. package/dist/middleware/builtin.d.ts.map +1 -1
  32. package/dist/middleware/builtin.js +93 -110
  33. package/dist/middleware/builtin.js.map +1 -1
  34. package/dist/middleware/process.d.ts +3 -3
  35. package/dist/middleware/process.d.ts.map +1 -1
  36. package/dist/middleware/process.js +1 -1
  37. package/dist/middleware/process.js.map +1 -1
  38. package/dist/receivers/AwsLambdaReceiver.d.ts +77 -16
  39. package/dist/receivers/AwsLambdaReceiver.d.ts.map +1 -1
  40. package/dist/receivers/AwsLambdaReceiver.js +53 -25
  41. package/dist/receivers/AwsLambdaReceiver.js.map +1 -1
  42. package/dist/receivers/BufferedIncomingMessage.d.ts +2 -1
  43. package/dist/receivers/BufferedIncomingMessage.d.ts.map +1 -1
  44. package/dist/receivers/ExpressReceiver.d.ts +13 -13
  45. package/dist/receivers/ExpressReceiver.d.ts.map +1 -1
  46. package/dist/receivers/ExpressReceiver.js +70 -70
  47. package/dist/receivers/ExpressReceiver.js.map +1 -1
  48. package/dist/receivers/HTTPModuleFunctions.d.ts +18 -20
  49. package/dist/receivers/HTTPModuleFunctions.d.ts.map +1 -1
  50. package/dist/receivers/HTTPModuleFunctions.js +189 -171
  51. package/dist/receivers/HTTPModuleFunctions.js.map +1 -1
  52. package/dist/receivers/HTTPReceiver.d.ts +14 -14
  53. package/dist/receivers/HTTPReceiver.d.ts.map +1 -1
  54. package/dist/receivers/HTTPReceiver.js +102 -48
  55. package/dist/receivers/HTTPReceiver.js.map +1 -1
  56. package/dist/receivers/HTTPResponseAck.d.ts +7 -7
  57. package/dist/receivers/HTTPResponseAck.d.ts.map +1 -1
  58. package/dist/receivers/HTTPResponseAck.js +37 -5
  59. package/dist/receivers/HTTPResponseAck.js.map +1 -1
  60. package/dist/receivers/ParamsIncomingMessage.d.ts +14 -0
  61. package/dist/receivers/ParamsIncomingMessage.d.ts.map +1 -0
  62. package/dist/{types/block-suggestion/index.js → receivers/ParamsIncomingMessage.js} +1 -1
  63. package/dist/receivers/ParamsIncomingMessage.js.map +1 -0
  64. package/dist/receivers/SocketModeFunctions.d.ts +3 -5
  65. package/dist/receivers/SocketModeFunctions.d.ts.map +1 -1
  66. package/dist/receivers/SocketModeFunctions.js +14 -23
  67. package/dist/receivers/SocketModeFunctions.js.map +1 -1
  68. package/dist/receivers/SocketModeReceiver.d.ts +10 -9
  69. package/dist/receivers/SocketModeReceiver.d.ts.map +1 -1
  70. package/dist/receivers/SocketModeReceiver.js +41 -25
  71. package/dist/receivers/SocketModeReceiver.js.map +1 -1
  72. package/dist/receivers/custom-routes.d.ts +4 -3
  73. package/dist/receivers/custom-routes.d.ts.map +1 -1
  74. package/dist/receivers/custom-routes.js +10 -9
  75. package/dist/receivers/custom-routes.js.map +1 -1
  76. package/dist/receivers/verify-redirect-opts.d.ts +1 -1
  77. package/dist/receivers/verify-redirect-opts.d.ts.map +1 -1
  78. package/dist/receivers/verify-redirect-opts.js +3 -3
  79. package/dist/receivers/verify-redirect-opts.js.map +1 -1
  80. package/dist/receivers/verify-request.d.ts +1 -12
  81. package/dist/receivers/verify-request.d.ts.map +1 -1
  82. package/dist/receivers/verify-request.js +4 -18
  83. package/dist/receivers/verify-request.js.map +1 -1
  84. package/dist/types/actions/block-action.d.ts +41 -22
  85. package/dist/types/actions/block-action.d.ts.map +1 -1
  86. package/dist/types/actions/dialog-action.d.ts +0 -4
  87. package/dist/types/actions/dialog-action.d.ts.map +1 -1
  88. package/dist/types/actions/index.d.ts +25 -11
  89. package/dist/types/actions/index.d.ts.map +1 -1
  90. package/dist/types/actions/index.js +1 -0
  91. package/dist/types/actions/index.js.map +1 -1
  92. package/dist/types/actions/interactive-message.d.ts +3 -3
  93. package/dist/types/actions/interactive-message.d.ts.map +1 -1
  94. package/dist/types/actions/workflow-step-edit.d.ts +7 -7
  95. package/dist/types/actions/workflow-step-edit.d.ts.map +1 -1
  96. package/dist/types/command/index.d.ts +1 -2
  97. package/dist/types/command/index.d.ts.map +1 -1
  98. package/dist/types/events/index.d.ts +26 -24
  99. package/dist/types/events/index.d.ts.map +1 -1
  100. package/dist/types/events/index.js +4 -15
  101. package/dist/types/events/index.js.map +1 -1
  102. package/dist/types/index.d.ts +0 -2
  103. package/dist/types/index.d.ts.map +1 -1
  104. package/dist/types/index.js +0 -2
  105. package/dist/types/index.js.map +1 -1
  106. package/dist/types/middleware.d.ts +30 -30
  107. package/dist/types/middleware.d.ts.map +1 -1
  108. package/dist/types/middleware.js +3 -0
  109. package/dist/types/middleware.js.map +1 -1
  110. package/dist/types/options/index.d.ts +23 -59
  111. package/dist/types/options/index.d.ts.map +1 -1
  112. package/dist/types/receiver.d.ts +3 -3
  113. package/dist/types/receiver.d.ts.map +1 -1
  114. package/dist/types/shortcuts/global-shortcut.d.ts.map +1 -1
  115. package/dist/types/shortcuts/index.d.ts +14 -9
  116. package/dist/types/shortcuts/index.d.ts.map +1 -1
  117. package/dist/types/shortcuts/message-shortcut.d.ts.map +1 -1
  118. package/dist/types/utilities.d.ts +23 -13
  119. package/dist/types/utilities.d.ts.map +1 -1
  120. package/dist/types/utilities.js +7 -0
  121. package/dist/types/utilities.js.map +1 -1
  122. package/dist/types/view/index.d.ts +148 -12
  123. package/dist/types/view/index.d.ts.map +1 -1
  124. package/package.json +32 -61
  125. package/dist/Manifest.d.ts +0 -5
  126. package/dist/Manifest.d.ts.map +0 -1
  127. package/dist/Manifest.js +0 -16
  128. package/dist/Manifest.js.map +0 -1
  129. package/dist/SlackFunction.d.ts +0 -190
  130. package/dist/SlackFunction.d.ts.map +0 -1
  131. package/dist/SlackFunction.js +0 -441
  132. package/dist/SlackFunction.js.map +0 -1
  133. package/dist/Subscription.d.ts +0 -61
  134. package/dist/Subscription.d.ts.map +0 -1
  135. package/dist/Subscription.js +0 -169
  136. package/dist/Subscription.js.map +0 -1
  137. package/dist/cli/check-update.d.ts +0 -3
  138. package/dist/cli/check-update.d.ts.map +0 -1
  139. package/dist/cli/check-update.js +0 -13
  140. package/dist/cli/check-update.js.map +0 -1
  141. package/dist/cli/get-hooks.d.ts +0 -2
  142. package/dist/cli/get-hooks.d.ts.map +0 -1
  143. package/dist/cli/get-hooks.js +0 -19
  144. package/dist/cli/get-hooks.js.map +0 -1
  145. package/dist/cli/get-manifest.d.ts +0 -3
  146. package/dist/cli/get-manifest.d.ts.map +0 -1
  147. package/dist/cli/get-manifest.js +0 -16
  148. package/dist/cli/get-manifest.js.map +0 -1
  149. package/dist/cli/hook-utils/get-check-update-data.d.ts +0 -49
  150. package/dist/cli/hook-utils/get-check-update-data.d.ts.map +0 -1
  151. package/dist/cli/hook-utils/get-check-update-data.js +0 -252
  152. package/dist/cli/hook-utils/get-check-update-data.js.map +0 -1
  153. package/dist/cli/hook-utils/get-check-update-data.spec.d.ts +0 -2
  154. package/dist/cli/hook-utils/get-check-update-data.spec.d.ts.map +0 -1
  155. package/dist/cli/hook-utils/get-check-update-data.spec.js +0 -266
  156. package/dist/cli/hook-utils/get-check-update-data.spec.js.map +0 -1
  157. package/dist/cli/hook-utils/get-manifest-data.d.ts +0 -7
  158. package/dist/cli/hook-utils/get-manifest-data.d.ts.map +0 -1
  159. package/dist/cli/hook-utils/get-manifest-data.js +0 -30
  160. package/dist/cli/hook-utils/get-manifest-data.js.map +0 -1
  161. package/dist/cli/hook-utils/get-manifest-data.spec.d.ts +0 -2
  162. package/dist/cli/hook-utils/get-manifest-data.spec.d.ts.map +0 -1
  163. package/dist/cli/hook-utils/get-manifest-data.spec.js +0 -113
  164. package/dist/cli/hook-utils/get-manifest-data.spec.js.map +0 -1
  165. package/dist/cli/hook-utils/manifest.d.ts +0 -30
  166. package/dist/cli/hook-utils/manifest.d.ts.map +0 -1
  167. package/dist/cli/hook-utils/manifest.js +0 -103
  168. package/dist/cli/hook-utils/manifest.js.map +0 -1
  169. package/dist/cli/hook-utils/manifest.spec.d.ts +0 -2
  170. package/dist/cli/hook-utils/manifest.spec.d.ts.map +0 -1
  171. package/dist/cli/hook-utils/manifest.spec.js +0 -79
  172. package/dist/cli/hook-utils/manifest.spec.js.map +0 -1
  173. package/dist/cli/run.d.ts +0 -2
  174. package/dist/cli/run.d.ts.map +0 -1
  175. package/dist/cli/run.js +0 -37
  176. package/dist/cli/run.js.map +0 -1
  177. package/dist/cli/start.d.ts +0 -3
  178. package/dist/cli/start.d.ts.map +0 -1
  179. package/dist/cli/start.js +0 -40
  180. package/dist/cli/start.js.map +0 -1
  181. package/dist/receivers/http-utils.d.ts +0 -5
  182. package/dist/receivers/http-utils.d.ts.map +0 -1
  183. package/dist/receivers/http-utils.js +0 -19
  184. package/dist/receivers/http-utils.js.map +0 -1
  185. package/dist/receivers/render-html-for-install-path.d.ts +0 -3
  186. package/dist/receivers/render-html-for-install-path.d.ts.map +0 -1
  187. package/dist/receivers/render-html-for-install-path.js +0 -32
  188. package/dist/receivers/render-html-for-install-path.js.map +0 -1
  189. package/dist/types/block-suggestion/index.d.ts +0 -97
  190. package/dist/types/block-suggestion/index.d.ts.map +0 -1
  191. package/dist/types/block-suggestion/index.js.map +0 -1
  192. package/dist/types/events/base-events.d.ts +0 -1135
  193. package/dist/types/events/base-events.d.ts.map +0 -1
  194. package/dist/types/events/base-events.js +0 -5
  195. package/dist/types/events/base-events.js.map +0 -1
  196. package/dist/types/events/message-events.d.ts +0 -348
  197. package/dist/types/events/message-events.d.ts.map +0 -1
  198. package/dist/types/events/message-events.js +0 -3
  199. package/dist/types/events/message-events.js.map +0 -1
  200. package/dist/types/functions/index.d.ts +0 -26
  201. package/dist/types/functions/index.d.ts.map +0 -1
  202. package/dist/types/functions/index.js +0 -3
  203. package/dist/types/functions/index.js.map +0 -1
  204. package/dist/types/helpers.d.ts +0 -17
  205. package/dist/types/helpers.d.ts.map +0 -1
  206. package/dist/types/helpers.js +0 -3
  207. package/dist/types/helpers.js.map +0 -1
  208. package/dist/types/subscription/index.d.ts +0 -80
  209. package/dist/types/subscription/index.d.ts.map +0 -1
  210. package/dist/types/subscription/index.js +0 -3
  211. package/dist/types/subscription/index.js.map +0 -1
  212. package/src/cli/check-update.js +0 -13
  213. package/src/cli/get-hooks.js +0 -17
  214. package/src/cli/get-manifest.js +0 -16
  215. package/src/cli/hook-utils/get-check-update-data.js +0 -292
  216. package/src/cli/hook-utils/get-manifest-data.js +0 -39
  217. package/src/cli/hook-utils/manifest.js +0 -108
  218. package/src/cli/start.js +0 -43
@@ -1,1135 +0,0 @@
1
- import { View, MessageAttachment, KnownBlock, Block } from '@slack/types';
2
- import { MessageEvent as AllMessageEvents, MessageMetadataEvent as AllMessageMetadataEvents } from './message-events';
3
- /**
4
- * All known event types in Slack's Events API
5
- * Please refer to https://api.slack.com/events for more details
6
- *
7
- * This is a discriminated union. The discriminant is the `type` property.
8
- */
9
- 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 | FunctionExecutedEvent | GridMigrationFinishedEvent | GridMigrationStartedEvent | GroupArchiveEvent | GroupCloseEvent | GroupDeletedEvent | GroupHistoryChangedEvent | GroupLeftEvent | GroupOpenEvent | GroupRenameEvent | GroupUnarchiveEvent | IMCloseEvent | IMCreatedEvent | IMHistoryChangedEvent | IMOpenEvent | InviteRequestedEvent | LinkSharedEvent | MemberJoinedChannelEvent | MemberLeftChannelEvent | MessageEvent | MessageMetadataEvent | 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;
10
- export declare type EventTypePattern = string | RegExp;
11
- /**
12
- * Any event in Slack's Events API
13
- *
14
- * This type is used to represent events that aren't known ahead of time. Each of the known event types also implement
15
- * this interface. That condition isn't enforced, since we're not interested in factoring out common properties from the
16
- * known event types.
17
- */
18
- export interface BasicSlackEvent<Type extends string = string> {
19
- type: Type;
20
- }
21
- interface BotProfile {
22
- id: string;
23
- name: string;
24
- app_id: string;
25
- team_id: string;
26
- icons: {
27
- [size: string]: string;
28
- };
29
- updated: number;
30
- deleted: boolean;
31
- }
32
- export interface AppRequestedEvent {
33
- type: 'app_requested';
34
- app_request: {
35
- id: string;
36
- app: {
37
- id: string;
38
- name: string;
39
- description: string;
40
- help_url: string;
41
- privacy_policy_url: string;
42
- app_homepage_url: string;
43
- app_directory_url: string;
44
- is_app_directory_approved: boolean;
45
- is_internal: boolean;
46
- additional_info: string;
47
- icons?: {
48
- image_32?: string;
49
- image_36?: string;
50
- image_48?: string;
51
- image_64?: string;
52
- image_72?: string;
53
- image_96?: string;
54
- image_128?: string;
55
- image_192?: string;
56
- image_512?: string;
57
- image_1024?: string;
58
- image_original?: string;
59
- };
60
- };
61
- };
62
- previous_resolution: {
63
- status: 'approved' | 'restricted';
64
- scopes: {
65
- name: string;
66
- description: string;
67
- is_dangerous: boolean;
68
- token_type: 'bot' | 'user' | 'app' | null;
69
- };
70
- } | null;
71
- is_user_app_collaborator: boolean;
72
- user: {
73
- id: string;
74
- name: string;
75
- email: string;
76
- };
77
- team: {
78
- id: string;
79
- name: string;
80
- domain: string;
81
- };
82
- scopes: {
83
- name: string;
84
- description: string;
85
- is_dangerous: boolean;
86
- token_type: 'bot' | 'user' | 'app' | null;
87
- };
88
- message: string;
89
- date_created: number;
90
- }
91
- export interface AppHomeOpenedEvent {
92
- type: 'app_home_opened';
93
- user: string;
94
- channel: string;
95
- tab?: 'home' | 'messages';
96
- view?: View;
97
- event_ts: string;
98
- }
99
- export interface AppMentionEvent {
100
- type: 'app_mention';
101
- subtype?: string;
102
- bot_id?: string;
103
- bot_profile?: BotProfile;
104
- username: string;
105
- team?: string;
106
- user?: string;
107
- text: string;
108
- attachments?: MessageAttachment[];
109
- blocks?: (KnownBlock | Block)[];
110
- edited?: {
111
- user: string;
112
- ts: string;
113
- };
114
- ts: string;
115
- channel: string;
116
- event_ts: string;
117
- thread_ts?: string;
118
- }
119
- export interface AppRateLimitedEvent {
120
- type: 'app_rate_limited';
121
- token: string;
122
- team_id: string;
123
- minute_rate_limited: number;
124
- api_app_id: string;
125
- }
126
- export interface AppUninstalledEvent {
127
- type: 'app_uninstalled';
128
- }
129
- export interface CallRejectedEvent {
130
- type: 'call_rejected';
131
- call_id: string;
132
- user_id: string;
133
- channel_id: string;
134
- external_unique_id: string;
135
- }
136
- export interface ChannelArchiveEvent {
137
- type: 'channel_archive';
138
- channel: string;
139
- user: string;
140
- is_moved?: number;
141
- event_ts: string;
142
- }
143
- export interface ChannelCreatedEvent {
144
- type: 'channel_created';
145
- channel: {
146
- id: string;
147
- is_channel: boolean;
148
- name: string;
149
- name_normalized: string;
150
- created: number;
151
- creator: string;
152
- is_shared: boolean;
153
- is_org_shared: boolean;
154
- };
155
- }
156
- export interface ChannelDeletedEvent {
157
- type: 'channel_deleted';
158
- channel: string;
159
- }
160
- export interface ChannelHistoryChangedEvent {
161
- type: 'channel_history_changed';
162
- latest: string;
163
- ts: string;
164
- event_ts: string;
165
- }
166
- export interface ChannelIDChangedEvent {
167
- type: 'channel_id_changed';
168
- old_channel_id: string;
169
- new_channel_id: string;
170
- event_ts: string;
171
- }
172
- export interface ChannelLeftEvent {
173
- type: 'channel_left';
174
- channel: string;
175
- actor_id: string;
176
- event_ts: string;
177
- }
178
- export interface ChannelRenameEvent {
179
- type: 'channel_rename';
180
- channel: {
181
- id: string;
182
- name: string;
183
- name_normalized: string;
184
- created: number;
185
- is_channel: boolean;
186
- is_mpim: boolean;
187
- };
188
- event_ts: string;
189
- }
190
- export interface ChannelSharedEvent {
191
- type: 'channel_shared';
192
- connected_team_id: string;
193
- channel: string;
194
- event_ts: string;
195
- }
196
- export interface ChannelUnarchiveEvent {
197
- type: 'channel_unarchive';
198
- channel: string;
199
- user: string;
200
- event_ts: string;
201
- }
202
- export interface ChannelUnsharedEvent {
203
- type: 'channel_unshared';
204
- previously_connected_team_id: string;
205
- channel: string;
206
- is_ext_shared: boolean;
207
- event_ts: string;
208
- }
209
- export interface DNDUpdatedEvent {
210
- type: 'dnd_updated';
211
- user: string;
212
- dnd_status: {
213
- dnd_enabled: boolean;
214
- next_dnd_start_ts: number;
215
- next_dnd_end_ts: number;
216
- snooze_enabled: boolean;
217
- snooze_endtime: number;
218
- snooze_remaining: number;
219
- };
220
- event_ts: string;
221
- }
222
- export interface DNDUpdatedUserEvent {
223
- type: 'dnd_updated_user';
224
- user: string;
225
- dnd_status: {
226
- dnd_enabled: boolean;
227
- next_dnd_start_ts: number;
228
- next_dnd_end_ts: number;
229
- };
230
- event_ts: string;
231
- }
232
- export interface EmailDomainChangedEvent {
233
- type: 'email_domain_changed';
234
- email_domain: string;
235
- event_ts: string;
236
- }
237
- export interface EmojiChangedEvent {
238
- type: 'emoji_changed';
239
- subtype: 'add' | 'remove' | 'rename';
240
- names?: string[];
241
- name?: string;
242
- value?: string;
243
- old_name?: string;
244
- new_name?: string;
245
- event_ts: string;
246
- }
247
- export interface FileChangeEvent {
248
- type: 'file_change';
249
- file_id: string;
250
- file: {
251
- id: string;
252
- };
253
- }
254
- export interface FileCommentDeletedEvent {
255
- type: 'file_comment_deleted';
256
- comment: string;
257
- file_id: string;
258
- file: {
259
- id: string;
260
- };
261
- }
262
- export interface FileCreatedEvent {
263
- type: 'file_created';
264
- file_id: string;
265
- user_id: string;
266
- file: {
267
- id: string;
268
- };
269
- event_ts: string;
270
- }
271
- export interface FileDeletedEvent {
272
- type: 'file_deleted';
273
- file_id: string;
274
- channel_ids?: string[];
275
- event_ts: string;
276
- }
277
- export interface FilePublicEvent {
278
- type: 'file_public';
279
- file_id: string;
280
- user_id: string;
281
- file: {
282
- id: string;
283
- };
284
- event_ts: string;
285
- }
286
- export interface FileSharedEvent {
287
- type: 'file_shared';
288
- file_id: string;
289
- user_id: string;
290
- file: {
291
- id: string;
292
- };
293
- channel_id: string;
294
- event_ts: string;
295
- }
296
- export interface FileUnsharedEvent {
297
- type: 'file_unshared';
298
- file_id: string;
299
- user_id: string;
300
- file: {
301
- id: string;
302
- };
303
- channel_id: string;
304
- event_ts: string;
305
- }
306
- export interface FunctionParams {
307
- type?: string;
308
- name?: string;
309
- description?: string;
310
- title?: string;
311
- is_required?: boolean;
312
- }
313
- export interface FunctionInputValues {
314
- [key: string]: unknown;
315
- }
316
- export declare type FunctionOutputValues = FunctionInputValues;
317
- export interface FunctionExecutedEvent {
318
- type: 'function_executed';
319
- function: {
320
- id: string;
321
- callback_id: string;
322
- title: string;
323
- description: string;
324
- type: string;
325
- input_parameters: FunctionParams[];
326
- output_parameters: FunctionParams[];
327
- app_id: string;
328
- date_updated: number;
329
- };
330
- function_execution_id: string;
331
- inputs: FunctionInputValues;
332
- workflow_token: string;
333
- event_ts: string;
334
- }
335
- export interface GridMigrationFinishedEvent {
336
- type: 'grid_migration_finished';
337
- enterprise_id: string;
338
- }
339
- export interface GridMigrationStartedEvent {
340
- type: 'grid_migration_started';
341
- enterprise_id: string;
342
- }
343
- export interface GroupArchiveEvent {
344
- type: 'group_archive';
345
- channel: string;
346
- user: string;
347
- is_moved: number;
348
- event_ts: string;
349
- }
350
- export interface GroupCloseEvent {
351
- type: 'group_close';
352
- user: string;
353
- channel: string;
354
- }
355
- export interface GroupDeletedEvent {
356
- type: 'group_deleted';
357
- channel: string;
358
- date_deleted: number;
359
- actor_id: string;
360
- event_ts: string;
361
- }
362
- export interface GroupHistoryChangedEvent {
363
- type: 'group_history_changed';
364
- latest: string;
365
- ts: string;
366
- event_ts: string;
367
- }
368
- export interface GroupLeftEvent {
369
- type: 'group_left';
370
- channel: string;
371
- actor_id: string;
372
- event_ts: string;
373
- }
374
- export interface GroupOpenEvent {
375
- type: 'group_open';
376
- user: string;
377
- channel: string;
378
- }
379
- export interface GroupRenameEvent {
380
- type: 'group_rename';
381
- channel: {
382
- id: string;
383
- name: string;
384
- name_normalized: string;
385
- created: number;
386
- is_channel: boolean;
387
- is_mpim: boolean;
388
- };
389
- event_ts: string;
390
- }
391
- export interface GroupUnarchiveEvent {
392
- type: 'group_unarchive';
393
- channel: string;
394
- actor_id: string;
395
- event_ts: string;
396
- }
397
- export interface IMCloseEvent {
398
- type: 'im_close';
399
- user: string;
400
- channel: string;
401
- event_ts: string;
402
- }
403
- export interface IMCreatedEvent {
404
- type: 'im_created';
405
- user: string;
406
- channel: {
407
- id: string;
408
- };
409
- }
410
- export interface IMHistoryChangedEvent {
411
- type: 'im_history_changed';
412
- latest: string;
413
- ts: string;
414
- event_ts: string;
415
- }
416
- export interface IMOpenEvent {
417
- type: 'im_open';
418
- user: string;
419
- channel: string;
420
- event_ts: string;
421
- }
422
- export interface InviteRequestedEvent {
423
- type: 'invite_requested';
424
- invite_request: {
425
- id: string;
426
- email: string;
427
- date_created: number;
428
- requester_ids: string[];
429
- channel_ids: string[];
430
- invite_type: 'restricted' | 'ultra_restricted' | 'full_member';
431
- real_name: string;
432
- date_expire: number;
433
- request_reason: string;
434
- team: {
435
- id: string;
436
- name: string;
437
- domain: string;
438
- };
439
- };
440
- }
441
- export interface LinkSharedEvent {
442
- type: 'link_shared';
443
- channel: string;
444
- is_bot_user_member: boolean;
445
- user: string;
446
- message_ts: string;
447
- thread_ts?: string;
448
- links: {
449
- domain: string;
450
- url: string;
451
- }[];
452
- unfurl_id?: string;
453
- source?: string;
454
- event_ts: string;
455
- }
456
- export interface MemberJoinedChannelEvent {
457
- type: 'member_joined_channel';
458
- user: string;
459
- channel: string;
460
- channel_type: string;
461
- team: string;
462
- inviter?: string;
463
- event_ts: string;
464
- }
465
- export interface MemberLeftChannelEvent {
466
- type: 'member_left_channel';
467
- user: string;
468
- channel: string;
469
- channel_type: string;
470
- team: string;
471
- event_ts: string;
472
- }
473
- export declare type MessageEvent = AllMessageEvents;
474
- export declare type MessageMetadataEvent = AllMessageMetadataEvents;
475
- export interface PinnedMessageItem {
476
- client_msg_id?: string;
477
- type: string;
478
- app_id?: string;
479
- team?: string;
480
- user: string;
481
- bot_id?: string;
482
- bot_profile?: BotProfile;
483
- text?: string;
484
- attachments?: MessageAttachment[];
485
- blocks?: (KnownBlock | Block)[];
486
- pinned_to?: string[];
487
- permalink: string;
488
- }
489
- export interface PinnedFileItem {
490
- id: string;
491
- }
492
- export interface PinnedItem {
493
- type: string;
494
- channel: string;
495
- created_by: string;
496
- created: number;
497
- message?: PinnedMessageItem;
498
- file?: PinnedFileItem;
499
- }
500
- export interface PinAddedEvent {
501
- type: 'pin_added';
502
- user: string;
503
- channel_id: string;
504
- item: PinnedItem;
505
- item_user: string;
506
- pin_count: string;
507
- pinned_info: {
508
- channel: string;
509
- pinned_by: string;
510
- pinned_ts: number;
511
- };
512
- event_ts: string;
513
- }
514
- export interface PinRemovedEvent {
515
- type: 'pin_removed';
516
- user: string;
517
- channel_id: string;
518
- item: PinnedItem;
519
- item_user: string;
520
- pin_count: string;
521
- pinned_info: {
522
- channel: string;
523
- pinned_by: string;
524
- pinned_ts: number;
525
- };
526
- has_pins: boolean;
527
- event_ts: string;
528
- }
529
- export interface ReactionMessageItem {
530
- type: 'message';
531
- channel: string;
532
- ts: string;
533
- }
534
- export interface ReactionFileItem {
535
- type: 'file';
536
- channel: string;
537
- file: string;
538
- }
539
- export interface ReactionFileCommentItem {
540
- type: 'file_comment';
541
- channel: string;
542
- file_comment: string;
543
- file: string;
544
- }
545
- export interface ReactionAddedEvent {
546
- type: 'reaction_added';
547
- user: string;
548
- reaction: string;
549
- item_user: string;
550
- item: ReactionMessageItem | ReactionFileItem | ReactionFileCommentItem;
551
- event_ts: string;
552
- }
553
- export interface ReactionRemovedEvent {
554
- type: 'reaction_removed';
555
- user: string;
556
- reaction: string;
557
- item_user: string;
558
- item: ReactionMessageItem | ReactionFileItem | ReactionFileCommentItem;
559
- event_ts: string;
560
- }
561
- export interface SharedChannelTeamItem {
562
- id: string;
563
- name: string;
564
- icon: Record<string, unknown>;
565
- is_verified: boolean;
566
- domain: string;
567
- date_created: number;
568
- }
569
- export interface SharedChannelUserItem {
570
- id: string;
571
- team_id: string;
572
- name: string;
573
- updated: number;
574
- profile: {
575
- real_name: string;
576
- display_name: string;
577
- real_name_normalized: string;
578
- display_name_normalized: string;
579
- team: string;
580
- avatar_hash: string;
581
- email: string;
582
- image_24: string;
583
- image_32: string;
584
- image_48: string;
585
- image_72: string;
586
- image_192: string;
587
- image_512: string;
588
- };
589
- }
590
- export interface SharedChannelInviteItem {
591
- id: string;
592
- date_created: number;
593
- date_invalid: number;
594
- inviting_team: SharedChannelTeamItem;
595
- inviting_user: SharedChannelUserItem;
596
- recipient_email?: string;
597
- recipient_user_id?: string;
598
- }
599
- export interface SharedChannelItem {
600
- id: string;
601
- is_private: boolean;
602
- is_im: boolean;
603
- name: string;
604
- }
605
- export interface SharedChannelInviteAccepted {
606
- type: 'shared_channel_invite_accepted';
607
- approval_required: boolean;
608
- invite: SharedChannelInviteItem;
609
- channel: SharedChannelItem;
610
- teams_in_channel: SharedChannelTeamItem[];
611
- accepting_user: SharedChannelUserItem;
612
- event_ts: string;
613
- }
614
- export interface SharedChannelInviteApproved {
615
- type: 'shared_channel_invite_approved';
616
- invite: SharedChannelInviteItem;
617
- channel: SharedChannelItem;
618
- approving_team_id: string;
619
- teams_in_channel: SharedChannelTeamItem[];
620
- approving_user: SharedChannelUserItem;
621
- event_ts: string;
622
- }
623
- export interface SharedChannelInviteDeclined {
624
- type: 'shared_channel_invite_declined';
625
- invite: SharedChannelInviteItem;
626
- channel: SharedChannelItem;
627
- declining_team_id: string;
628
- teams_in_channel: SharedChannelTeamItem[];
629
- declining_user: SharedChannelUserItem;
630
- event_ts: string;
631
- }
632
- export interface SharedChannelInviteReceived {
633
- type: 'shared_channel_invite_received';
634
- invite: SharedChannelInviteItem;
635
- channel: SharedChannelItem;
636
- event_ts: string;
637
- }
638
- export interface StarAddedEvent {
639
- type: 'star_added';
640
- user: string;
641
- item: Record<string, unknown>;
642
- event_ts: string;
643
- }
644
- export interface StarRemovedEvent {
645
- type: 'star_removed';
646
- user: string;
647
- item: Record<string, unknown>;
648
- event_ts: string;
649
- }
650
- interface Subteam {
651
- id: string;
652
- team_id?: string;
653
- is_usergroup: boolean;
654
- is_subteam: boolean;
655
- name: string;
656
- description?: string;
657
- handle: string;
658
- is_external: boolean;
659
- date_create: number;
660
- date_update?: number;
661
- date_delete?: number;
662
- auto_provision: boolean;
663
- enterprise_subteam_id?: string;
664
- created_by: string;
665
- updated_by?: string;
666
- prefs?: {
667
- channels?: string[];
668
- groups?: string[];
669
- };
670
- users: string[];
671
- user_count: number;
672
- channel_count?: number;
673
- }
674
- export interface SubteamCreated {
675
- type: 'subteam_created';
676
- subteam: Subteam;
677
- event_ts: string;
678
- }
679
- export interface SubteamMembersChanged {
680
- type: 'subteam_members_changed';
681
- subteam_id: string;
682
- team_id: string;
683
- date_previous_update: number;
684
- date_update: number;
685
- added_users?: string[];
686
- added_users_count?: number;
687
- removed_users?: string[];
688
- removed_users_count?: number;
689
- event_ts: string;
690
- }
691
- export interface SubteamSelfAddedEvent {
692
- type: 'subteam_self_added';
693
- subteam_id: string;
694
- event_ts: string;
695
- }
696
- export interface SubteamSelfRemovedEvent {
697
- type: 'subteam_self_removed';
698
- subteam_id: string;
699
- event_ts: string;
700
- }
701
- export interface SubteamUpdatedEvent {
702
- type: 'subteam_updated';
703
- subteam: Subteam;
704
- event_ts: string;
705
- }
706
- export interface TeamAccessGrantedEvent {
707
- type: 'team_access_granted';
708
- team_ids: string[];
709
- event_ts: string;
710
- }
711
- export interface TeamAccessRevokedEvent {
712
- type: 'team_access_revoked';
713
- team_ids: string[];
714
- event_ts: string;
715
- }
716
- export interface TeamDomainChangedEvent {
717
- type: 'team_domain_changed';
718
- url: string;
719
- domain: string;
720
- }
721
- export interface TeamJoinEvent {
722
- type: 'team_join';
723
- user: {
724
- id: string;
725
- };
726
- }
727
- export interface TeamRenameEvent {
728
- type: 'team_rename';
729
- name: string;
730
- }
731
- export interface TokensRevokedEvent {
732
- type: 'tokens_revoked';
733
- tokens: {
734
- oauth?: string[];
735
- bot?: string[];
736
- };
737
- }
738
- export interface StatusEmojiDisplayInfo {
739
- emoji_name?: string;
740
- display_alias?: string;
741
- display_url?: string;
742
- }
743
- export interface UserChangeEvent {
744
- type: 'user_change';
745
- user: {
746
- id: string;
747
- team_id: string;
748
- name: string;
749
- deleted: boolean;
750
- color: string;
751
- real_name: string;
752
- tz: string;
753
- tz_label: string;
754
- tz_offset: number;
755
- profile: {
756
- title: string;
757
- phone: string;
758
- skype: string;
759
- real_name: string;
760
- real_name_normalized: string;
761
- display_name: string;
762
- display_name_normalized: string;
763
- status_text: string;
764
- status_text_canonical: string;
765
- status_emoji: string;
766
- status_emoji_display_info: StatusEmojiDisplayInfo[];
767
- status_expiration: number;
768
- avatar_hash: string;
769
- huddle_state?: string;
770
- huddle_state_expiration_ts?: number;
771
- first_name: string;
772
- last_name: string;
773
- email?: string;
774
- image_original?: string;
775
- is_custom_image?: boolean;
776
- image_24: string;
777
- image_32: string;
778
- image_48: string;
779
- image_72: string;
780
- image_192: string;
781
- image_512: string;
782
- image_1024?: string;
783
- team: string;
784
- fields: {
785
- [key: string]: {
786
- value: string;
787
- alt: string;
788
- };
789
- } | [] | null;
790
- };
791
- is_admin: boolean;
792
- is_owner: boolean;
793
- is_primary_owner: boolean;
794
- is_restricted: boolean;
795
- is_ultra_restricted: boolean;
796
- is_bot: boolean;
797
- is_stranger?: boolean;
798
- updated: number;
799
- is_email_confirmed: boolean;
800
- is_app_user: boolean;
801
- is_invited_user?: boolean;
802
- has_2fa?: boolean;
803
- locale: string;
804
- presence?: string;
805
- enterprise_user?: {
806
- id: string;
807
- enterprise_id: string;
808
- enterprise_name: string;
809
- is_admin: boolean;
810
- is_owner: boolean;
811
- teams: string[];
812
- };
813
- two_factor_type?: string;
814
- has_files?: boolean;
815
- is_workflow_bot?: boolean;
816
- who_can_share_contact_card: string;
817
- };
818
- cache_ts: number;
819
- event_ts: string;
820
- }
821
- export interface UserHuddleChangedEvent {
822
- type: 'user_huddle_changed';
823
- user: {
824
- id: string;
825
- team_id: string;
826
- name: string;
827
- deleted: boolean;
828
- color: string;
829
- real_name: string;
830
- tz: string;
831
- tz_label: string;
832
- tz_offset: number;
833
- profile: {
834
- title: string;
835
- phone: string;
836
- skype: string;
837
- real_name: string;
838
- real_name_normalized: string;
839
- display_name: string;
840
- display_name_normalized: string;
841
- status_text: string;
842
- status_text_canonical: string;
843
- status_emoji: string;
844
- status_emoji_display_info: StatusEmojiDisplayInfo[];
845
- status_expiration: number;
846
- avatar_hash: string;
847
- huddle_state: string;
848
- huddle_state_expiration_ts: number;
849
- first_name: string;
850
- last_name: string;
851
- email?: string;
852
- image_original?: string;
853
- is_custom_image?: boolean;
854
- image_24: string;
855
- image_32: string;
856
- image_48: string;
857
- image_72: string;
858
- image_192: string;
859
- image_512: string;
860
- image_1024?: string;
861
- team: string;
862
- fields: {
863
- [key: string]: {
864
- value: string;
865
- alt: string;
866
- };
867
- } | [] | null;
868
- };
869
- is_admin: boolean;
870
- is_owner: boolean;
871
- is_primary_owner: boolean;
872
- is_restricted: boolean;
873
- is_ultra_restricted: boolean;
874
- is_bot: boolean;
875
- is_stranger?: boolean;
876
- updated: number;
877
- is_email_confirmed: boolean;
878
- is_app_user: boolean;
879
- is_invited_user?: boolean;
880
- has_2fa?: boolean;
881
- locale: string;
882
- presence?: string;
883
- enterprise_user?: {
884
- id: string;
885
- enterprise_id: string;
886
- enterprise_name: string;
887
- is_admin: boolean;
888
- is_owner: boolean;
889
- teams: string[];
890
- };
891
- two_factor_type?: string;
892
- has_files?: boolean;
893
- is_workflow_bot?: boolean;
894
- who_can_share_contact_card: string;
895
- };
896
- cache_ts: number;
897
- event_ts: string;
898
- }
899
- export interface UserProfileChangedEvent {
900
- type: 'user_profile_changed';
901
- user: {
902
- id: string;
903
- team_id: string;
904
- name: string;
905
- deleted: boolean;
906
- color: string;
907
- real_name: string;
908
- tz: string;
909
- tz_label: string;
910
- tz_offset: number;
911
- profile: {
912
- title: string;
913
- phone: string;
914
- skype: string;
915
- real_name: string;
916
- real_name_normalized: string;
917
- display_name: string;
918
- display_name_normalized: string;
919
- status_text: string;
920
- status_text_canonical: string;
921
- status_emoji: string;
922
- status_emoji_display_info: StatusEmojiDisplayInfo[];
923
- status_expiration: number;
924
- avatar_hash: string;
925
- huddle_state: string;
926
- huddle_state_expiration_ts: number;
927
- first_name: string;
928
- last_name: string;
929
- email?: string;
930
- image_original?: string;
931
- is_custom_image?: boolean;
932
- image_24: string;
933
- image_32: string;
934
- image_48: string;
935
- image_72: string;
936
- image_192: string;
937
- image_512: string;
938
- image_1024?: string;
939
- team: string;
940
- fields: {
941
- [key: string]: {
942
- value: string;
943
- alt: string;
944
- };
945
- } | [] | null;
946
- };
947
- is_admin: boolean;
948
- is_owner: boolean;
949
- is_primary_owner: boolean;
950
- is_restricted: boolean;
951
- is_ultra_restricted: boolean;
952
- is_bot: boolean;
953
- is_stranger?: boolean;
954
- updated: number;
955
- is_email_confirmed: boolean;
956
- is_app_user: boolean;
957
- is_invited_user?: boolean;
958
- has_2fa?: boolean;
959
- locale: string;
960
- presence?: string;
961
- enterprise_user?: {
962
- id: string;
963
- enterprise_id: string;
964
- enterprise_name: string;
965
- is_admin: boolean;
966
- is_owner: boolean;
967
- teams: string[];
968
- };
969
- two_factor_type?: string;
970
- has_files?: boolean;
971
- is_workflow_bot?: boolean;
972
- who_can_share_contact_card: string;
973
- };
974
- cache_ts: number;
975
- event_ts: string;
976
- }
977
- export interface UserStatusChangedEvent {
978
- type: 'user_status_changed';
979
- user: {
980
- id: string;
981
- team_id: string;
982
- name: string;
983
- deleted: boolean;
984
- color: string;
985
- real_name: string;
986
- tz: string;
987
- tz_label: string;
988
- tz_offset: number;
989
- profile: {
990
- title: string;
991
- phone: string;
992
- skype: string;
993
- real_name: string;
994
- real_name_normalized: string;
995
- display_name: string;
996
- display_name_normalized: string;
997
- status_text: string;
998
- status_text_canonical: string;
999
- status_emoji: string;
1000
- status_emoji_display_info: StatusEmojiDisplayInfo[];
1001
- status_expiration: number;
1002
- avatar_hash: string;
1003
- first_name: string;
1004
- last_name: string;
1005
- email?: string;
1006
- image_original?: string;
1007
- is_custom_image?: boolean;
1008
- image_24: string;
1009
- image_32: string;
1010
- image_48: string;
1011
- image_72: string;
1012
- image_192: string;
1013
- image_512: string;
1014
- image_1024?: string;
1015
- team: string;
1016
- fields: {
1017
- [key: string]: {
1018
- value: string;
1019
- alt: string;
1020
- };
1021
- } | [] | null;
1022
- };
1023
- is_admin: boolean;
1024
- is_owner: boolean;
1025
- is_primary_owner: boolean;
1026
- is_restricted: boolean;
1027
- is_ultra_restricted: boolean;
1028
- is_bot: boolean;
1029
- is_stranger?: boolean;
1030
- updated: number;
1031
- is_email_confirmed: boolean;
1032
- is_app_user: boolean;
1033
- is_invited_user?: boolean;
1034
- has_2fa?: boolean;
1035
- locale: string;
1036
- presence?: string;
1037
- enterprise_user?: {
1038
- id: string;
1039
- enterprise_id: string;
1040
- enterprise_name: string;
1041
- is_admin: boolean;
1042
- is_owner: boolean;
1043
- teams: string[];
1044
- };
1045
- two_factor_type?: string;
1046
- has_files?: boolean;
1047
- is_workflow_bot?: boolean;
1048
- who_can_share_contact_card: string;
1049
- };
1050
- cache_ts: number;
1051
- event_ts: string;
1052
- }
1053
- export interface WorkflowDeletedEvent {
1054
- type: 'workflow_deleted';
1055
- workflow_id: string;
1056
- workflow_draft_configuration: {
1057
- version_id: string;
1058
- app_steps: {
1059
- app_id: string;
1060
- workflow_step_id: string;
1061
- callback_id: string;
1062
- }[];
1063
- };
1064
- event_ts: string;
1065
- }
1066
- export interface WorkflowPublishedEvent {
1067
- type: 'workflow_published';
1068
- workflow_id: string;
1069
- workflow_published_configuration: {
1070
- version_id: string;
1071
- app_steps: {
1072
- app_id: string;
1073
- workflow_step_id: string;
1074
- callback_id: string;
1075
- }[];
1076
- };
1077
- event_ts: string;
1078
- }
1079
- export interface WorkflowUnpublishedEvent {
1080
- type: 'workflow_unpublished';
1081
- workflow_id: string;
1082
- workflow_draft_configuration: {
1083
- version_id: string;
1084
- app_steps: {
1085
- app_id: string;
1086
- workflow_step_id: string;
1087
- callback_id: string;
1088
- }[];
1089
- };
1090
- event_ts: string;
1091
- }
1092
- export interface WorkflowStepDeletedEvent {
1093
- type: 'workflow_step_deleted';
1094
- workflow_id: string;
1095
- workflow_draft_configuration: {
1096
- version_id: string;
1097
- app_steps: {
1098
- app_id: string;
1099
- workflow_step_id: string;
1100
- callback_id: string;
1101
- }[];
1102
- };
1103
- workflow_published_configuration?: {
1104
- version_id: string;
1105
- app_steps: {
1106
- app_id: string;
1107
- workflow_step_id: string;
1108
- callback_id: string;
1109
- }[];
1110
- };
1111
- event_ts: string;
1112
- }
1113
- export interface WorkflowStepExecuteEvent {
1114
- type: 'workflow_step_execute';
1115
- callback_id: string;
1116
- workflow_step: {
1117
- workflow_step_execute_id: string;
1118
- workflow_id: string;
1119
- workflow_instance_id: string;
1120
- step_id: string;
1121
- inputs: {
1122
- [key: string]: {
1123
- value: any;
1124
- };
1125
- };
1126
- outputs: {
1127
- name: string;
1128
- type: string;
1129
- label: string;
1130
- }[];
1131
- };
1132
- event_ts: string;
1133
- }
1134
- export {};
1135
- //# sourceMappingURL=base-events.d.ts.map