UNPKG

73.8 kBTypeScriptView Raw
1/// <reference types="node" />
2/// <reference types="node" />
3import { Stream } from 'stream';
4import { Dialog, View, KnownBlock, Block, MessageAttachment, LinkUnfurls, CallUser, MessageMetadata } from '@slack/types';
5import { EventEmitter } from 'eventemitter3';
6import { WebAPICallOptions, WebAPICallResult, WebClientEvent } from './WebClient';
7import { AdminAnalyticsGetFileResponse, AdminAppsApproveResponse, AdminAppsApprovedListResponse, AdminAppsClearResolutionResponse, AdminAppsRequestsListResponse, AdminAppsRestrictResponse, AdminAppsRestrictedListResponse, AdminAppsUninstallResponse, AdminAuthPolicyAssignEntitiesResponse, AdminAuthPolicyGetEntitiesResponse, AdminAuthPolicyRemoveEntitiesResponse, AdminBarriersCreateResponse, AdminBarriersDeleteResponse, AdminBarriersListResponse, AdminBarriersUpdateResponse, AdminConversationsArchiveResponse, AdminConversationsConvertToPrivateResponse, AdminConversationsCreateResponse, AdminConversationsDeleteResponse, AdminConversationsDisconnectSharedResponse, AdminConversationsEkmListOriginalConnectedChannelInfoResponse, AdminConversationsGetConversationPrefsResponse, AdminConversationsGetTeamsResponse, AdminConversationsInviteResponse, AdminConversationsRenameResponse, AdminConversationsRestrictAccessAddGroupResponse, AdminConversationsRestrictAccessListGroupsResponse, AdminConversationsRestrictAccessRemoveGroupResponse, AdminConversationsSearchResponse, AdminConversationsSetConversationPrefsResponse, AdminConversationsSetTeamsResponse, AdminConversationsUnarchiveResponse, AdminConversationsGetCustomRetentionResponse, AdminConversationsSetCustomRetentionResponse, AdminConversationsRemoveCustomRetentionResponse, AdminEmojiAddAliasResponse, AdminEmojiAddResponse, AdminEmojiListResponse, AdminEmojiRemoveResponse, AdminEmojiRenameResponse, AdminInviteRequestsApproveResponse, AdminInviteRequestsApprovedListResponse, AdminInviteRequestsDeniedListResponse, AdminInviteRequestsDenyResponse, AdminInviteRequestsListResponse, AdminTeamsAdminsListResponse, AdminTeamsCreateResponse, AdminTeamsListResponse, AdminTeamsOwnersListResponse, AdminTeamsSettingsInfoResponse, AdminTeamsSettingsSetDefaultChannelsResponse, AdminTeamsSettingsSetDescriptionResponse, AdminTeamsSettingsSetDiscoverabilityResponse, AdminTeamsSettingsSetIconResponse, AdminTeamsSettingsSetNameResponse, AdminUsergroupsAddChannelsResponse, AdminUsergroupsAddTeamsResponse, AdminUsergroupsListChannelsResponse, AdminUsergroupsRemoveChannelsResponse, AdminUsersAssignResponse, AdminUsersInviteResponse, AdminUsersListResponse, AdminUsersRemoveResponse, AdminUsersSessionGetSettingsResponse, AdminUsersSessionSetSettingsResponse, AdminUsersSessionClearSettingsResponse, AdminUsersSessionInvalidateResponse, AdminUsersSessionListResponse, AdminUsersSessionResetResponse, AdminUsersSessionResetBulkResponse, AdminUsersSetAdminResponse, AdminUsersSetExpirationResponse, AdminUsersSetOwnerResponse, AdminUsersSetRegularResponse, AdminUsersUnsupportedVersionsExportResponse, ApiTestResponse, AppsConnectionsOpenResponse, AppsEventAuthorizationsListResponse, AppsUninstallResponse, AuthRevokeResponse, AuthTeamsListResponse, AuthTestResponse, BotsInfoResponse, CallsAddResponse, CallsEndResponse, CallsInfoResponse, CallsUpdateResponse, CallsParticipantsAddResponse, CallsParticipantsRemoveResponse, ChatDeleteResponse, ChatDeleteScheduledMessageResponse, ChatGetPermalinkResponse, ChatMeMessageResponse, ChatPostEphemeralResponse, ChatPostMessageResponse, ChatScheduleMessageResponse, ChatScheduledMessagesListResponse, ChatUnfurlResponse, ChatUpdateResponse, ConversationsAcceptSharedInviteResponse, ConversationsApproveSharedInviteResponse, ConversationsDeclineSharedInviteResponse, ConversationsInviteSharedResponse, ConversationsListConnectInvitesResponse, ConversationsArchiveResponse, ConversationsCloseResponse, ConversationsCreateResponse, ConversationsHistoryResponse, ConversationsInfoResponse, ConversationsInviteResponse, ConversationsJoinResponse, ConversationsKickResponse, ConversationsLeaveResponse, ConversationsListResponse, ConversationsMarkResponse, ConversationsMembersResponse, ConversationsOpenResponse, ConversationsRenameResponse, ConversationsRepliesResponse, ConversationsSetPurposeResponse, ConversationsSetTopicResponse, ConversationsUnarchiveResponse, DialogOpenResponse, DndEndDndResponse, DndEndSnoozeResponse, DndInfoResponse, DndSetSnoozeResponse, DndTeamInfoResponse, EmojiListResponse, FilesCommentsDeleteResponse, FilesCompleteUploadExternalResponse, FilesDeleteResponse, FilesGetUploadURLExternalResponse, FilesInfoResponse, FilesListResponse, FilesRemoteAddResponse, FilesRemoteInfoResponse, FilesRemoteListResponse, FilesRemoteRemoveResponse, FilesRemoteShareResponse, FilesRemoteUpdateResponse, FilesRevokePublicURLResponse, FilesSharedPublicURLResponse, FilesUploadResponse, MigrationExchangeResponse, OauthAccessResponse, OauthV2AccessResponse, OauthV2ExchangeResponse, OpenIDConnectTokenResponse, OpenIDConnectUserInfoResponse, PinsAddResponse, PinsListResponse, PinsRemoveResponse, ReactionsAddResponse, ReactionsGetResponse, ReactionsListResponse, ReactionsRemoveResponse, RemindersAddResponse, RemindersCompleteResponse, RemindersDeleteResponse, RemindersInfoResponse, RemindersListResponse, RtmConnectResponse, RtmStartResponse, SearchAllResponse, SearchFilesResponse, SearchMessagesResponse, StarsAddResponse, StarsListResponse, StarsRemoveResponse, TeamAccessLogsResponse, TeamBillableInfoResponse, TeamBillingInfoResponse, TeamInfoResponse, TeamIntegrationLogsResponse, TeamPreferencesListResponse, TeamProfileGetResponse, UsergroupsCreateResponse, UsergroupsDisableResponse, UsergroupsEnableResponse, UsergroupsListResponse, UsergroupsUpdateResponse, UsergroupsUsersListResponse, UsergroupsUsersUpdateResponse, UsersConversationsResponse, UsersDeletePhotoResponse, UsersGetPresenceResponse, UsersIdentityResponse, UsersInfoResponse, UsersListResponse, UsersLookupByEmailResponse, UsersProfileGetResponse, UsersProfileSetResponse, UsersSetPhotoResponse, UsersSetPresenceResponse, ViewsOpenResponse, ViewsPublishResponse, ViewsPushResponse, ViewsUpdateResponse, WorkflowsStepCompletedResponse, WorkflowsStepFailedResponse, WorkflowsUpdateStepResponse, AdminAppsRequestsCancelResponse, BookmarksAddResponse, BookmarksEditResponse, BookmarksListResponse, BookmarksRemoveResponse } from './response';
8/**
9 * A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the
10 * `apiCall` class method.
11 */
12export declare abstract class Methods extends EventEmitter<WebClientEvent> {
13 protected constructor();
14 abstract apiCall(method: string, options?: WebAPICallOptions): Promise<WebAPICallResult>;
15 abstract filesUploadV2(options?: WebAPICallOptions): Promise<WebAPICallResult>;
16 readonly admin: {
17 analytics: {
18 getFile: Method<AdminAnalyticsGetFileArguments, AdminAnalyticsGetFileResponse>;
19 };
20 apps: {
21 approve: Method<AdminAppsApproveArguments, AdminAppsApproveResponse>;
22 approved: {
23 list: Method<AdminAppsApprovedListArguments, AdminAppsApprovedListResponse>;
24 };
25 clearResolution: Method<AdminAppsClearResolutionArguments, AdminAppsClearResolutionResponse>;
26 requests: {
27 cancel: Method<AdminAppsRequestsCancelArguments, AdminAppsRequestsCancelResponse>;
28 list: Method<AdminAppsRequestsListArguments, AdminAppsRequestsListResponse>;
29 };
30 restrict: Method<AdminAppsRestrictArguments, AdminAppsRestrictResponse>;
31 restricted: {
32 list: Method<AdminAppsRestrictedListArguments, AdminAppsRestrictedListResponse>;
33 };
34 uninstall: Method<AdminAppsUninstallArguments, AdminAppsUninstallResponse>;
35 };
36 auth: {
37 policy: {
38 assignEntities: Method<AdminAuthPolicyAssignEntitiesArguments, AdminAuthPolicyAssignEntitiesResponse>;
39 getEntities: Method<AdminAuthPolicyGetEntitiesArguments, AdminAuthPolicyGetEntitiesResponse>;
40 removeEntities: Method<AdminAuthPolicyRemoveEntitiesArguments, AdminAuthPolicyRemoveEntitiesResponse>;
41 };
42 };
43 barriers: {
44 create: Method<AdminBarriersCreateArguments, AdminBarriersCreateResponse>;
45 delete: Method<AdminBarriersDeleteArguments, AdminBarriersDeleteResponse>;
46 list: Method<AdminBarriersListArguments, AdminBarriersListResponse>;
47 update: Method<AdminBarriersUpdateArguments, AdminBarriersUpdateResponse>;
48 };
49 conversations: {
50 archive: Method<AdminConversationsArchiveArguments, AdminConversationsArchiveResponse>;
51 convertToPrivate: Method<AdminConversationsConvertToPrivateArguments, AdminConversationsConvertToPrivateResponse>;
52 create: Method<AdminConversationsCreateArguments, AdminConversationsCreateResponse>;
53 delete: Method<AdminConversationsDeleteArguments, AdminConversationsDeleteResponse>;
54 disconnectShared: Method<AdminConversationsDisconnectSharedArguments, AdminConversationsDisconnectSharedResponse>;
55 ekm: {
56 listOriginalConnectedChannelInfo: Method<AdminConversationsEKMListOriginalConnectedChannelInfoArguments, AdminConversationsEkmListOriginalConnectedChannelInfoResponse>;
57 };
58 getConversationPrefs: Method<AdminConversationsGetConversationPrefsArguments, AdminConversationsGetConversationPrefsResponse>;
59 getTeams: Method<AdminConversationsGetTeamsArguments, AdminConversationsGetTeamsResponse>;
60 invite: Method<AdminConversationsInviteArguments, AdminConversationsInviteResponse>;
61 rename: Method<AdminConversationsRenameArguments, AdminConversationsRenameResponse>;
62 restrictAccess: {
63 addGroup: Method<AdminConversationsRestrictAccessAddGroupArguments, AdminConversationsRestrictAccessAddGroupResponse>;
64 listGroups: Method<AdminConversationsRestrictAccessListGroupsArguments, AdminConversationsRestrictAccessListGroupsResponse>;
65 removeGroup: Method<AdminConversationsRestrictAccessRemoveGroupArguments, AdminConversationsRestrictAccessRemoveGroupResponse>;
66 };
67 getCustomRetention: Method<AdminConversationsGetCustomRetentionArguments, AdminConversationsGetCustomRetentionResponse>;
68 setCustomRetention: Method<AdminConversationsSetCustomRetentionArguments, AdminConversationsSetCustomRetentionResponse>;
69 removeCustomRetention: Method<AdminConversationsRemoveCustomRetentionArguments, AdminConversationsRemoveCustomRetentionResponse>;
70 search: Method<AdminConversationsSearchArguments, AdminConversationsSearchResponse>;
71 setConversationPrefs: Method<AdminConversationsSetConversationPrefsArguments, AdminConversationsSetConversationPrefsResponse>;
72 setTeams: Method<AdminConversationsSetTeamsArguments, AdminConversationsSetTeamsResponse>;
73 unarchive: Method<AdminConversationsUnarchiveArguments, AdminConversationsUnarchiveResponse>;
74 };
75 emoji: {
76 add: Method<AdminEmojiAddArguments, AdminEmojiAddResponse>;
77 addAlias: Method<AdminEmojiAddAliasArguments, AdminEmojiAddAliasResponse>;
78 list: Method<AdminEmojiListArguments, AdminEmojiListResponse>;
79 remove: Method<AdminEmojiRemoveArguments, AdminEmojiRemoveResponse>;
80 rename: Method<AdminEmojiRenameArguments, AdminEmojiRenameResponse>;
81 };
82 inviteRequests: {
83 approve: Method<AdminInviteRequestsApproveArguments, AdminInviteRequestsApproveResponse>;
84 approved: {
85 list: Method<AdminInviteRequestsApprovedListArguments, AdminInviteRequestsApprovedListResponse>;
86 };
87 denied: {
88 list: Method<AdminInviteRequestsDeniedListArguments, AdminInviteRequestsDeniedListResponse>;
89 };
90 deny: Method<AdminInviteRequestsDenyArguments, AdminInviteRequestsDenyResponse>;
91 list: Method<AdminInviteRequestsListArguments, AdminInviteRequestsListResponse>;
92 };
93 teams: {
94 admins: {
95 list: Method<AdminTeamsAdminsListArguments, AdminTeamsAdminsListResponse>;
96 };
97 create: Method<AdminTeamsCreateArguments, AdminTeamsCreateResponse>;
98 list: Method<AdminTeamsListArguments, AdminTeamsListResponse>;
99 owners: {
100 list: Method<AdminTeamsOwnersListArguments, AdminTeamsOwnersListResponse>;
101 };
102 settings: {
103 info: Method<AdminTeamsSettingsInfoArguments, AdminTeamsSettingsInfoResponse>;
104 setDefaultChannels: Method<AdminTeamsSettingsSetDefaultChannelsArguments, AdminTeamsSettingsSetDefaultChannelsResponse>;
105 setDescription: Method<AdminTeamsSettingsSetDescriptionArguments, AdminTeamsSettingsSetDescriptionResponse>;
106 setDiscoverability: Method<AdminTeamsSettingsSetDiscoverabilityArguments, AdminTeamsSettingsSetDiscoverabilityResponse>;
107 setIcon: Method<AdminTeamsSettingsSetIconArguments, AdminTeamsSettingsSetIconResponse>;
108 setName: Method<AdminTeamsSettingsSetNameArguments, AdminTeamsSettingsSetNameResponse>;
109 };
110 };
111 usergroups: {
112 addChannels: Method<AdminUsergroupsAddChannelsArguments, AdminUsergroupsAddChannelsResponse>;
113 addTeams: Method<AdminUsergroupsAddTeamsArguments, AdminUsergroupsAddTeamsResponse>;
114 listChannels: Method<AdminUsergroupsListChannelsArguments, AdminUsergroupsListChannelsResponse>;
115 removeChannels: Method<AdminUsergroupsRemoveChannelsArguments, AdminUsergroupsRemoveChannelsResponse>;
116 };
117 users: {
118 assign: Method<AdminUsersAssignArguments, AdminUsersAssignResponse>;
119 invite: Method<AdminUsersInviteArguments, AdminUsersInviteResponse>;
120 list: Method<AdminUsersListArguments, AdminUsersListResponse>;
121 remove: Method<AdminUsersRemoveArguments, AdminUsersRemoveResponse>;
122 session: {
123 list: Method<AdminUsersSessionListArguments, AdminUsersSessionListResponse>;
124 reset: Method<AdminUsersSessionResetArguments, AdminUsersSessionResetResponse>;
125 resetBulk: Method<AdminUsersSessionResetBulkArguments, AdminUsersSessionResetBulkResponse>;
126 invalidate: Method<AdminUsersSessionInvalidateArguments, AdminUsersSessionInvalidateResponse>;
127 getSettings: Method<AdminUsersSessionGetSettingsArguments, AdminUsersSessionGetSettingsResponse>;
128 setSettings: Method<AdminUsersSessionSetSettingsArguments, AdminUsersSessionSetSettingsResponse>;
129 clearSettings: Method<AdminUsersSessionClearSettingsArguments, AdminUsersSessionClearSettingsResponse>;
130 };
131 unsupportedVersions: {
132 export: Method<AdminUsersUnsupportedVersionsExportArguments, AdminUsersUnsupportedVersionsExportResponse>;
133 };
134 setAdmin: Method<AdminUsersSetAdminArguments, AdminUsersSetAdminResponse>;
135 setExpiration: Method<AdminUsersSetExpirationArguments, AdminUsersSetExpirationResponse>;
136 setOwner: Method<AdminUsersSetOwnerArguments, AdminUsersSetOwnerResponse>;
137 setRegular: Method<AdminUsersSetRegularArguments, AdminUsersSetRegularResponse>;
138 };
139 };
140 readonly api: {
141 test: Method<APITestArguments, ApiTestResponse>;
142 };
143 readonly apps: {
144 connections: {
145 open: Method<AppsConnectionsOpenArguments, AppsConnectionsOpenResponse>;
146 };
147 event: {
148 authorizations: {
149 list: Method<AppsEventAuthorizationsListArguments, AppsEventAuthorizationsListResponse>;
150 };
151 };
152 uninstall: Method<AppsUninstallArguments, AppsUninstallResponse>;
153 };
154 readonly auth: {
155 revoke: Method<AuthRevokeArguments, AuthRevokeResponse>;
156 teams: {
157 list: Method<AuthTeamsListArguments, AuthTeamsListResponse>;
158 };
159 test: Method<AuthTestArguments, AuthTestResponse>;
160 };
161 readonly bots: {
162 info: Method<BotsInfoArguments, BotsInfoResponse>;
163 };
164 readonly bookmarks: {
165 add: Method<BookmarksAddArguments, BookmarksAddResponse>;
166 edit: Method<BookmarksEditArguments, BookmarksEditResponse>;
167 list: Method<BookmarksListArguments, BookmarksListResponse>;
168 remove: Method<BookmarksRemoveArguments, BookmarksRemoveResponse>;
169 };
170 readonly calls: {
171 add: Method<CallsAddArguments, CallsAddResponse>;
172 end: Method<CallsEndArguments, CallsEndResponse>;
173 info: Method<CallsInfoArguments, CallsInfoResponse>;
174 update: Method<CallsUpdateArguments, CallsUpdateResponse>;
175 participants: {
176 add: Method<CallsParticipantsAddArguments, CallsParticipantsAddResponse>;
177 remove: Method<CallsParticipantsRemoveArguments, CallsParticipantsRemoveResponse>;
178 };
179 };
180 readonly chat: {
181 delete: Method<ChatDeleteArguments, ChatDeleteResponse>;
182 deleteScheduledMessage: Method<ChatDeleteScheduledMessageArguments, ChatDeleteScheduledMessageResponse>;
183 getPermalink: Method<ChatGetPermalinkArguments, ChatGetPermalinkResponse>;
184 meMessage: Method<ChatMeMessageArguments, ChatMeMessageResponse>;
185 postEphemeral: Method<ChatPostEphemeralArguments, ChatPostEphemeralResponse>;
186 postMessage: Method<ChatPostMessageArguments, ChatPostMessageResponse>;
187 scheduleMessage: Method<ChatScheduleMessageArguments, ChatScheduleMessageResponse>;
188 scheduledMessages: {
189 list: Method<ChatScheduledMessagesListArguments, ChatScheduledMessagesListResponse>;
190 };
191 unfurl: Method<ChatUnfurlArguments, ChatUnfurlResponse>;
192 update: Method<ChatUpdateArguments, ChatUpdateResponse>;
193 };
194 readonly conversations: {
195 acceptSharedInvite: Method<ConversationsAcceptSharedInviteArguments, ConversationsAcceptSharedInviteResponse>;
196 approveSharedInvite: Method<ConversationsApproveSharedInviteArguments, ConversationsApproveSharedInviteResponse>;
197 archive: Method<ConversationsArchiveArguments, ConversationsArchiveResponse>;
198 close: Method<ConversationsCloseArguments, ConversationsCloseResponse>;
199 create: Method<ConversationsCreateArguments, ConversationsCreateResponse>;
200 declineSharedInvite: Method<ConversationsDeclineSharedInviteArguments, ConversationsDeclineSharedInviteResponse>;
201 history: Method<ConversationsHistoryArguments, ConversationsHistoryResponse>;
202 info: Method<ConversationsInfoArguments, ConversationsInfoResponse>;
203 invite: Method<ConversationsInviteArguments, ConversationsInviteResponse>;
204 inviteShared: Method<ConversationsInviteSharedArguments, ConversationsInviteSharedResponse>;
205 join: Method<ConversationsJoinArguments, ConversationsJoinResponse>;
206 kick: Method<ConversationsKickArguments, ConversationsKickResponse>;
207 leave: Method<ConversationsLeaveArguments, ConversationsLeaveResponse>;
208 list: Method<ConversationsListArguments, ConversationsListResponse>;
209 listConnectInvites: Method<ConversationsListConnectInvitesArguments, ConversationsListConnectInvitesResponse>;
210 mark: Method<ConversationsMarkArguments, ConversationsMarkResponse>;
211 members: Method<ConversationsMembersArguments, ConversationsMembersResponse>;
212 open: Method<ConversationsOpenArguments, ConversationsOpenResponse>;
213 rename: Method<ConversationsRenameArguments, ConversationsRenameResponse>;
214 replies: Method<ConversationsRepliesArguments, ConversationsRepliesResponse>;
215 setPurpose: Method<ConversationsSetPurposeArguments, ConversationsSetPurposeResponse>;
216 setTopic: Method<ConversationsSetTopicArguments, ConversationsSetTopicResponse>;
217 unarchive: Method<ConversationsUnarchiveArguments, ConversationsUnarchiveResponse>;
218 };
219 readonly dialog: {
220 open: Method<DialogOpenArguments, DialogOpenResponse>;
221 };
222 readonly dnd: {
223 endDnd: Method<DndEndDndArguments, DndEndDndResponse>;
224 endSnooze: Method<DndEndSnoozeArguments, DndEndSnoozeResponse>;
225 info: Method<DndInfoArguments, DndInfoResponse>;
226 setSnooze: Method<DndSetSnoozeArguments, DndSetSnoozeResponse>;
227 teamInfo: Method<DndTeamInfoArguments, DndTeamInfoResponse>;
228 };
229 readonly emoji: {
230 list: Method<EmojiListArguments, EmojiListResponse>;
231 };
232 readonly files: {
233 delete: Method<FilesDeleteArguments, FilesDeleteResponse>;
234 info: Method<FilesInfoArguments, FilesInfoResponse>;
235 list: Method<FilesListArguments, FilesListResponse>;
236 revokePublicURL: Method<FilesRevokePublicURLArguments, FilesRevokePublicURLResponse>;
237 sharedPublicURL: Method<FilesSharedPublicURLArguments, FilesSharedPublicURLResponse>;
238 upload: Method<FilesUploadArguments, FilesUploadResponse>;
239 /**
240 * Custom method to support files upload v2 way of uploading files to Slack
241 * Supports a single file upload
242 * Supply:
243 * - (required) single file or content
244 * - (optional) channel, alt_text, snippet_type,
245 * Supports multiple file uploads
246 * Supply:
247 * - multiple upload_files
248 * Will try to honor both single file or content data supplied as well
249 * as multiple file uploads property.
250 */
251 uploadV2: Method<FilesUploadV2Arguments, WebAPICallResult>;
252 getUploadURLExternal: Method<FilesGetUploadURLExternalArguments, FilesGetUploadURLExternalResponse>;
253 completeUploadExternal: Method<FilesCompleteUploadExternalArguments, FilesCompleteUploadExternalResponse>;
254 comments: {
255 delete: Method<FilesCommentsDeleteArguments, FilesCommentsDeleteResponse>;
256 };
257 remote: {
258 info: Method<FilesRemoteInfoArguments, FilesRemoteInfoResponse>;
259 list: Method<FilesRemoteListArguments, FilesRemoteListResponse>;
260 add: Method<FilesRemoteAddArguments, FilesRemoteAddResponse>;
261 update: Method<FilesRemoteUpdateArguments, FilesRemoteUpdateResponse>;
262 remove: Method<FilesRemoteRemoveArguments, FilesRemoteRemoveResponse>;
263 share: Method<FilesRemoteShareArguments, FilesRemoteShareResponse>;
264 };
265 };
266 readonly migration: {
267 exchange: Method<MigrationExchangeArguments, MigrationExchangeResponse>;
268 };
269 readonly oauth: {
270 access: Method<OAuthAccessArguments, OauthAccessResponse>;
271 v2: {
272 access: Method<OAuthV2AccessArguments, OauthV2AccessResponse>;
273 exchange: Method<OAuthV2ExchangeArguments, OauthV2ExchangeResponse>;
274 };
275 };
276 readonly openid: {
277 connect: {
278 token: Method<OpenIDConnectTokenArguments, OpenIDConnectTokenResponse>;
279 userInfo: Method<OpenIDConnectUserInfoArguments, OpenIDConnectUserInfoResponse>;
280 };
281 };
282 readonly pins: {
283 add: Method<PinsAddArguments, PinsAddResponse>;
284 list: Method<PinsListArguments, PinsListResponse>;
285 remove: Method<PinsRemoveArguments, PinsRemoveResponse>;
286 };
287 readonly reactions: {
288 add: Method<ReactionsAddArguments, ReactionsAddResponse>;
289 get: Method<ReactionsGetArguments, ReactionsGetResponse>;
290 list: Method<ReactionsListArguments, ReactionsListResponse>;
291 remove: Method<ReactionsRemoveArguments, ReactionsRemoveResponse>;
292 };
293 readonly reminders: {
294 add: Method<RemindersAddArguments, RemindersAddResponse>;
295 complete: Method<RemindersCompleteArguments, RemindersCompleteResponse>;
296 delete: Method<RemindersDeleteArguments, RemindersDeleteResponse>;
297 info: Method<RemindersInfoArguments, RemindersInfoResponse>;
298 list: Method<RemindersListArguments, RemindersListResponse>;
299 };
300 readonly rtm: {
301 connect: Method<RTMConnectArguments, RtmConnectResponse>;
302 start: Method<RTMStartArguments, RtmStartResponse>;
303 };
304 readonly search: {
305 all: Method<SearchAllArguments, SearchAllResponse>;
306 files: Method<SearchFilesArguments, SearchFilesResponse>;
307 messages: Method<SearchMessagesArguments, SearchMessagesResponse>;
308 };
309 readonly stars: {
310 add: Method<StarsAddArguments, StarsAddResponse>;
311 list: Method<StarsListArguments, StarsListResponse>;
312 remove: Method<StarsRemoveArguments, StarsRemoveResponse>;
313 };
314 readonly team: {
315 accessLogs: Method<TeamAccessLogsArguments, TeamAccessLogsResponse>;
316 billableInfo: Method<TeamBillableInfoArguments, TeamBillableInfoResponse>;
317 billing: {
318 info: Method<TeamBillingInfoArguments, TeamBillingInfoResponse>;
319 };
320 info: Method<TeamInfoArguments, TeamInfoResponse>;
321 integrationLogs: Method<TeamIntegrationLogsArguments, TeamIntegrationLogsResponse>;
322 preferences: {
323 list: Method<TeamPreferencesListArguments, TeamPreferencesListResponse>;
324 };
325 profile: {
326 get: Method<TeamProfileGetArguments, TeamProfileGetResponse>;
327 };
328 };
329 readonly usergroups: {
330 create: Method<UsergroupsCreateArguments, UsergroupsCreateResponse>;
331 disable: Method<UsergroupsDisableArguments, UsergroupsDisableResponse>;
332 enable: Method<UsergroupsEnableArguments, UsergroupsEnableResponse>;
333 list: Method<UsergroupsListArguments, UsergroupsListResponse>;
334 update: Method<UsergroupsUpdateArguments, UsergroupsUpdateResponse>;
335 users: {
336 list: Method<UsergroupsUsersListArguments, UsergroupsUsersListResponse>;
337 update: Method<UsergroupsUsersUpdateArguments, UsergroupsUsersUpdateResponse>;
338 };
339 };
340 readonly users: {
341 conversations: Method<UsersConversationsArguments, UsersConversationsResponse>;
342 deletePhoto: Method<UsersDeletePhotoArguments, UsersDeletePhotoResponse>;
343 getPresence: Method<UsersGetPresenceArguments, UsersGetPresenceResponse>;
344 identity: Method<UsersIdentityArguments, UsersIdentityResponse>;
345 info: Method<UsersInfoArguments, UsersInfoResponse>;
346 list: Method<UsersListArguments, UsersListResponse>;
347 lookupByEmail: Method<UsersLookupByEmailArguments, UsersLookupByEmailResponse>;
348 setPhoto: Method<UsersSetPhotoArguments, UsersSetPhotoResponse>;
349 setPresence: Method<UsersSetPresenceArguments, UsersSetPresenceResponse>;
350 profile: {
351 get: Method<UsersProfileGetArguments, UsersProfileGetResponse>;
352 set: Method<UsersProfileSetArguments, UsersProfileSetResponse>;
353 };
354 };
355 readonly views: {
356 open: Method<ViewsOpenArguments, ViewsOpenResponse>;
357 publish: Method<ViewsPublishArguments, ViewsPublishResponse>;
358 push: Method<ViewsPushArguments, ViewsPushResponse>;
359 update: Method<ViewsUpdateArguments, ViewsUpdateResponse>;
360 };
361 readonly workflows: {
362 stepCompleted: Method<WorkflowsStepCompletedArguments, WorkflowsStepCompletedResponse>;
363 stepFailed: Method<WorkflowsStepFailedArguments, WorkflowsStepFailedResponse>;
364 updateStep: Method<WorkflowsUpdateStepArguments, WorkflowsUpdateStepResponse>;
365 };
366 readonly channels: {
367 archive: Method<ChannelsArchiveArguments, WebAPICallResult>;
368 create: Method<ChannelsCreateArguments, WebAPICallResult>;
369 history: Method<ChannelsHistoryArguments, WebAPICallResult>;
370 info: Method<ChannelsInfoArguments, WebAPICallResult>;
371 invite: Method<ChannelsInviteArguments, WebAPICallResult>;
372 join: Method<ChannelsJoinArguments, WebAPICallResult>;
373 kick: Method<ChannelsKickArguments, WebAPICallResult>;
374 leave: Method<ChannelsLeaveArguments, WebAPICallResult>;
375 list: Method<ChannelsListArguments, WebAPICallResult>;
376 mark: Method<ChannelsMarkArguments, WebAPICallResult>;
377 rename: Method<ChannelsRenameArguments, WebAPICallResult>;
378 replies: Method<ChannelsRepliesArguments, WebAPICallResult>;
379 setPurpose: Method<ChannelsSetPurposeArguments, WebAPICallResult>;
380 setTopic: Method<ChannelsSetTopicArguments, WebAPICallResult>;
381 unarchive: Method<ChannelsUnarchiveArguments, WebAPICallResult>;
382 };
383 readonly groups: {
384 archive: Method<GroupsArchiveArguments, WebAPICallResult>;
385 create: Method<GroupsCreateArguments, WebAPICallResult>;
386 createChild: Method<GroupsCreateChildArguments, WebAPICallResult>;
387 history: Method<GroupsHistoryArguments, WebAPICallResult>;
388 info: Method<GroupsInfoArguments, WebAPICallResult>;
389 invite: Method<GroupsInviteArguments, WebAPICallResult>;
390 kick: Method<GroupsKickArguments, WebAPICallResult>;
391 leave: Method<GroupsLeaveArguments, WebAPICallResult>;
392 list: Method<GroupsListArguments, WebAPICallResult>;
393 mark: Method<GroupsMarkArguments, WebAPICallResult>;
394 open: Method<GroupsOpenArguments, WebAPICallResult>;
395 rename: Method<GroupsRenameArguments, WebAPICallResult>;
396 replies: Method<GroupsRepliesArguments, WebAPICallResult>;
397 setPurpose: Method<GroupsSetPurposeArguments, WebAPICallResult>;
398 setTopic: Method<GroupsSetTopicArguments, WebAPICallResult>;
399 unarchive: Method<GroupsUnarchiveArguments, WebAPICallResult>;
400 };
401 readonly im: {
402 close: Method<IMCloseArguments, WebAPICallResult>;
403 history: Method<IMHistoryArguments, WebAPICallResult>;
404 list: Method<IMListArguments, WebAPICallResult>;
405 mark: Method<IMMarkArguments, WebAPICallResult>;
406 open: Method<IMOpenArguments, WebAPICallResult>;
407 replies: Method<IMRepliesArguments, WebAPICallResult>;
408 };
409 readonly mpim: {
410 close: Method<MPIMCloseArguments, WebAPICallResult>;
411 history: Method<MPIMHistoryArguments, WebAPICallResult>;
412 list: Method<MPIMListArguments, WebAPICallResult>;
413 mark: Method<MPIMMarkArguments, WebAPICallResult>;
414 open: Method<MPIMOpenArguments, WebAPICallResult>;
415 replies: Method<MPIMRepliesArguments, WebAPICallResult>;
416 };
417}
418/**
419 * Generic method definition
420 */
421export default interface Method<MethodArguments extends WebAPICallOptions, MethodResult extends WebAPICallResult = WebAPICallResult> {
422 (options?: MethodArguments): Promise<MethodResult>;
423}
424export interface TokenOverridable {
425 token?: string;
426}
427export interface LocaleAware {
428 include_locale?: boolean;
429}
430export interface Searchable {
431 query: string;
432 highlight?: boolean;
433 sort: 'score' | 'timestamp';
434 sort_dir: 'asc' | 'desc';
435 team_id?: string;
436}
437export declare const cursorPaginationEnabledMethods: Set<string>;
438export interface CursorPaginationEnabled {
439 limit?: number;
440 cursor?: string;
441}
442export interface TimelinePaginationEnabled {
443 oldest?: string;
444 latest?: string;
445 inclusive?: boolean;
446}
447export interface TraditionalPagingEnabled {
448 page?: number;
449 count?: number;
450}
451export interface AdminAnalyticsGetFileArguments extends WebAPICallOptions, TokenOverridable {
452 type: string;
453 date?: string;
454 metadata_only?: boolean;
455}
456export interface AdminAppsApproveArguments extends WebAPICallOptions, TokenOverridable {
457 app_id?: string;
458 request_id?: string;
459 team_id?: string;
460}
461export interface AdminAppsApprovedListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
462 team_id?: string;
463 enterprise_id?: string;
464}
465export interface AdminAppsClearResolutionArguments extends WebAPICallOptions {
466 app_id: string;
467 enterprise_id?: string;
468 team_id?: string;
469}
470export interface AdminAppsRequestsCancelArguments extends WebAPICallOptions, TokenOverridable {
471 request_id: string;
472 enterprise_id?: string;
473 team_id?: string;
474}
475export interface AdminAppsRequestsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
476 team_id?: string;
477}
478export interface AdminAppsRestrictArguments extends WebAPICallOptions, TokenOverridable {
479 app_id?: string;
480 request_id?: string;
481 team_id?: string;
482}
483export interface AdminAppsRestrictedListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
484 team_id?: string;
485 enterprise_id?: string;
486}
487export interface AdminAppsUninstallArguments extends WebAPICallOptions {
488 app_id: string;
489 enterprise_id?: string;
490 team_ids?: string[];
491}
492export interface AdminAuthPolicyAssignEntitiesArguments extends WebAPICallOptions, TokenOverridable {
493 entity_ids: string[];
494 entity_type: string;
495 policy_name: string;
496}
497export interface AdminAuthPolicyGetEntitiesArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
498 policy_name: string;
499 entity_type?: string;
500}
501export interface AdminAuthPolicyRemoveEntitiesArguments extends WebAPICallOptions, TokenOverridable {
502 entity_ids: string[];
503 entity_type: string;
504 policy_name: string;
505}
506export interface AdminBarriersCreateArguments extends WebAPICallOptions, TokenOverridable {
507 barriered_from_usergroup_ids: string[];
508 primary_usergroup_id: string;
509 restricted_subjects: string[];
510}
511export interface AdminBarriersDeleteArguments extends WebAPICallOptions, TokenOverridable {
512 barrier_id: string;
513}
514export interface AdminBarriersListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
515}
516export interface AdminBarriersUpdateArguments extends WebAPICallOptions, TokenOverridable {
517 barrier_id: string;
518 barriered_from_usergroup_ids: string[];
519 primary_usergroup_id: string;
520 restricted_subjects: string[];
521}
522export interface AdminConversationsArchiveArguments extends WebAPICallOptions, TokenOverridable {
523 channel_id: string;
524}
525export interface AdminConversationsConvertToPrivateArguments extends WebAPICallOptions, TokenOverridable {
526 channel_id: string;
527}
528export interface AdminConversationsCreateArguments extends WebAPICallOptions, TokenOverridable {
529 is_private: boolean;
530 name: string;
531 description?: string;
532 org_wide?: boolean;
533 team_id?: string;
534}
535export interface AdminConversationsDeleteArguments extends WebAPICallOptions, TokenOverridable {
536 channel_id: string;
537}
538export interface AdminConversationsDisconnectSharedArguments extends WebAPICallOptions, TokenOverridable {
539 channel_id: string;
540 leaving_team_ids?: string[];
541}
542export interface AdminConversationsEKMListOriginalConnectedChannelInfoArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
543 channel_ids?: string[];
544 team_ids?: string[];
545}
546export interface AdminConversationsGetConversationPrefsArguments extends WebAPICallOptions, TokenOverridable {
547 channel_id: string;
548}
549export interface AdminConversationsGetTeamsArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
550 channel_id: string;
551}
552export interface AdminConversationsInviteArguments extends WebAPICallOptions, TokenOverridable {
553 channel_id: string;
554 user_ids: string[];
555}
556export interface AdminConversationsRenameArguments extends WebAPICallOptions, TokenOverridable {
557 channel_id: string;
558 name: string;
559}
560export interface AdminConversationsRestrictAccessAddGroupArguments extends WebAPICallOptions, TokenOverridable {
561 channel_id: string;
562 group_id: string;
563 team_id?: string;
564}
565export interface AdminConversationsRestrictAccessListGroupsArguments extends WebAPICallOptions, TokenOverridable {
566 channel_id: string;
567 team_id?: string;
568}
569export interface AdminConversationsRestrictAccessRemoveGroupArguments extends WebAPICallOptions, TokenOverridable {
570 channel_id: string;
571 group_id: string;
572 team_id: string;
573}
574export interface AdminConversationsGetCustomRetentionArguments extends WebAPICallOptions, TokenOverridable {
575 channel_id: string;
576}
577export interface AdminConversationsSetCustomRetentionArguments extends WebAPICallOptions, TokenOverridable {
578 channel_id: string;
579 duration_days: number;
580}
581export interface AdminConversationsRemoveCustomRetentionArguments extends WebAPICallOptions, TokenOverridable {
582 channel_id: string;
583}
584export interface AdminConversationsSearchArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
585 query?: string;
586 search_channel_types?: string[];
587 sort?: 'relevant' | 'name' | 'member_count' | 'created';
588 sort_dir?: 'asc' | 'desc';
589 team_ids?: string[];
590}
591export interface AdminConversationsSetConversationPrefsArguments extends WebAPICallOptions, TokenOverridable {
592 channel_id: string;
593 prefs: Record<string, unknown>;
594}
595export interface AdminConversationsSetTeamsArguments extends WebAPICallOptions, TokenOverridable {
596 channel_id: string;
597 team_id?: string;
598 target_team_ids?: string[];
599 org_channel?: boolean;
600}
601export interface AdminConversationsUnarchiveArguments extends WebAPICallOptions, TokenOverridable {
602 channel_id: string;
603}
604export interface AdminEmojiAddArguments extends WebAPICallOptions, TokenOverridable {
605 name: string;
606 url: string;
607}
608export interface AdminEmojiAddAliasArguments extends WebAPICallOptions, TokenOverridable {
609 name: string;
610 alias_for: string;
611}
612export interface AdminEmojiListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
613}
614export interface AdminEmojiRemoveArguments extends WebAPICallOptions, TokenOverridable {
615 name: string;
616}
617export interface AdminEmojiRenameArguments extends WebAPICallOptions, TokenOverridable {
618 name: string;
619 new_name: string;
620}
621export interface AdminInviteRequestsApproveArguments extends WebAPICallOptions, TokenOverridable {
622 invite_request_id: string;
623 team_id: string;
624}
625export interface AdminInviteRequestsApprovedListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
626 team_id: string;
627}
628export interface AdminInviteRequestsDenyArguments extends WebAPICallOptions, TokenOverridable {
629 invite_request_id: string;
630 team_id: string;
631}
632export interface AdminInviteRequestsDeniedListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
633 team_id: string;
634}
635export interface AdminInviteRequestsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
636 team_id: string;
637}
638export interface AdminTeamsAdminsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
639 team_id: string;
640}
641export interface AdminTeamsCreateArguments extends WebAPICallOptions, TokenOverridable {
642 team_domain: string;
643 team_name: string;
644 team_description?: string;
645 team_discoverability?: string;
646}
647export interface AdminTeamsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
648}
649export interface AdminTeamsOwnersListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
650 team_id: string;
651}
652export interface AdminTeamsSettingsInfoArguments extends WebAPICallOptions, TokenOverridable {
653 team_id: string;
654}
655export interface AdminTeamsSettingsSetDefaultChannelsArguments extends WebAPICallOptions, TokenOverridable {
656 team_id: string;
657 channel_ids: string[];
658}
659export interface AdminTeamsSettingsSetDescriptionArguments extends WebAPICallOptions, TokenOverridable {
660 team_id: string;
661 description: string;
662}
663export interface AdminTeamsSettingsSetDiscoverabilityArguments extends WebAPICallOptions, TokenOverridable {
664 team_id: string;
665 discoverability: 'open' | 'invite_only' | 'closed' | 'unlisted';
666}
667export interface AdminTeamsSettingsSetIconArguments extends WebAPICallOptions, TokenOverridable {
668 team_id: string;
669 image_url: string;
670}
671export interface AdminTeamsSettingsSetNameArguments extends WebAPICallOptions, TokenOverridable {
672 team_id: string;
673 name: string;
674}
675export interface AdminUsergroupsAddChannelsArguments extends WebAPICallOptions, TokenOverridable {
676 usergroup_id: string;
677 team_id?: string;
678 channel_ids: string | string[];
679}
680export interface AdminUsergroupsAddTeamsArguments extends WebAPICallOptions, TokenOverridable {
681 usergroup_id: string;
682 team_ids: string | string[];
683 auto_provision?: boolean;
684}
685export interface AdminUsergroupsListChannelsArguments extends WebAPICallOptions, TokenOverridable {
686 usergroup_id: string;
687 include_num_members?: boolean;
688 team_id?: string;
689}
690export interface AdminUsergroupsRemoveChannelsArguments extends WebAPICallOptions, TokenOverridable {
691 usergroup_id: string;
692 channel_ids: string | string[];
693}
694export interface AdminUsersAssignArguments extends WebAPICallOptions, TokenOverridable {
695 team_id: string;
696 user_id: string;
697 is_restricted?: boolean;
698 is_ultra_restricted?: boolean;
699}
700export interface AdminUsersInviteArguments extends WebAPICallOptions, TokenOverridable {
701 channel_ids: string;
702 email: string;
703 team_id: string;
704 custom_message?: string;
705 email_password_policy_enabled?: boolean;
706 guest_expiration_ts?: string;
707 is_restricted?: boolean;
708 is_ultra_restricted?: boolean;
709 real_name?: string;
710 resend?: boolean;
711}
712export interface AdminUsersListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
713 team_id: string;
714}
715export interface AdminUsersRemoveArguments extends WebAPICallOptions, TokenOverridable {
716 team_id: string;
717 user_id: string;
718}
719export interface AdminUsersSetAdminArguments extends WebAPICallOptions, TokenOverridable {
720 team_id: string;
721 user_id: string;
722}
723export interface AdminUsersSetExpirationArguments extends WebAPICallOptions, TokenOverridable {
724 team_id: string;
725 user_id: string;
726 expiration_ts: number;
727}
728export interface AdminUsersSetOwnerArguments extends WebAPICallOptions, TokenOverridable {
729 team_id: string;
730 user_id: string;
731}
732export interface AdminUsersSetRegularArguments extends WebAPICallOptions, TokenOverridable {
733 team_id: string;
734 user_id: string;
735}
736export interface AdminUsersSessionListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
737 user_id?: string;
738 team_id?: string;
739}
740export interface AdminUsersSessionResetArguments extends WebAPICallOptions, TokenOverridable {
741 user_id: string;
742 mobile_only?: boolean;
743 web_only?: boolean;
744}
745export interface AdminUsersSessionResetBulkArguments extends WebAPICallOptions, TokenOverridable {
746 user_ids: string[];
747 mobile_only?: boolean;
748 web_only?: boolean;
749}
750export interface AdminUsersSessionInvalidateArguments extends WebAPICallOptions, TokenOverridable {
751 session_id: string;
752 team_id: string;
753}
754export interface AdminUsersSessionGetSettingsArguments extends WebAPICallOptions, TokenOverridable {
755 user_ids: string[];
756}
757export interface AdminUsersSessionSetSettingsArguments extends WebAPICallOptions, TokenOverridable {
758 user_ids: string[];
759 desktop_app_browser_quit?: boolean;
760 duration?: number;
761}
762export interface AdminUsersSessionClearSettingsArguments extends WebAPICallOptions, TokenOverridable {
763 user_ids: string[];
764}
765export interface AdminUsersUnsupportedVersionsExportArguments extends WebAPICallOptions, TokenOverridable {
766 date_end_of_support?: number;
767 date_sessions_started?: number;
768}
769export interface APITestArguments extends WebAPICallOptions {
770}
771export interface AppsConnectionsOpenArguments extends WebAPICallOptions {
772}
773export interface AppsEventAuthorizationsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
774 event_context: string;
775}
776export interface AppsUninstallArguments extends WebAPICallOptions {
777 client_id: string;
778 client_secret: string;
779}
780export interface AuthRevokeArguments extends WebAPICallOptions, TokenOverridable {
781 test: boolean;
782}
783export interface AuthTeamsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
784 include_icon?: boolean;
785}
786export interface AuthTestArguments extends WebAPICallOptions, TokenOverridable {
787}
788export interface BotsInfoArguments extends WebAPICallOptions, TokenOverridable {
789 bot?: string;
790 team_id?: string;
791}
792export interface BookmarksAddArguments extends WebAPICallOptions, TokenOverridable {
793 channel_id: string;
794 title: string;
795 type: string;
796 emoji?: string;
797 entity_id?: string;
798 link?: string;
799 parent_id?: string;
800}
801export interface BookmarksEditArguments extends WebAPICallOptions, TokenOverridable {
802 bookmark_id: string;
803 channel_id: string;
804 emoji?: string;
805 link?: string;
806 title?: string;
807}
808export interface BookmarksListArguments extends WebAPICallOptions, TokenOverridable {
809 channel_id: string;
810}
811export interface BookmarksRemoveArguments extends WebAPICallOptions, TokenOverridable {
812 bookmark_id: string;
813 channel_id: string;
814}
815export interface CallsAddArguments extends WebAPICallOptions, TokenOverridable {
816 external_unique_id: string;
817 join_url: string;
818 created_by?: string;
819 date_start?: number;
820 desktop_app_join_url?: string;
821 external_display_id?: string;
822 title?: string;
823 users?: CallUser[];
824}
825export interface CallsEndArguments extends WebAPICallOptions, TokenOverridable {
826 id: string;
827 duration?: number;
828}
829export interface CallsInfoArguments extends WebAPICallOptions, TokenOverridable {
830 id: string;
831}
832export interface CallsUpdateArguments extends WebAPICallOptions, TokenOverridable {
833 id: string;
834 join_url?: string;
835 desktop_app_join_url?: string;
836 title?: string;
837}
838export interface CallsParticipantsAddArguments extends WebAPICallOptions, TokenOverridable {
839 id: string;
840 users: CallUser[];
841}
842export interface CallsParticipantsRemoveArguments extends WebAPICallOptions, TokenOverridable {
843 id: string;
844 users: CallUser[];
845}
846export interface ChannelsArchiveArguments extends WebAPICallOptions, TokenOverridable {
847 channel: string;
848}
849export interface ChannelsCreateArguments extends WebAPICallOptions, TokenOverridable {
850 name: string;
851 validate?: boolean;
852 team_id?: string;
853}
854export interface ChannelsHistoryArguments extends WebAPICallOptions, TokenOverridable, TimelinePaginationEnabled {
855 channel: string;
856 count?: number;
857 unreads?: boolean;
858}
859export interface ChannelsInfoArguments extends WebAPICallOptions, TokenOverridable, LocaleAware {
860 channel: string;
861}
862export interface ChannelsInviteArguments extends WebAPICallOptions, TokenOverridable {
863 channel: string;
864 user: string;
865}
866export interface ChannelsJoinArguments extends WebAPICallOptions, TokenOverridable {
867 name: string;
868 validate?: boolean;
869}
870export interface ChannelsKickArguments extends WebAPICallOptions, TokenOverridable {
871 channel: string;
872 user: string;
873}
874export interface ChannelsLeaveArguments extends WebAPICallOptions, TokenOverridable {
875 channel: string;
876}
877export interface ChannelsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
878 exclude_archived?: boolean;
879 exclude_members?: boolean;
880 team_id?: string;
881}
882export interface ChannelsMarkArguments extends WebAPICallOptions, TokenOverridable {
883 channel: string;
884 ts: string;
885}
886export interface ChannelsRenameArguments extends WebAPICallOptions, TokenOverridable {
887 channel: string;
888 name: string;
889 validate?: boolean;
890}
891export interface ChannelsRepliesArguments extends WebAPICallOptions, TokenOverridable {
892 channel: string;
893 thread_ts: string;
894}
895export interface ChannelsSetPurposeArguments extends WebAPICallOptions, TokenOverridable {
896 channel: string;
897 purpose: string;
898}
899export interface ChannelsSetTopicArguments extends WebAPICallOptions, TokenOverridable {
900 channel: string;
901 topic: string;
902}
903export interface ChannelsUnarchiveArguments extends WebAPICallOptions, TokenOverridable {
904 channel: string;
905}
906export interface ChatDeleteArguments extends WebAPICallOptions, TokenOverridable {
907 channel: string;
908 ts: string;
909 as_user?: boolean;
910}
911export interface ChatDeleteScheduledMessageArguments extends WebAPICallOptions, TokenOverridable {
912 channel: string;
913 scheduled_message_id: string;
914 as_user?: boolean;
915}
916export interface ChatGetPermalinkArguments extends WebAPICallOptions, TokenOverridable {
917 channel: string;
918 message_ts: string;
919}
920export interface ChatMeMessageArguments extends WebAPICallOptions, TokenOverridable {
921 channel: string;
922 text: string;
923}
924export interface ChatPostEphemeralArguments extends WebAPICallOptions, TokenOverridable {
925 channel: string;
926 text?: string;
927 user: string;
928 as_user?: boolean;
929 attachments?: MessageAttachment[];
930 blocks?: (KnownBlock | Block)[];
931 link_names?: boolean;
932 parse?: 'full' | 'none';
933 thread_ts?: string;
934 icon_emoji?: string;
935 icon_url?: string;
936 username?: string;
937}
938export interface ChatPostMessageArguments extends WebAPICallOptions, TokenOverridable {
939 channel: string;
940 text?: string;
941 as_user?: boolean;
942 attachments?: MessageAttachment[];
943 blocks?: (KnownBlock | Block)[];
944 icon_emoji?: string;
945 icon_url?: string;
946 metadata?: MessageMetadata;
947 link_names?: boolean;
948 mrkdwn?: boolean;
949 parse?: 'full' | 'none';
950 reply_broadcast?: boolean;
951 thread_ts?: string;
952 unfurl_links?: boolean;
953 unfurl_media?: boolean;
954 username?: string;
955}
956export interface ChatScheduleMessageArguments extends WebAPICallOptions, TokenOverridable {
957 channel: string;
958 text?: string;
959 post_at: string | number;
960 as_user?: boolean;
961 attachments?: MessageAttachment[];
962 blocks?: (KnownBlock | Block)[];
963 metadata?: MessageMetadata;
964 link_names?: boolean;
965 parse?: 'full' | 'none';
966 reply_broadcast?: boolean;
967 thread_ts?: string;
968 unfurl_links?: boolean;
969 unfurl_media?: boolean;
970 team_id?: string;
971}
972export interface ChatScheduledMessagesListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
973 channel: string;
974 latest: number;
975 oldest: number;
976 team_id?: string;
977}
978interface ChannelAndTSArguments {
979 /**
980 * @description Channel ID of the message. Both `channel` and `ts` must be provided together, or `unfurl_id` and
981 * `source` must be provided together.
982 */
983 channel: string;
984 /**
985 * @description Timestamp of the message to add unfurl behavior to.
986 */
987 ts: string;
988}
989interface SourceAndUnfurlIDArguments {
990 /**
991 * @description The source of the link to unfurl. The source may either be `composer`, when the link is inside the
992 * message composer, or `conversations_history`, when the link has been posted to a conversation.
993 */
994 source: 'composer' | 'conversations_history';
995 /**
996 * @description The ID of the link to unfurl. Both `unfurl_id` and `source` must be provided together, or `channel`
997 * and `ts` must be provided together.
998 */
999 unfurl_id: string;
1000}
1001export declare type ChatUnfurlArguments = (ChannelAndTSArguments | SourceAndUnfurlIDArguments) & WebAPICallOptions & TokenOverridable & {
1002 /**
1003 * @description URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl
1004 * blocks or message attachments.
1005 */
1006 unfurls: LinkUnfurls;
1007 /**
1008 * @description Provide a simply-formatted string to send as an ephemeral message to the user as invitation to
1009 * authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again.
1010 */
1011 user_auth_message?: string;
1012 /**
1013 * @description Set to `true` to indicate the user must install your Slack app to trigger unfurls for this domain.
1014 * Defaults to `false`.
1015 */
1016 user_auth_required?: boolean;
1017 /**
1018 * @description Send users to this custom URL where they will complete authentication in your app to fully trigger
1019 * unfurling. Value should be properly URL-encoded.
1020 */
1021 user_auth_url?: string;
1022 /**
1023 * @description Provide a JSON based array of structured blocks presented as URL-encoded string to send as an
1024 * ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.
1025 */
1026 user_auth_blocks?: (KnownBlock | Block)[];
1027};
1028export interface ChatUpdateArguments extends WebAPICallOptions, TokenOverridable {
1029 channel: string;
1030 ts: string;
1031 as_user?: boolean;
1032 attachments?: MessageAttachment[];
1033 blocks?: (KnownBlock | Block)[];
1034 link_names?: boolean;
1035 metadata?: MessageMetadata;
1036 parse?: 'full' | 'none';
1037 file_ids?: string[];
1038 reply_broadcast?: boolean;
1039 text?: string;
1040}
1041export interface ConversationsAcceptSharedInviteArguments extends WebAPICallOptions, TokenOverridable {
1042 channel_name: string;
1043 channel_id?: string;
1044 free_trial_accepted?: boolean;
1045 invite_id?: string;
1046 is_private?: boolean;
1047 team_id?: string;
1048}
1049export interface ConversationsApproveSharedInviteArguments extends WebAPICallOptions, TokenOverridable {
1050 invite_id: string;
1051 target_team?: string;
1052}
1053export interface ConversationsArchiveArguments extends WebAPICallOptions, TokenOverridable {
1054 channel: string;
1055}
1056export interface ConversationsCloseArguments extends WebAPICallOptions, TokenOverridable {
1057 channel: string;
1058}
1059export interface ConversationsCreateArguments extends WebAPICallOptions, TokenOverridable {
1060 name: string;
1061 is_private?: boolean;
1062 team_id?: string;
1063}
1064export interface ConversationsDeclineSharedInviteArguments extends WebAPICallOptions, TokenOverridable {
1065 invite_id: string;
1066 target_team?: string;
1067}
1068export interface ConversationsHistoryArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled, TimelinePaginationEnabled {
1069 channel: string;
1070 include_all_metadata?: boolean;
1071}
1072export interface ConversationsInfoArguments extends WebAPICallOptions, TokenOverridable, LocaleAware {
1073 channel: string;
1074 include_num_members?: boolean;
1075}
1076export interface ConversationsInviteArguments extends WebAPICallOptions, TokenOverridable {
1077 channel: string;
1078 users: string;
1079}
1080export interface ConversationsInviteSharedArguments extends WebAPICallOptions, TokenOverridable {
1081 channel: string;
1082 emails?: string[];
1083 user_ids?: string[];
1084}
1085export interface ConversationsJoinArguments extends WebAPICallOptions, TokenOverridable {
1086 channel: string;
1087}
1088export interface ConversationsKickArguments extends WebAPICallOptions, TokenOverridable {
1089 channel: string;
1090 user: string;
1091}
1092export interface ConversationsLeaveArguments extends WebAPICallOptions, TokenOverridable {
1093 channel: string;
1094}
1095export interface ConversationsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
1096 exclude_archived?: boolean;
1097 types?: string;
1098 team_id?: string;
1099}
1100export interface ConversationsListConnectInvitesArguments extends WebAPICallOptions, TokenOverridable {
1101 count?: number;
1102 cursor?: string;
1103 team_id?: string;
1104}
1105export interface ConversationsMarkArguments extends WebAPICallOptions, TokenOverridable {
1106 channel: string;
1107 ts: string;
1108}
1109export interface ConversationsMembersArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
1110 channel: string;
1111}
1112export interface ConversationsOpenArguments extends WebAPICallOptions, TokenOverridable {
1113 channel?: string;
1114 users?: string;
1115 return_im?: boolean;
1116}
1117export interface ConversationsRenameArguments extends WebAPICallOptions, TokenOverridable {
1118 channel: string;
1119 name: string;
1120}
1121export interface ConversationsRepliesArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled, TimelinePaginationEnabled {
1122 channel: string;
1123 ts: string;
1124 include_all_metadata?: boolean;
1125}
1126export interface ConversationsSetPurposeArguments extends WebAPICallOptions, TokenOverridable {
1127 channel: string;
1128 purpose: string;
1129}
1130export interface ConversationsSetTopicArguments extends WebAPICallOptions, TokenOverridable {
1131 channel: string;
1132 topic: string;
1133}
1134export interface ConversationsUnarchiveArguments extends WebAPICallOptions, TokenOverridable {
1135 channel: string;
1136}
1137export interface DialogOpenArguments extends WebAPICallOptions, TokenOverridable {
1138 trigger_id: string;
1139 dialog: Dialog;
1140}
1141export interface DndEndDndArguments extends WebAPICallOptions, TokenOverridable {
1142}
1143export interface DndEndSnoozeArguments extends WebAPICallOptions, TokenOverridable {
1144}
1145export interface DndInfoArguments extends WebAPICallOptions, TokenOverridable {
1146 user: string;
1147}
1148export interface DndSetSnoozeArguments extends WebAPICallOptions, TokenOverridable {
1149 num_minutes: number;
1150}
1151export interface DndTeamInfoArguments extends WebAPICallOptions, TokenOverridable {
1152 users?: string;
1153}
1154export interface EmojiListArguments extends WebAPICallOptions, TokenOverridable {
1155}
1156export interface FilesDeleteArguments extends WebAPICallOptions, TokenOverridable {
1157 file: string;
1158}
1159export interface FilesInfoArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
1160 file: string;
1161 count?: number;
1162 page?: number;
1163}
1164export interface FilesListArguments extends WebAPICallOptions, TokenOverridable, TraditionalPagingEnabled {
1165 channel?: string;
1166 user?: string;
1167 ts_from?: string;
1168 ts_to?: string;
1169 types?: string;
1170 show_files_hidden_by_limit?: boolean;
1171 team_id?: string;
1172}
1173export interface FilesRevokePublicURLArguments extends WebAPICallOptions, TokenOverridable {
1174 file: string;
1175}
1176export interface FilesSharedPublicURLArguments extends WebAPICallOptions, TokenOverridable {
1177 file: string;
1178}
1179/**
1180 * Legacy files.upload API files upload arguments
1181 * */
1182export interface FilesUploadArguments extends FileUpload, WebAPICallOptions, TokenOverridable {
1183}
1184interface FileUpload {
1185 channels?: string;
1186 content?: string;
1187 file?: Buffer | Stream | string;
1188 filename?: string;
1189 filetype?: string;
1190 initial_comment?: string;
1191 thread_ts?: string;
1192 title?: string;
1193}
1194export interface FilesUploadV2Arguments extends FileUploadV2, WebAPICallOptions, TokenOverridable {
1195 file_uploads?: Omit<FileUploadV2, 'channel_id' | 'channels' | 'initial_comment' | 'thread_ts'>[];
1196 request_file_info?: boolean;
1197}
1198export declare type FileUploadV2 = FileUpload & {
1199 alt_text?: string;
1200 channel_id?: string;
1201 snippet_type?: string;
1202};
1203export interface FileUploadV2Job extends FileUploadV2, Pick<FilesGetUploadURLExternalResponse, 'file_id' | 'upload_url' | 'error'> {
1204 length?: number;
1205 data?: Buffer;
1206}
1207/**
1208 * Gets a URL for an edge external file upload. Method:
1209 * {@link https://api.slack.com/methods/files.getUploadURLExternal files.getUploadURLExternal}
1210*/
1211export interface FilesGetUploadURLExternalArguments extends WebAPICallOptions, TokenOverridable {
1212 filename: string;
1213 length: number;
1214 alt_text?: string;
1215 snippet_type?: string;
1216}
1217/**
1218 * Finishes an upload started with files.getUploadURLExternal. Method:
1219 * {@link https://api.slack.com/methods/files.completeUploadExternal files.completeUploadExternal}
1220 * */
1221export interface FilesCompleteUploadExternalArguments extends WebAPICallOptions, TokenOverridable {
1222 files: FileUploadComplete[];
1223 channel_id?: string;
1224 initial_comment?: string;
1225 thread_ts?: string;
1226}
1227interface FileUploadComplete {
1228 id: string;
1229 title?: string;
1230}
1231export interface FilesCommentsDeleteArguments extends WebAPICallOptions, TokenOverridable {
1232 file: string;
1233 id: string;
1234}
1235export interface FilesRemoteInfoArguments extends WebAPICallOptions, TokenOverridable {
1236 file?: string;
1237 external_id?: string;
1238}
1239export interface FilesRemoteListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
1240 ts_from?: string;
1241 ts_to?: string;
1242 channel?: string;
1243}
1244export interface FilesRemoteAddArguments extends WebAPICallOptions, TokenOverridable {
1245 title: string;
1246 external_url: string;
1247 external_id: string;
1248 filetype: string;
1249 preview_image?: Buffer | Stream;
1250 indexable_file_contents?: Buffer | Stream;
1251}
1252export interface FilesRemoteUpdateArguments extends WebAPICallOptions, TokenOverridable {
1253 title?: string;
1254 external_url?: string;
1255 filetype?: string;
1256 preview_image?: Buffer | Stream;
1257 indexable_file_contents?: Buffer | Stream;
1258 file?: string;
1259 external_id?: string;
1260}
1261export interface FilesRemoteRemoveArguments extends WebAPICallOptions, TokenOverridable {
1262 file?: string;
1263 external_id?: string;
1264}
1265export interface FilesRemoteShareArguments extends WebAPICallOptions, TokenOverridable {
1266 channels: string;
1267 file?: string;
1268 external_id?: string;
1269}
1270export interface GroupsArchiveArguments extends WebAPICallOptions, TokenOverridable {
1271 channel: string;
1272}
1273export interface GroupsCreateArguments extends WebAPICallOptions, TokenOverridable {
1274 name: string;
1275 validate?: boolean;
1276 team_id?: string;
1277}
1278export interface GroupsCreateChildArguments extends WebAPICallOptions, TokenOverridable {
1279 channel: string;
1280}
1281export interface GroupsHistoryArguments extends WebAPICallOptions, TokenOverridable, TimelinePaginationEnabled {
1282 channel: string;
1283 unreads?: boolean;
1284 count?: number;
1285}
1286export interface GroupsInfoArguments extends WebAPICallOptions, TokenOverridable, LocaleAware {
1287 channel: string;
1288}
1289export interface GroupsInviteArguments extends WebAPICallOptions, TokenOverridable {
1290 channel: string;
1291 user: string;
1292}
1293export interface GroupsKickArguments extends WebAPICallOptions, TokenOverridable {
1294 channel: string;
1295 user: string;
1296}
1297export interface GroupsLeaveArguments extends WebAPICallOptions, TokenOverridable {
1298 channel: string;
1299}
1300export interface GroupsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
1301 exclude_archived?: boolean;
1302 exclude_members?: boolean;
1303 team_id?: string;
1304}
1305export interface GroupsMarkArguments extends WebAPICallOptions, TokenOverridable {
1306 channel: string;
1307 ts: string;
1308}
1309export interface GroupsOpenArguments extends WebAPICallOptions, TokenOverridable {
1310 channel: string;
1311}
1312export interface GroupsRenameArguments extends WebAPICallOptions, TokenOverridable {
1313 channel: string;
1314 name: string;
1315 validate?: boolean;
1316}
1317export interface GroupsRepliesArguments extends WebAPICallOptions, TokenOverridable {
1318 channel: string;
1319 thread_ts: boolean;
1320}
1321export interface GroupsSetPurposeArguments extends WebAPICallOptions, TokenOverridable {
1322 channel: string;
1323 purpose: string;
1324}
1325export interface GroupsSetTopicArguments extends WebAPICallOptions, TokenOverridable {
1326 channel: string;
1327 topic: string;
1328}
1329export interface GroupsUnarchiveArguments extends WebAPICallOptions, TokenOverridable {
1330 channel: string;
1331}
1332export interface IMCloseArguments extends WebAPICallOptions, TokenOverridable {
1333 channel: string;
1334}
1335export interface IMHistoryArguments extends WebAPICallOptions, TokenOverridable, TimelinePaginationEnabled {
1336 channel: string;
1337 count?: number;
1338 unreads?: boolean;
1339}
1340export interface IMListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
1341}
1342export interface IMMarkArguments extends WebAPICallOptions, TokenOverridable {
1343 channel: string;
1344 ts: string;
1345}
1346export interface IMOpenArguments extends WebAPICallOptions, TokenOverridable, LocaleAware {
1347 user: string;
1348 return_im?: boolean;
1349}
1350export interface IMRepliesArguments extends WebAPICallOptions, TokenOverridable {
1351 channel: string;
1352 thread_ts?: string;
1353}
1354export interface MigrationExchangeArguments extends WebAPICallOptions, TokenOverridable {
1355 users: string;
1356 to_old?: boolean;
1357 team_id?: string;
1358}
1359export interface MPIMCloseArguments extends WebAPICallOptions, TokenOverridable {
1360 channel: string;
1361}
1362export interface MPIMHistoryArguments extends WebAPICallOptions, TokenOverridable, TimelinePaginationEnabled {
1363 channel: string;
1364 count?: number;
1365 unreads?: boolean;
1366}
1367export interface MPIMListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
1368}
1369export interface MPIMMarkArguments extends WebAPICallOptions, TokenOverridable {
1370 channel: string;
1371 ts: string;
1372}
1373export interface MPIMOpenArguments extends WebAPICallOptions, TokenOverridable {
1374 users: string;
1375}
1376export interface MPIMRepliesArguments extends WebAPICallOptions, TokenOverridable {
1377 channel: string;
1378 thread_ts: string;
1379}
1380export interface OAuthAccessArguments extends WebAPICallOptions {
1381 client_id: string;
1382 client_secret: string;
1383 code: string;
1384 redirect_uri?: string;
1385 single_channel?: string;
1386}
1387export interface OAuthV2AccessArguments extends WebAPICallOptions {
1388 client_id: string;
1389 client_secret: string;
1390 code?: string;
1391 redirect_uri?: string;
1392 grant_type?: string;
1393 refresh_token?: string;
1394}
1395export interface OAuthV2ExchangeArguments extends WebAPICallOptions {
1396 client_id: string;
1397 client_secret: string;
1398}
1399export interface OpenIDConnectTokenArguments extends WebAPICallOptions {
1400 client_id: string;
1401 client_secret: string;
1402 code?: string;
1403 redirect_uri?: string;
1404 grant_type?: 'authorization_code' | 'refresh_token';
1405 refresh_token?: string;
1406}
1407export interface OpenIDConnectUserInfoArguments extends WebAPICallOptions {
1408}
1409export interface PinsAddArguments extends WebAPICallOptions, TokenOverridable {
1410 channel: string;
1411 timestamp: string;
1412}
1413export interface PinsListArguments extends WebAPICallOptions, TokenOverridable {
1414 channel: string;
1415}
1416export interface PinsRemoveArguments extends WebAPICallOptions, TokenOverridable {
1417 channel: string;
1418 timestamp: string;
1419}
1420export interface ReactionsAddArguments extends WebAPICallOptions, TokenOverridable {
1421 name: string;
1422 channel?: string;
1423 timestamp?: string;
1424 file?: string;
1425 file_comment?: string;
1426}
1427export interface ReactionsGetArguments extends WebAPICallOptions, TokenOverridable {
1428 full?: boolean;
1429 channel?: string;
1430 timestamp?: string;
1431 file?: string;
1432 file_comment?: string;
1433}
1434export interface ReactionsListArguments extends WebAPICallOptions, TokenOverridable, TraditionalPagingEnabled, CursorPaginationEnabled {
1435 user?: string;
1436 full?: boolean;
1437 team_id?: string;
1438}
1439export interface ReactionsRemoveArguments extends WebAPICallOptions, TokenOverridable {
1440 name: string;
1441 channel?: string;
1442 timestamp?: string;
1443 file?: string;
1444 file_comment?: string;
1445}
1446export interface RemindersAddArguments extends WebAPICallOptions, TokenOverridable {
1447 text: string;
1448 time: string | number;
1449 user?: string;
1450}
1451export interface RemindersCompleteArguments extends WebAPICallOptions, TokenOverridable {
1452 reminder: string;
1453}
1454export interface RemindersDeleteArguments extends WebAPICallOptions, TokenOverridable {
1455 reminder: string;
1456}
1457export interface RemindersInfoArguments extends WebAPICallOptions, TokenOverridable {
1458 reminder: string;
1459}
1460export interface RemindersListArguments extends WebAPICallOptions, TokenOverridable {
1461}
1462export interface RTMConnectArguments extends WebAPICallOptions, TokenOverridable {
1463 batch_presence_aware?: boolean;
1464 presence_sub?: boolean;
1465}
1466export interface RTMStartArguments extends WebAPICallOptions, TokenOverridable, LocaleAware {
1467 batch_presence_aware?: boolean;
1468 mpim_aware?: boolean;
1469 no_latest?: '0' | '1';
1470 no_unreads?: string;
1471 presence_sub?: boolean;
1472 simple_latest?: boolean;
1473}
1474export interface SearchAllArguments extends WebAPICallOptions, TokenOverridable, TraditionalPagingEnabled, Searchable {
1475}
1476export interface SearchFilesArguments extends WebAPICallOptions, TokenOverridable, TraditionalPagingEnabled, Searchable {
1477}
1478export interface SearchMessagesArguments extends WebAPICallOptions, TokenOverridable, TraditionalPagingEnabled, Searchable {
1479}
1480export interface StarsAddArguments extends WebAPICallOptions, TokenOverridable {
1481 channel?: string;
1482 timestamp?: string;
1483 file?: string;
1484 file_comment?: string;
1485}
1486export interface StarsListArguments extends WebAPICallOptions, TokenOverridable, TraditionalPagingEnabled, CursorPaginationEnabled {
1487}
1488export interface StarsRemoveArguments extends WebAPICallOptions, TokenOverridable {
1489 channel?: string;
1490 timestamp?: string;
1491 file?: string;
1492 file_comment?: string;
1493}
1494export interface TeamAccessLogsArguments extends WebAPICallOptions, TokenOverridable {
1495 before?: number;
1496 count?: number;
1497 page?: number;
1498 team_id?: string;
1499}
1500export interface TeamBillableInfoArguments extends WebAPICallOptions, TokenOverridable {
1501 user?: string;
1502 team_id?: string;
1503}
1504export interface TeamBillingInfoArguments extends WebAPICallOptions, TokenOverridable {
1505}
1506export interface TeamInfoArguments extends WebAPICallOptions, TokenOverridable {
1507 team?: string;
1508 domain?: string;
1509}
1510export interface TeamIntegrationLogsArguments extends WebAPICallOptions, TokenOverridable {
1511 app_id?: string;
1512 change_type?: string;
1513 count?: number;
1514 page?: number;
1515 service_id?: string;
1516 user?: string;
1517 team_id?: string;
1518}
1519export interface TeamProfileGetArguments extends WebAPICallOptions, TokenOverridable {
1520 visibility?: 'all' | 'visible' | 'hidden';
1521 team_id?: string;
1522}
1523export interface TeamPreferencesListArguments extends WebAPICallOptions, TokenOverridable {
1524}
1525export interface UsergroupsCreateArguments extends WebAPICallOptions, TokenOverridable {
1526 name: string;
1527 channels?: string;
1528 description?: string;
1529 handle?: string;
1530 include_count?: boolean;
1531}
1532export interface UsergroupsDisableArguments extends WebAPICallOptions, TokenOverridable {
1533 usergroup: string;
1534 include_count?: boolean;
1535}
1536export interface UsergroupsEnableArguments extends WebAPICallOptions, TokenOverridable {
1537 usergroup: string;
1538 include_count?: boolean;
1539}
1540export interface UsergroupsListArguments extends WebAPICallOptions, TokenOverridable {
1541 include_count?: boolean;
1542 include_disabled?: boolean;
1543 include_users?: boolean;
1544}
1545export interface UsergroupsUpdateArguments extends WebAPICallOptions, TokenOverridable {
1546 usergroup: string;
1547 channels?: string;
1548 description?: string;
1549 handle?: string;
1550 include_count?: boolean;
1551 name?: string;
1552}
1553export interface UsergroupsUsersListArguments extends WebAPICallOptions, TokenOverridable {
1554 usergroup: string;
1555 include_disabled?: boolean;
1556}
1557export interface UsergroupsUsersUpdateArguments extends WebAPICallOptions, TokenOverridable {
1558 usergroup: string;
1559 users: string;
1560 include_count?: boolean;
1561}
1562export interface UsersConversationsArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled {
1563 exclude_archived?: boolean;
1564 types?: string;
1565 user?: string;
1566 team_id?: string;
1567}
1568export interface UsersDeletePhotoArguments extends WebAPICallOptions, TokenOverridable {
1569}
1570export interface UsersGetPresenceArguments extends WebAPICallOptions, TokenOverridable {
1571 user: string;
1572}
1573export interface UsersIdentityArguments extends WebAPICallOptions, TokenOverridable {
1574}
1575export interface UsersInfoArguments extends WebAPICallOptions, TokenOverridable, LocaleAware {
1576 user: string;
1577}
1578export interface UsersListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled, LocaleAware {
1579 presence?: boolean;
1580 team_id?: string;
1581}
1582export interface UsersLookupByEmailArguments extends WebAPICallOptions, TokenOverridable {
1583 email: string;
1584}
1585export interface UsersSetPhotoArguments extends WebAPICallOptions, TokenOverridable {
1586 image: Buffer | Stream;
1587 crop_w?: number;
1588 crop_x?: number;
1589 crop_y?: number;
1590}
1591export interface UsersSetPresenceArguments extends WebAPICallOptions, TokenOverridable {
1592 presence: 'auto' | 'away';
1593}
1594export interface UsersProfileGetArguments extends WebAPICallOptions, TokenOverridable {
1595 include_labels?: boolean;
1596 user?: string;
1597}
1598export interface UsersProfileSetArguments extends WebAPICallOptions, TokenOverridable {
1599 profile?: string;
1600 user?: string;
1601 name?: string;
1602 value?: string;
1603}
1604export interface ViewsOpenArguments extends WebAPICallOptions, TokenOverridable {
1605 trigger_id: string;
1606 view: View;
1607}
1608export interface ViewsPushArguments extends WebAPICallOptions, TokenOverridable {
1609 trigger_id: string;
1610 view: View;
1611}
1612export interface ViewsPublishArguments extends WebAPICallOptions, TokenOverridable {
1613 user_id: string;
1614 view: View;
1615 hash?: string;
1616}
1617export interface ViewsUpdateArguments extends WebAPICallOptions, TokenOverridable {
1618 view_id?: string;
1619 view: View;
1620 external_id?: string;
1621 hash?: string;
1622}
1623export interface WorkflowsStepCompletedArguments extends WebAPICallOptions, TokenOverridable {
1624 workflow_step_execute_id: string;
1625 outputs?: Record<string, unknown>;
1626}
1627export interface WorkflowsStepFailedArguments extends WebAPICallOptions, TokenOverridable {
1628 workflow_step_execute_id: string;
1629 error: {
1630 message: string;
1631 };
1632}
1633export interface WorkflowsUpdateStepArguments extends WebAPICallOptions, TokenOverridable {
1634 workflow_step_edit_id: string;
1635 step_image_url?: string;
1636 step_name?: string;
1637 inputs?: {
1638 [name: string]: {
1639 value: any;
1640 skip_variable_replacement?: boolean;
1641 variables?: {
1642 [key: string]: any;
1643 };
1644 };
1645 };
1646 outputs?: {
1647 type: string;
1648 name: string;
1649 label: string;
1650 }[];
1651}
1652export * from '@slack/types';
1653//# sourceMappingURL=methods.d.ts.map
\No newline at end of file