UNPKG

93.2 kBTypeScriptView Raw
1import { EventEmitter } from 'eventemitter3';
2import { WebAPICallResult, WebClientEvent } from './WebClient';
3import type { 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, AdminConversationsBulkArchiveResponse, AdminConversationsBulkDeleteResponse, AdminConversationsBulkMoveResponse, 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, AppsManifestCreateResponse, AppsManifestDeleteResponse, AppsManifestExportResponse, AppsManifestUpdateResponse, AppsManifestValidateResponse, 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, FunctionsCompleteErrorResponse, FunctionsCompleteSuccessResponse, 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, ToolingTokensRotateResponse, 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, AdminConversationsConvertToPublicResponse, AdminConversationsLookupResponse, AdminRolesAddAssignmentsResponse, AdminRolesListAssignmentsResponse, AdminRolesRemoveAssignmentsResponse, AdminAppsActivitiesListResponse, AdminFunctionsListResponse, AdminFunctionsPermissionsLookupResponse, AdminFunctionsPermissionsSetResponse, AdminWorkflowsSearchResponse, AdminWorkflowsUnpublishResponse, AdminWorkflowsCollaboratorsAddResponse, AdminWorkflowsCollaboratorsRemoveResponse, AdminWorkflowsPermissionsLookupResponse, AdminAppsConfigLookupResponse, AdminAppsConfigSetResponse } from './types/response/index';
4import type { WorkflowsStepCompletedArguments, WorkflowsStepFailedArguments, WorkflowsUpdateStepArguments, ViewsUpdateArguments, ViewsOpenArguments, ViewsPushArguments, ViewsPublishArguments, UsersConversationsArguments, UsersInfoArguments, UsersListArguments, UsersIdentityArguments, UsersSetPhotoArguments, UsersProfileGetArguments, UsersProfileSetArguments, UsersDeletePhotoArguments, UsersGetPresenceArguments, UsersSetPresenceArguments, UsersLookupByEmailArguments, ToolingTokensRotateArguments, SearchAllArguments, SearchFilesArguments, SearchMessagesArguments, UsergroupsCreateArguments, UsergroupsDisableArguments, UsergroupsEnableArguments, UsergroupsListArguments, UsergroupsUpdateArguments, UsergroupsUsersListArguments, UsergroupsUsersUpdateArguments, TeamAccessLogsArguments, TeamBillableInfoArguments, TeamBillingInfoArguments, TeamInfoArguments, TeamIntegrationLogsArguments, TeamPreferencesListArguments, TeamProfileGetArguments, StarsAddRemoveArguments, StarsListArguments, RTMConnectArguments, RTMStartArguments, RemindersAddArguments, RemindersInfoArguments, RemindersListArguments, RemindersDeleteArguments, RemindersCompleteArguments, ReactionsAddArguments, ReactionsGetArguments, ReactionsListArguments, ReactionsRemoveArguments, PinsAddArguments, PinsListArguments, PinsRemoveArguments, OpenIDConnectTokenArguments, OpenIDConnectUserInfoArguments, OAuthAccessArguments, OAuthV2AccessArguments, OAuthV2ExchangeArguments, MigrationExchangeArguments, FilesDeleteArguments, FunctionsCompleteErrorArguments, FunctionsCompleteSuccessArguments, FilesInfoArguments, FilesListArguments, FilesRevokePublicURLArguments, FilesSharedPublicURLArguments, FilesUploadArguments, FilesUploadV2Arguments, FilesCompleteUploadExternalArguments, FilesGetUploadURLExternalArguments, FilesCommentsDeleteArguments, FilesRemoteUpdateArguments, FilesRemoteRemoveArguments, FilesRemoteShareArguments, FilesRemoteListArguments, FilesRemoteInfoArguments, FilesRemoteAddArguments, EmojiListArguments, DndEndDndArguments, DndEndSnoozeArguments, DndInfoArguments, DndSetSnoozeArguments, DndTeamInfoArguments, DialogOpenArguments, ConversationsAcceptSharedInviteArguments, ConversationsApproveSharedInviteArguments, ConversationsArchiveArguments, ConversationsCloseArguments, ConversationsCreateArguments, ConversationsDeclineSharedInviteArguments, ConversationsHistoryArguments, ConversationsInfoArguments, ConversationsInviteArguments, ConversationsInviteSharedArguments, ConversationsJoinArguments, ConversationsKickArguments, ConversationsLeaveArguments, ConversationsListArguments, ConversationsListConnectInvitesArguments, ConversationsMarkArguments, ConversationsMembersArguments, ConversationsOpenArguments, ConversationsRenameArguments, ConversationsRepliesArguments, ConversationsSetPurposeArguments, ConversationsSetTopicArguments, ConversationsUnarchiveArguments, ChatDeleteArguments, ChatDeleteScheduledMessageArguments, ChatGetPermalinkArguments, ChatMeMessageArguments, ChatPostEphemeralArguments, ChatPostMessageArguments, ChatScheduleMessageArguments, ChatScheduledMessagesListArguments, ChatUnfurlArguments, ChatUpdateArguments, CallsAddArguments, CallsEndArguments, CallsInfoArguments, CallsUpdateArguments, CallsParticipantsAddArguments, CallsParticipantsRemoveArguments, BotsInfoArguments, BookmarksAddArguments, BookmarksEditArguments, BookmarksListArguments, BookmarksRemoveArguments, AuthRevokeArguments, AuthTestArguments, AuthTeamsListArguments, AppsConnectionsOpenArguments, AppsEventAuthorizationsListArguments, AppsManifestCreateArguments, AppsManifestDeleteArguments, AppsManifestExportArguments, AppsManifestUpdateArguments, AppsManifestValidateArguments, AppsUninstallArguments, APITestArguments, AdminAnalyticsGetFileArguments, AdminAppsActivitiesListArguments, AdminAppsApproveArguments, AdminAppsApprovedListArguments, AdminAppsClearResolutionArguments, AdminAppsConfigLookupArguments, AdminAppsConfigSetArguments, AdminAppsRequestsCancelArguments, AdminAppsRequestsListArguments, AdminAppsRestrictArguments, AdminAppsRestrictedListArguments, AdminAppsUninstallArguments, AdminAuthPolicyAssignEntitiesArguments, AdminAuthPolicyGetEntitiesArguments, AdminAuthPolicyRemoveEntitiesArguments, AdminBarriersCreateArguments, AdminBarriersDeleteArguments, AdminBarriersListArguments, AdminBarriersUpdateArguments, AdminConversationsArchiveArguments, AdminConversationsBulkArchiveArguments, AdminConversationsBulkDeleteArguments, AdminConversationsBulkMoveArguments, AdminConversationsConvertToPrivateArguments, AdminConversationsConvertToPublicArguments, AdminConversationsCreateArguments, AdminConversationsDeleteArguments, AdminConversationsDisconnectSharedArguments, AdminConversationsEKMListOriginalConnectedChannelInfoArguments, AdminConversationsGetConversationPrefsArguments, AdminConversationsGetCustomRetentionArguments, AdminConversationsGetTeamsArguments, AdminConversationsInviteArguments, AdminConversationsLookupArguments, AdminConversationsRemoveCustomRetentionArguments, AdminConversationsRenameArguments, AdminConversationsRestrictAccessAddGroupArguments, AdminConversationsRestrictAccessListGroupsArguments, AdminConversationsRestrictAccessRemoveGroupArguments, AdminConversationsSearchArguments, AdminConversationsSetConversationPrefsArguments, AdminConversationsSetCustomRetentionArguments, AdminConversationsSetTeamsArguments, AdminConversationsUnarchiveArguments, AdminEmojiAddArguments, AdminEmojiAddAliasArguments, AdminEmojiListArguments, AdminEmojiRemoveArguments, AdminEmojiRenameArguments, AdminFunctionsListArguments, AdminFunctionsPermissionsLookupArguments, AdminFunctionsPermissionsSetArguments, AdminInviteRequestsApproveArguments, AdminInviteRequestsApprovedListArguments, AdminInviteRequestsDeniedListArguments, AdminInviteRequestsDenyArguments, AdminInviteRequestsListArguments, AdminRolesAddAssignmentsArguments, AdminRolesListAssignmentsArguments, AdminRolesRemoveAssignmentsArguments, AdminTeamsAdminsListArguments, AdminTeamsCreateArguments, AdminTeamsListArguments, AdminTeamsOwnersListArguments, AdminTeamsSettingsInfoArguments, AdminTeamsSettingsSetDefaultChannelsArguments, AdminTeamsSettingsSetDescriptionArguments, AdminTeamsSettingsSetDiscoverabilityArguments, AdminTeamsSettingsSetIconArguments, AdminTeamsSettingsSetNameArguments, AdminUsergroupsAddChannelsArguments, AdminUsergroupsAddTeamsArguments, AdminUsergroupsListChannelsArguments, AdminUsergroupsRemoveChannelsArguments, AdminUsersAssignArguments, AdminUsersInviteArguments, AdminUsersListArguments, AdminUsersRemoveArguments, AdminUsersSessionListArguments, AdminUsersSessionClearSettingsArguments, AdminUsersSessionGetSettingsArguments, AdminUsersSessionInvalidateArguments, AdminUsersSessionResetArguments, AdminUsersSessionResetBulkArguments, AdminUsersSessionSetSettingsArguments, AdminUsersSetAdminArguments, AdminUsersSetExpirationArguments, AdminUsersSetOwnerArguments, AdminUsersSetRegularArguments, AdminUsersUnsupportedVersionsExportArguments, AdminWorkflowsCollaboratorsAddArguments, AdminWorkflowsCollaboratorsRemoveArguments, AdminWorkflowsPermissionsLookupArguments, AdminWorkflowsSearchArguments, AdminWorkflowsUnpublishArguments } from './types/request/index';
5/**
6 * Generic method definition
7 */
8export default interface Method<MethodArguments, MethodResult extends WebAPICallResult = WebAPICallResult> {
9 (options: MethodArguments): Promise<MethodResult>;
10}
11/**
12 * A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the
13 * `apiCall` class method.
14 */
15export declare abstract class Methods extends EventEmitter<WebClientEvent> {
16 protected constructor();
17 abstract apiCall(method: string, options?: Record<string, unknown>): Promise<WebAPICallResult>;
18 abstract filesUploadV2(options: FilesUploadV2Arguments): Promise<WebAPICallResult>;
19 readonly admin: {
20 analytics: {
21 /**
22 * @description Retrieve analytics data for a given date, presented as a compressed JSON file.
23 * @see {@link https://api.slack.com/methods/api.test `api.test` API reference}.
24 */
25 getFile: Method<AdminAnalyticsGetFileArguments, AdminAnalyticsGetFileResponse>;
26 };
27 apps: {
28 activities: {
29 /**
30 * @description Get logs for a specified team/org.
31 * @see {@link https://api.slack.com/methods/admin.apps.activities.list `admin.apps.activities.list` API reference}.
32 */
33 list: Method<AdminAppsActivitiesListArguments, AdminAppsActivitiesListResponse>;
34 };
35 /**
36 * @description Approve an app for installation on a workspace.
37 * @see {@link https://api.slack.com/methods/admin.apps.approve `admin.apps.approve` API reference}.
38 */
39 approve: Method<AdminAppsApproveArguments, AdminAppsApproveResponse>;
40 approved: {
41 /**
42 * @description List approved apps for an org or workspace.
43 * @see {@link https://api.slack.com/methods/admin.apps.approved.list `admin.apps.approved.list` API reference}.
44 */
45 list: Method<AdminAppsApprovedListArguments, AdminAppsApprovedListResponse>;
46 };
47 /**
48 * @description Clear an app resolution.
49 * @see {@link https://api.slack.com/methods/admin.apps.clearResolution `admin.apps.clearResolution` API reference}.
50 */
51 clearResolution: Method<AdminAppsClearResolutionArguments, AdminAppsClearResolutionResponse>;
52 config: {
53 /**
54 * @description Look up the app config for connectors by their IDs.
55 * @see {@link https://api.slack.com/methods/admin.apps.config.lookup `admin.apps.config.lookup` API reference}.
56 */
57 lookup: Method<AdminAppsConfigLookupArguments, AdminAppsConfigLookupResponse>;
58 /**
59 * @description Set the app config for a connector.
60 * @see {@link https://api.slack.com/methods/admin.apps.config.set `admin.apps.config.set` API reference}.
61 */
62 set: Method<AdminAppsConfigSetArguments, AdminAppsConfigSetResponse>;
63 };
64 requests: {
65 /**
66 * @description Cancel app request for team.
67 * @see {@link https://api.slack.com/methods/admin.apps.requests.cancel `admin.apps.requests.cancel` API reference}.
68 */
69 cancel: Method<AdminAppsRequestsCancelArguments, AdminAppsRequestsCancelResponse>;
70 /**
71 * @description List app requests for a team/workspace.
72 * @see {@link https://api.slack.com/methods/admin.apps.requests.list `admin.apps.requests.list` API reference}.
73 */
74 list: Method<AdminAppsRequestsListArguments, AdminAppsRequestsListResponse>;
75 };
76 /**
77 * @description Restrict an app for installation on a workspace.
78 * @see {@link https://api.slack.com/methods/admin.apps.restrict `admin.apps.restrict` API reference}.
79 */
80 restrict: Method<AdminAppsRestrictArguments, AdminAppsRestrictResponse>;
81 restricted: {
82 /**
83 * @description List restricted apps for an org or workspace.
84 * @see {@link https://api.slack.com/methods/admin.apps.restricted.list `admin.apps.restricted.list` API reference}.
85 */
86 list: Method<AdminAppsRestrictedListArguments, AdminAppsRestrictedListResponse>;
87 };
88 /**
89 * @description Uninstall an app from one or many workspaces, or an entire enterprise organization.
90 * @see {@link https://api.slack.com/methods/admin.apps.uninstall `admin.apps.uninstall` API reference}.
91 */
92 uninstall: Method<AdminAppsUninstallArguments, AdminAppsUninstallResponse>;
93 };
94 auth: {
95 policy: {
96 /**
97 * @description Assign entities to a particular authentication policy.
98 * @see {@link https://api.slack.com/methods/admin.auth.policy.assignEntities `admin.auth.policy.assignEntities` API reference}.
99 */
100 assignEntities: Method<AdminAuthPolicyAssignEntitiesArguments, AdminAuthPolicyAssignEntitiesResponse>;
101 /**
102 * @description Fetch all the entities assigned to a particular authentication policy by name.
103 * @see {@link https://api.slack.com/methods/admin.auth.policy.getEntities `admin.auth.policy.getEntities` API reference}.
104 */
105 getEntities: Method<AdminAuthPolicyGetEntitiesArguments, AdminAuthPolicyGetEntitiesResponse>;
106 /**
107 * @description Remove specified entities from a specified authentication policy.
108 * @see {@link https://api.slack.com/methods/admin.auth.policy.removeEntities `admin.auth.policy.removeEntities` API reference}.
109 */
110 removeEntities: Method<AdminAuthPolicyRemoveEntitiesArguments, AdminAuthPolicyRemoveEntitiesResponse>;
111 };
112 };
113 barriers: {
114 /**
115 * @description Create an Information Barrier.
116 * @see {@link https://api.slack.com/methods/admin.barriers.create `admin.barriers.create` API reference}.
117 */
118 create: Method<AdminBarriersCreateArguments, AdminBarriersCreateResponse>;
119 /**
120 * @description Delete an existing Information Barrier.
121 * @see {@link https://api.slack.com/methods/admin.barriers.delete `admin.barriers.delete` API reference}.
122 */
123 delete: Method<AdminBarriersDeleteArguments, AdminBarriersDeleteResponse>;
124 /**
125 * @description Get all Information Barriers for your organization.
126 * @see {@link https://api.slack.com/methods/admin.barriers.list `admin.barriers.list` API reference}.
127 */
128 list: Method<AdminBarriersListArguments, AdminBarriersListResponse>;
129 /**
130 * @description Update an existing Information Barrier.
131 * @see {@link https://api.slack.com/methods/admin.barriers.update `admin.barriers.update` API reference}.
132 */
133 update: Method<AdminBarriersUpdateArguments, AdminBarriersUpdateResponse>;
134 };
135 conversations: {
136 /**
137 * @description Archive a public or private channel.
138 * @see {@link https://api.slack.com/methods/admin.conversations.archive `admin.conversations.archive` API reference}.
139 */
140 archive: Method<AdminConversationsArchiveArguments, AdminConversationsArchiveResponse>;
141 /**
142 * @description Archive public or private channels in bulk.
143 * @see {@link https://api.slack.com/methods/admin.conversations.bulkArchive `admin.conversations.bulkArchive` API reference}.
144 */
145 bulkArchive: Method<AdminConversationsBulkArchiveArguments, AdminConversationsBulkArchiveResponse>;
146 /**
147 * @description Delete public or private channels in bulk.
148 * @see {@link https://api.slack.com/methods/admin.conversations.bulkDelet `admin.conversations.bulkDelete` API reference}.
149 */
150 bulkDelete: Method<AdminConversationsBulkDeleteArguments, AdminConversationsBulkDeleteResponse>;
151 /**
152 * @description Move public or private channels in bulk.
153 * @see {@link https://api.slack.com/methods/admin.conversations.bulkMove `admin.conversations.bulkMove` API reference}.
154 */
155 bulkMove: Method<AdminConversationsBulkMoveArguments, AdminConversationsBulkMoveResponse>;
156 /**
157 * @description Convert a public channel to a private channel.
158 * @see {@link https://api.slack.com/methods/admin.conversations.convertToPrivate `admin.conversations.convertToPrivate` API reference}.
159 */
160 convertToPrivate: Method<AdminConversationsConvertToPrivateArguments, AdminConversationsConvertToPrivateResponse>;
161 /**
162 * @description Convert a private channel to a public channel.
163 * @see {@link https://api.slack.com/methods/admin.conversations.convertToPublic `admin.conversations.convertToPublic` API reference}.
164 */
165 convertToPublic: Method<AdminConversationsConvertToPublicArguments, AdminConversationsConvertToPublicResponse>;
166 /**
167 * @description Create a public or private channel-based conversation.
168 * @see {@link https://api.slack.com/methods/admin.conversations.create `admin.conversations.create` API reference}.
169 */
170 create: Method<AdminConversationsCreateArguments, AdminConversationsCreateResponse>;
171 /**
172 * @description Delete a public or private channel.
173 * @see {@link https://api.slack.com/methods/admin.conversations.delete `admin.conversations.delete` API reference}.
174 */
175 delete: Method<AdminConversationsDeleteArguments, AdminConversationsDeleteResponse>;
176 /**
177 * @description Disconnect a connected channel from one or more workspaces.
178 * @see {@link https://api.slack.com/methods/admin.conversations.disconnectShared `admin.conversations.disconnectShared` API reference}.
179 */
180 disconnectShared: Method<AdminConversationsDisconnectSharedArguments, AdminConversationsDisconnectSharedResponse>;
181 ekm: {
182 /**
183 * @description List all disconnected channels — i.e., channels that were once connected to other workspaces
184 * and then disconnected — and the corresponding original channel IDs for key revocation with EKM.
185 * @see {@link https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo `admin.conversations.ekm.listOriginalConnectedChannelInfo` API reference}.
186 */
187 listOriginalConnectedChannelInfo: Method<AdminConversationsEKMListOriginalConnectedChannelInfoArguments, AdminConversationsEkmListOriginalConnectedChannelInfoResponse>;
188 };
189 /**
190 * @description Get conversation preferences for a public or private channel.
191 * @see {@link https://api.slack.com/methods/admin.conversations.getConversationPrefs `admin.conversations.getConversationPrefs` API reference}.
192 */
193 getConversationPrefs: Method<AdminConversationsGetConversationPrefsArguments, AdminConversationsGetConversationPrefsResponse>;
194 /**
195 * @description Get a conversation's retention policy.
196 * @see {@link https://api.slack.com/methods/admin.conversations.getCustomRetention `admin.conversations.getCustomRetention` API reference}.
197 */
198 getCustomRetention: Method<AdminConversationsGetCustomRetentionArguments, AdminConversationsGetCustomRetentionResponse>;
199 /**
200 * @description Get all the workspaces a given public or private channel is connected to within
201 * this Enterprise org.
202 * @see {@link https://api.slack.com/methods/admin.conversations.getTeams `admin.conversations.getTeams` API reference}.
203 */
204 getTeams: Method<AdminConversationsGetTeamsArguments, AdminConversationsGetTeamsResponse>;
205 /**
206 * @description Invite a user to a public or private channel.
207 * @see {@link https://api.slack.com/methods/admin.conversations.invite `admin.conversations.invite` API reference}.
208 */
209 invite: Method<AdminConversationsInviteArguments, AdminConversationsInviteResponse>;
210 /**
211 * @description Returns channels on the given team using the filters.
212 * @see {@link https://api.slack.com/methods/admin.conversations.lookup `admin.conversations.lookup` API reference}.
213 */
214 lookup: Method<AdminConversationsLookupArguments, AdminConversationsLookupResponse>;
215 /**
216 * @description Remove a conversation's retention policy.
217 * @see {@link https://api.slack.com/methods/admin.conversations.removeCustomRetention `admin.conversations.removeCustomRetention` API reference}.
218 */
219 removeCustomRetention: Method<AdminConversationsRemoveCustomRetentionArguments, AdminConversationsRemoveCustomRetentionResponse>;
220 /**
221 * @description Rename a public or private channel.
222 * @see {@link https://api.slack.com/methods/admin.conversations.rename `admin.conversations.rename` API reference}.
223 */
224 rename: Method<AdminConversationsRenameArguments, AdminConversationsRenameResponse>;
225 restrictAccess: {
226 /**
227 * @description Add an allowlist of IDP groups for accessing a channel.
228 * @see {@link https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup `admin.conversations.restrictAccess.addGroup` API reference}.
229 */
230 addGroup: Method<AdminConversationsRestrictAccessAddGroupArguments, AdminConversationsRestrictAccessAddGroupResponse>;
231 /**
232 * @description List all IDP Groups linked to a channel.
233 * @see {@link https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups `admin.conversations.restrictAccess.listGroups` API reference}.
234 */
235 listGroups: Method<AdminConversationsRestrictAccessListGroupsArguments, AdminConversationsRestrictAccessListGroupsResponse>;
236 /**
237 * @description Remove a linked IDP group linked from a private channel.
238 * @see {@link https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup `admin.conversations.restrictAccess.removeGroup` API reference}.
239 */
240 removeGroup: Method<AdminConversationsRestrictAccessRemoveGroupArguments, AdminConversationsRestrictAccessRemoveGroupResponse>;
241 };
242 /**
243 * @description Search for public or private channels in an Enterprise organization.
244 * @see {@link https://api.slack.com/methods/admin.conversations.search `admin.conversations.search` API reference}.
245 */
246 search: Method<AdminConversationsSearchArguments, AdminConversationsSearchResponse>;
247 /**
248 * @description Set the posting permissions for a public or private channel.
249 * @see {@link https://api.slack.com/methods/admin.conversations.setConversationPrefs `admin.conversations.setConversationPrefs` API reference}.
250 */
251 setConversationPrefs: Method<AdminConversationsSetConversationPrefsArguments, AdminConversationsSetConversationPrefsResponse>;
252 /**
253 * @description Set a conversation's retention policy.
254 * @see {@link https://api.slack.com/methods/admin.conversations.setCustomRetention `admin.conversations.setCustomRetention` API reference}.
255 */
256 setCustomRetention: Method<AdminConversationsSetCustomRetentionArguments, AdminConversationsSetCustomRetentionResponse>;
257 /**
258 * @description Set the workspaces in an Enterprise grid org that connect to a public or private channel.
259 * @see {@link https://api.slack.com/methods/admin.conversations.setTeams `admin.conversations.setTeams` API reference}.
260 */
261 setTeams: Method<AdminConversationsSetTeamsArguments, AdminConversationsSetTeamsResponse>;
262 /**
263 * @description Unarchive a public or private channel.
264 * @see {@link https://api.slack.com/methods/admin.conversations.unarchive `admin.conversations.unarchive` API reference}.
265 */
266 unarchive: Method<AdminConversationsUnarchiveArguments, AdminConversationsUnarchiveResponse>;
267 };
268 emoji: {
269 /**
270 * @description Add an emoji.
271 * @see {@link https://api.slack.com/methods/admin.emoji.add `admin.emoji.add` API reference}.
272 */
273 add: Method<AdminEmojiAddArguments, AdminEmojiAddResponse>;
274 /**
275 * @description Add an emoji alias.
276 * @see {@link https://api.slack.com/methods/admin.emoji.addAlias `admin.emoji.addAlias` API reference}.
277 */
278 addAlias: Method<AdminEmojiAddAliasArguments, AdminEmojiAddAliasResponse>;
279 /**
280 * @description List emoji for an Enterprise Grid organization.
281 * @see {@link https://api.slack.com/methods/admin.emoji.list `admin.emoji.list` API reference}.
282 */
283 list: Method<AdminEmojiListArguments, AdminEmojiListResponse>;
284 /**
285 * @description Remove an emoji across an Enterprise Grid organization.
286 * @see {@link https://api.slack.com/methods/admin.emoji.remove `admin.emoji.remove` API reference}.
287 */
288 remove: Method<AdminEmojiRemoveArguments, AdminEmojiRemoveResponse>;
289 /**
290 * @description Rename an emoji.
291 * @see {@link https://api.slack.com/methods/admin.emoji.rename `admin.emoji.rename` API reference}.
292 */
293 rename: Method<AdminEmojiRenameArguments, AdminEmojiRenameResponse>;
294 };
295 functions: {
296 /**
297 * @description Look up functions by a set of apps.
298 * @see {@link https://api.slack.com/methods/admin.functions.list `admin.functions.list` API reference}.
299 */
300 list: Method<AdminFunctionsListArguments, AdminFunctionsListResponse>;
301 permissions: {
302 /**
303 * @description Lookup the visibility of multiple Slack functions and include the users if
304 * it is limited to particular named entities.
305 * @see {@link https://api.slack.com/methods/admin.functions.permissions.lookup `admin.functions.permissions.lookup` API reference}.
306 */
307 lookup: Method<AdminFunctionsPermissionsLookupArguments, AdminFunctionsPermissionsLookupResponse>;
308 /**
309 * @description Set the visibility of a Slack function and define the users or workspaces if
310 * it is set to named_entities.
311 * @see {@link https://api.slack.com/methods/admin.functions.permissions.set `admin.functions.permissions.set` API reference}.
312 */
313 set: Method<AdminFunctionsPermissionsSetArguments, AdminFunctionsPermissionsSetResponse>;
314 };
315 };
316 inviteRequests: {
317 /**
318 * @description Approve a workspace invite request.
319 * @see {@link https://api.slack.com/methods/admin.inviteRequests.approve `admin.inviteRequests.approve` API reference}.
320 */
321 approve: Method<AdminInviteRequestsApproveArguments, AdminInviteRequestsApproveResponse>;
322 approved: {
323 /**
324 * @description List all approved workspace invite requests.
325 * @see {@link https://api.slack.com/methods/admin.inviteRequests.approved.list `admin.inviteRequests.approved.list` API reference}.
326 */
327 list: Method<AdminInviteRequestsApprovedListArguments, AdminInviteRequestsApprovedListResponse>;
328 };
329 denied: {
330 /**
331 * @description List all denied workspace invite requests.
332 * @see {@link https://api.slack.com/methods/admin.inviteRequests.denied.list `admin.inviteRequests.denied.list` API reference}.
333 */
334 list: Method<AdminInviteRequestsDeniedListArguments, AdminInviteRequestsDeniedListResponse>;
335 };
336 /**
337 * @description Deny a workspace invite request.
338 * @see {@link https://api.slack.com/methods/admin.inviteRequests.deny `admin.inviteRequests.deny` API reference}.
339 */
340 deny: Method<AdminInviteRequestsDenyArguments, AdminInviteRequestsDenyResponse>;
341 /**
342 * @description List all pending workspace invite requests.
343 * @see {@link https://api.slack.com/methods/admin.inviteRequests.list `admin.inviteRequests.list` API reference}.
344 */
345 list: Method<AdminInviteRequestsListArguments, AdminInviteRequestsListResponse>;
346 };
347 roles: {
348 /**
349 * @description Adds members to the specified role with the specified scopes.
350 * @see {@link https://api.slack.com/methods/admin.roles.addAssignments `admin.roles.addAssignments` API reference}.
351 */
352 addAssignments: Method<AdminRolesAddAssignmentsArguments, AdminRolesAddAssignmentsResponse>;
353 /**
354 * @description Lists assignments for all roles across entities.
355 * Options to scope results by any combination of roles or entities.
356 * @see {@link https://api.slack.com/methods/admin.roles.listAssignments `admin.roles.listAssignments` API reference}.
357 */
358 listAssignments: Method<AdminRolesListAssignmentsArguments, AdminRolesListAssignmentsResponse>;
359 /**
360 * @description Removes a set of users from a role for the given scopes and entities.
361 * @see {@link https://api.slack.com/methods/admin.roles.removeAssignments `admin.roles.removeAssignments` API reference}.
362 */
363 removeAssignments: Method<AdminRolesRemoveAssignmentsArguments, AdminRolesRemoveAssignmentsResponse>;
364 };
365 teams: {
366 admins: {
367 /**
368 * @description List all of the admins on a given workspace.
369 * @see {@link https://api.slack.com/methods/admin.teams.admins.list `admin.teams.admins.list` API reference}.
370 */
371 list: Method<AdminTeamsAdminsListArguments, AdminTeamsAdminsListResponse>;
372 };
373 /**
374 * @description Create an Enterprise team.
375 * @see {@link https://api.slack.com/methods/admin.teams.create `admin.teams.create` API reference}.
376 */
377 create: Method<AdminTeamsCreateArguments, AdminTeamsCreateResponse>;
378 /**
379 * @description List all teams on an Enterprise organization.
380 * @see {@link https://api.slack.com/methods/admin.teams.list `admin.teams.list` API reference}.
381 */
382 list: Method<AdminTeamsListArguments, AdminTeamsListResponse>;
383 owners: {
384 /**
385 * @description List all of the owners on a given workspace.
386 * @see {@link https://api.slack.com/methods/admin.teams.owners.list `admin.teams.owners.list` API reference}.
387 */
388 list: Method<AdminTeamsOwnersListArguments, AdminTeamsOwnersListResponse>;
389 };
390 settings: {
391 /**
392 * @description Fetch information about settings in a workspace.
393 * @see {@link https://api.slack.com/methods/admin.teams.owners.list `admin.teams.owners.list` API reference}.
394 */
395 info: Method<AdminTeamsSettingsInfoArguments, AdminTeamsSettingsInfoResponse>;
396 /**
397 * @description Set the default channels of a workspace.
398 * @see {@link https://api.slack.com/methods/admin.teams.settings.setDefaultChannels `admin.teams.settings.setDefaultChannels` API reference}.
399 */
400 setDefaultChannels: Method<AdminTeamsSettingsSetDefaultChannelsArguments, AdminTeamsSettingsSetDefaultChannelsResponse>;
401 /**
402 * @description Set the description of a given workspace.
403 * @see {@link https://api.slack.com/methods/admin.teams.settings.setDescription `admin.teams.settings.setDescription` API reference}.
404 */
405 setDescription: Method<AdminTeamsSettingsSetDescriptionArguments, AdminTeamsSettingsSetDescriptionResponse>;
406 /**
407 * @description Set the discoverability of a given workspace.
408 * @see {@link https://api.slack.com/methods/admin.teams.settings.setDiscoverability `admin.teams.settings.setDiscoverability` API reference}.
409 */
410 setDiscoverability: Method<AdminTeamsSettingsSetDiscoverabilityArguments, AdminTeamsSettingsSetDiscoverabilityResponse>;
411 /**
412 * @description Sets the icon of a workspace.
413 * @see {@link https://api.slack.com/methods/admin.teams.settings.setIcon `admin.teams.settings.setIcon` API reference}.
414 */
415 setIcon: Method<AdminTeamsSettingsSetIconArguments, AdminTeamsSettingsSetIconResponse>;
416 /**
417 * @description Set the name of a given workspace.
418 * @see {@link https://api.slack.com/methods/admin.teams.settings.setName `admin.teams.settings.setName` API reference}.
419 */
420 setName: Method<AdminTeamsSettingsSetNameArguments, AdminTeamsSettingsSetNameResponse>;
421 };
422 };
423 usergroups: {
424 /**
425 * @description Add up to one hundred default channels to an IDP group.
426 * @see {@link https://api.slack.com/methods/admin.usergroups.addChannels `admin.teams.usergroups.addChannels` API reference}.
427 */
428 addChannels: Method<AdminUsergroupsAddChannelsArguments, AdminUsergroupsAddChannelsResponse>;
429 /**
430 * @description Associate one or more default workspaces with an organization-wide IDP group.
431 * @see {@link https://api.slack.com/methods/admin.usergroups.addTeams `admin.teams.usergroups.addTeams` API reference}.
432 */
433 addTeams: Method<AdminUsergroupsAddTeamsArguments, AdminUsergroupsAddTeamsResponse>;
434 /**
435 * @description List the channels linked to an org-level IDP group (user group).
436 * @see {@link https://api.slack.com/methods/admin.usergroups.listChannels `admin.teams.usergroups.listChannels` API reference}.
437 */
438 listChannels: Method<AdminUsergroupsListChannelsArguments, AdminUsergroupsListChannelsResponse>;
439 /**
440 * @description Remove one or more default channels from an org-level IDP group (user group).
441 * @see {@link https://api.slack.com/methods/admin.usergroups.removeChannels `admin.teams.usergroups.removeChannels` API reference}.
442 */
443 removeChannels: Method<AdminUsergroupsRemoveChannelsArguments, AdminUsergroupsRemoveChannelsResponse>;
444 };
445 users: {
446 /**
447 * @description Add an Enterprise user to a workspace.
448 * @see {@link https://api.slack.com/methods/admin.users.assign `admin.users.assign` API reference}.
449 */
450 assign: Method<AdminUsersAssignArguments, AdminUsersAssignResponse>;
451 /**
452 * @description Invite a user to a workspace.
453 * @see {@link https://api.slack.com/methods/admin.users.invite `admin.users.invite` API reference}.
454 */
455 invite: Method<AdminUsersInviteArguments, AdminUsersInviteResponse>;
456 /**
457 * @description List users on a workspace.
458 * @see {@link https://api.slack.com/methods/admin.users.list `admin.users.list` API reference}.
459 */
460 list: Method<AdminUsersListArguments, AdminUsersListResponse>;
461 /**
462 * @description Remove a user from a workspace.
463 * @see {@link https://api.slack.com/methods/admin.users.remove `admin.users.remove` API reference}.
464 */
465 remove: Method<AdminUsersRemoveArguments, AdminUsersRemoveResponse>;
466 session: {
467 /**
468 * @description Clear user-specific session settings—the session duration and what happens when the client
469 * closes—for a list of users.
470 * @see {@link https://api.slack.com/methods/admin.users.session.clearSettings `admin.users.session.clearSettings` API reference}.
471 */
472 clearSettings: Method<AdminUsersSessionClearSettingsArguments, AdminUsersSessionClearSettingsResponse>;
473 /**
474 * @description Get user-specific session settings—the session duration and what happens when the client
475 * closes—given a list of users.
476 * @see {@link https://api.slack.com/methods/admin.users.session.getSettings `admin.users.session.getSettings` API reference}.
477 */
478 getSettings: Method<AdminUsersSessionGetSettingsArguments, AdminUsersSessionGetSettingsResponse>;
479 /**
480 * @description Revoke a single session for a user. The user will be forced to login to Slack.
481 * @see {@link https://api.slack.com/methods/admin.users.session.invalidate `admin.users.session.invalidate` API reference}.
482 */
483 invalidate: Method<AdminUsersSessionInvalidateArguments, AdminUsersSessionInvalidateResponse>;
484 /**
485 * @description List active user sessions for an organization.
486 * @see {@link https://api.slack.com/methods/admin.users.session.list `admin.users.session.list` API reference}.
487 */
488 list: Method<AdminUsersSessionListArguments, AdminUsersSessionListResponse>;
489 /**
490 * @description Wipes all valid sessions on all devices for a given user.
491 * @see {@link https://api.slack.com/methods/admin.users.session.reset `admin.users.session.reset` API reference}.
492 */
493 reset: Method<AdminUsersSessionResetArguments, AdminUsersSessionResetResponse>;
494 /**
495 * @description Enqueues an asynchronous job to wipe all valid sessions on all devices for a given user list.
496 * @see {@link https://api.slack.com/methods/admin.users.session.resetBulk `admin.users.session.resetBulk` API reference}.
497 */
498 resetBulk: Method<AdminUsersSessionResetBulkArguments, AdminUsersSessionResetBulkResponse>;
499 /**
500 * @description Configure the user-level session settings—the session duration and what happens when the client
501 * closes—for one or more users.
502 * @see {@link https://api.slack.com/methods/admin.users.session.setSettings `admin.users.session.setSettings` API reference}.
503 */
504 setSettings: Method<AdminUsersSessionSetSettingsArguments, AdminUsersSessionSetSettingsResponse>;
505 };
506 /**
507 * @description Set an existing guest, regular user, or owner to be an admin user.
508 * @see {@link https://api.slack.com/methods/admin.users.setAdmin `admin.users.setAdmin` API reference}.
509 */
510 setAdmin: Method<AdminUsersSetAdminArguments, AdminUsersSetAdminResponse>;
511 /**
512 * @description Set an expiration for a guest user.
513 * @see {@link https://api.slack.com/methods/admin.users.setExpiration `admin.users.setExpiration` API reference}.
514 */
515 setExpiration: Method<AdminUsersSetExpirationArguments, AdminUsersSetExpirationResponse>;
516 /**
517 * @description Set an existing guest, regular user, or admin user to be a workspace owner.
518 * @see {@link https://api.slack.com/methods/admin.users.setOwner `admin.users.setOwner` API reference}.
519 */
520 setOwner: Method<AdminUsersSetOwnerArguments, AdminUsersSetOwnerResponse>;
521 /**
522 * @description Set an existing guest user, admin user, or owner to be a regular user.
523 * @see {@link https://api.slack.com/methods/admin.users.setRegular `admin.users.setRegular` API reference}.
524 */
525 setRegular: Method<AdminUsersSetRegularArguments, AdminUsersSetRegularResponse>;
526 unsupportedVersions: {
527 /**
528 * @description Ask Slackbot to send you an export listing all workspace members using unsupported software,
529 * presented as a zipped CSV file.
530 * @see {@link https://api.slack.com/methods/admin.users.unsupportedVersions.export `admin.users.unsupportedVersions.export` API reference}.
531 */
532 export: Method<AdminUsersUnsupportedVersionsExportArguments, AdminUsersUnsupportedVersionsExportResponse>;
533 };
534 };
535 workflows: {
536 collaborators: {
537 /**
538 * @description Add collaborators to workflows within the team or enterprise.
539 * @see {@link https://api.slack.com/methods/admin.workflows.collaborators.add `admin.workflows.collaborators.add` API reference}.
540 */
541 add: Method<AdminWorkflowsCollaboratorsAddArguments, AdminWorkflowsCollaboratorsAddResponse>;
542 /**
543 * @description Remove collaborators from workflows within the team or enterprise.
544 * @see {@link https://api.slack.com/methods/admin.workflows.collaborators.remove `admin.workflows.collaborators.remove` API reference}.
545 */
546 remove: Method<AdminWorkflowsCollaboratorsRemoveArguments, AdminWorkflowsCollaboratorsRemoveResponse>;
547 };
548 permissions: {
549 /**
550 * @description Look up the permissions for a set of workflows.
551 * @see {@link https://api.slack.com/methods/admin.workflows.permissions.lookup `admin.workflows.permissions.lookup` API reference}.
552 */
553 lookup: Method<AdminWorkflowsPermissionsLookupArguments, AdminWorkflowsPermissionsLookupResponse>;
554 };
555 /**
556 * @description Search workflows within the team or enterprise.
557 * @see {@link https://api.slack.com/methods/admin.workflows.search `admin.workflows.search` API reference}.
558 */
559 search: Method<AdminWorkflowsSearchArguments, AdminWorkflowsSearchResponse>;
560 /**
561 * @description Unpublish workflows within the team or enterprise.
562 * @see {@link https://api.slack.com/methods/admin.workflows.unpublish `admin.workflows.unpublish` API reference}.
563 */
564 unpublish: Method<AdminWorkflowsUnpublishArguments, AdminWorkflowsUnpublishResponse>;
565 };
566 };
567 readonly api: {
568 /**
569 * @description Checks API calling code.
570 * @see {@link https://api.slack.com/methods/api.test `api.test` API reference}.
571 */
572 test: Method<APITestArguments, ApiTestResponse>;
573 };
574 readonly apps: {
575 connections: {
576 /**
577 * @description Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive
578 * events and interactive payloads over.
579 * @see {@link https://api.slack.com/methods/apps.connections.open `apps.connections.open` API reference}.
580 */
581 open: Method<AppsConnectionsOpenArguments, AppsConnectionsOpenResponse>;
582 };
583 event: {
584 authorizations: {
585 /**
586 * @description Get a list of authorizations for the given event context.
587 * Each authorization represents an app installation that the event is visible to.
588 * @see {@link https://api.slack.com/methods/apps.event.authorizations.list `apps.event.authorizations.list` API reference}.
589 */
590 list: Method<AppsEventAuthorizationsListArguments, AppsEventAuthorizationsListResponse>;
591 };
592 };
593 manifest: {
594 /**
595 * @description Create an app from an app manifest.
596 * @see {@link https://api.slack.com/methods/apps.manifest.create `apps.manifest.create` API reference}.
597 */
598 create: Method<AppsManifestCreateArguments, AppsManifestCreateResponse>;
599 /**
600 * @description Permanently deletes an app created through app manifests.
601 * @see {@link https://api.slack.com/methods/apps.manifest.delete `apps.manifest.delete` API reference}.
602 */
603 delete: Method<AppsManifestDeleteArguments, AppsManifestDeleteResponse>;
604 /**
605 * @description Export an app manifest from an existing app.
606 * @see {@link https://api.slack.com/methods/apps.manifest.export `apps.manifest.export` API reference}.
607 */
608 export: Method<AppsManifestExportArguments, AppsManifestExportResponse>;
609 /**
610 * @description Update an app from an app manifest.
611 * @see {@link https://api.slack.com/methods/apps.manifest.update `apps.manifest.update` API reference}.
612 */
613 update: Method<AppsManifestUpdateArguments, AppsManifestUpdateResponse>;
614 /**
615 * @description Validate an app manifest.
616 * @see {@link https://api.slack.com/methods/apps.manifest.validate `apps.manifest.validate` API reference}.
617 */
618 validate: Method<AppsManifestValidateArguments, AppsManifestValidateResponse>;
619 };
620 /**
621 * @description Uninstalls your app from a workspace.
622 * @see {@link https://api.slack.com/methods/apps.uninstall `apps.uninstall` API reference}.
623 */
624 uninstall: Method<AppsUninstallArguments, AppsUninstallResponse>;
625 };
626 readonly auth: {
627 /**
628 * @description Revokes a token.
629 * @see {@link https://api.slack.com/methods/auth.revoke `auth.revoke` API reference}.
630 */
631 revoke: Method<AuthRevokeArguments, AuthRevokeResponse>;
632 teams: {
633 /**
634 * @description Obtain a full list of workspaces your org-wide app has been approved for.
635 * @see {@link https://api.slack.com/methods/auth.teams.list `auth.teams.list` API reference}.
636 */
637 list: Method<AuthTeamsListArguments, AuthTeamsListResponse>;
638 };
639 test: Method<AuthTestArguments, AuthTestResponse>;
640 };
641 readonly bookmarks: {
642 /**
643 * @description Add bookmark to a channel.
644 * @see {@link https://api.slack.com/methods/bookmarks.add `bookmarks.add` API reference}.
645 */
646 add: Method<BookmarksAddArguments, BookmarksAddResponse>;
647 /**
648 * @description Edit bookmark.
649 * @see {@link https://api.slack.com/methods/bookmarks.edit `bookmarks.edit` API reference}.
650 */
651 edit: Method<BookmarksEditArguments, BookmarksEditResponse>;
652 /**
653 * @description List bookmarks for a channel.
654 * @see {@link https://api.slack.com/methods/bookmarks.list `bookmarks.list` API reference}.
655 */
656 list: Method<BookmarksListArguments, BookmarksListResponse>;
657 /**
658 * @description Remove bookmark from a channel.
659 * @see {@link https://api.slack.com/methods/bookmarks.remove `bookmarks.remove` API reference}.
660 */
661 remove: Method<BookmarksRemoveArguments, BookmarksRemoveResponse>;
662 };
663 readonly bots: {
664 /**
665 * @description Gets information about a bot user.
666 * @see {@link https://api.slack.com/methods/bots.info `bots.info` API reference}.
667 */
668 info: Method<BotsInfoArguments, BotsInfoResponse>;
669 };
670 readonly calls: {
671 /**
672 * @description Registers a new Call.
673 * @see {@link https://api.slack.com/methods/calls.add `calls.add` API reference}.
674 */
675 add: Method<CallsAddArguments, CallsAddResponse>;
676 /**
677 * @description Ends a Call.
678 * @see {@link https://api.slack.com/methods/calls.end `calls.end` API reference}.
679 */
680 end: Method<CallsEndArguments, CallsEndResponse>;
681 /**
682 * @description Returns information about a Call.
683 * @see {@link https://api.slack.com/methods/calls.info `calls.info` API reference}.
684 */
685 info: Method<CallsInfoArguments, CallsInfoResponse>;
686 /**
687 * @description Updates information about a Call.
688 * @see {@link https://api.slack.com/methods/calls.info `calls.info` API reference}.
689 */
690 update: Method<CallsUpdateArguments, CallsUpdateResponse>;
691 participants: {
692 /**
693 * @description Registers new participants added to a Call.
694 * @see {@link https://api.slack.com/methods/calls.participants.add `calls.participants.add` API reference}.
695 */
696 add: Method<CallsParticipantsAddArguments, CallsParticipantsAddResponse>;
697 remove: Method<CallsParticipantsRemoveArguments, CallsParticipantsRemoveResponse>;
698 };
699 };
700 readonly chat: {
701 /**
702 * @description Deletes a message.
703 * @see {@link https://api.slack.com/methods/chat.delete `chat.delete` API reference}.
704 */
705 delete: Method<ChatDeleteArguments, ChatDeleteResponse>;
706 /**
707 * @description Deletes a pending scheduled message from the queue.
708 * @see {@link https://api.slack.com/methods/chat.deleteScheduledMessage `chat.deleteScheduledMessage` API reference}.
709 */
710 deleteScheduledMessage: Method<ChatDeleteScheduledMessageArguments, ChatDeleteScheduledMessageResponse>;
711 /**
712 * @description Retrieve a permalink URL for a specific extant message.
713 * @see {@link https://api.slack.com/methods/chat.getPermalink `chat.getPermalink` API reference}.
714 */
715 getPermalink: Method<ChatGetPermalinkArguments, ChatGetPermalinkResponse>;
716 /**
717 * @description Share a me message into a channel.
718 * @see {@link https://api.slack.com/methods/chat.meMessage `chat.meMessage` API reference}.
719 */
720 meMessage: Method<ChatMeMessageArguments, ChatMeMessageResponse>;
721 /**
722 * @description Sends an ephemeral message to a user in a channel.
723 * @see {@link https://api.slack.com/methods/chat.postEphemeral `chat.postEphemeral` API reference}.
724 */
725 postEphemeral: Method<ChatPostEphemeralArguments, ChatPostEphemeralResponse>;
726 /**
727 * @description Sends a message to a channel.
728 * @see {@link https://api.slack.com/methods/chat.postMessage `chat.postMessage` API reference}.
729 */
730 postMessage: Method<ChatPostMessageArguments, ChatPostMessageResponse>;
731 /**
732 * @description Schedules a message to be sent to a channel.
733 * @see {@link https://api.slack.com/methods/chat.scheduleMessage `chat.scheduleMessage` API reference}.
734 */
735 scheduleMessage: Method<ChatScheduleMessageArguments, ChatScheduleMessageResponse>;
736 scheduledMessages: {
737 /**
738 * @description Returns a list of scheduled messages.
739 * @see {@link https://api.slack.com/methods/chat.scheduledMessages.list `chat.scheduledMessages.list` API reference}.
740 */
741 list: Method<ChatScheduledMessagesListArguments, ChatScheduledMessagesListResponse>;
742 };
743 /**
744 * @description Provide custom unfurl behavior for user-posted URLs.
745 * @see {@link https://api.slack.com/methods/chat.unfurl `chat.unfurl` API reference}.
746 */
747 unfurl: Method<ChatUnfurlArguments, ChatUnfurlResponse>;
748 /**
749 * @description Updates a message.
750 * @see {@link https://api.slack.com/methods/chat.update `chat.update` API reference}.
751 */
752 update: Method<ChatUpdateArguments, ChatUpdateResponse>;
753 };
754 readonly conversations: {
755 /**
756 * @description Accepts an invitation to a Slack Connect channel.
757 * @see {@link https://api.slack.com/methods/conversations.acceptSharedInvite `conversations.acceptSharedInvite` API reference}.
758 */
759 acceptSharedInvite: Method<ConversationsAcceptSharedInviteArguments, ConversationsAcceptSharedInviteResponse>;
760 /**
761 * @description Approves an invitation to a Slack Connect channel.
762 * @see {@link https://api.slack.com/methods/conversations.approveSharedInvite `conversations.approveSharedInvite` API reference}.
763 */
764 approveSharedInvite: Method<ConversationsApproveSharedInviteArguments, ConversationsApproveSharedInviteResponse>;
765 /**
766 * @description Archives a conversation.
767 * @see {@link https://api.slack.com/methods/conversations.archive `conversations.archive` API reference}.
768 */
769 archive: Method<ConversationsArchiveArguments, ConversationsArchiveResponse>;
770 /**
771 * @description Closes a direct message or multi-person direct message.
772 * @see {@link https://api.slack.com/methods/conversations.close `conversations.close` API reference}.
773 */
774 close: Method<ConversationsCloseArguments, ConversationsCloseResponse>;
775 /**
776 * @description Initiates a public or private channel-based conversation.
777 * @see {@link https://api.slack.com/methods/conversations.create `conversations.create` API reference}.
778 */
779 create: Method<ConversationsCreateArguments, ConversationsCreateResponse>;
780 /**
781 * @description Declines an invitation to a Slack Connect channel.
782 * @see {@link https://api.slack.com/methods/conversations.declineSharedInvite `conversations.declineSharedInvite` API reference}.
783 */
784 declineSharedInvite: Method<ConversationsDeclineSharedInviteArguments, ConversationsDeclineSharedInviteResponse>;
785 /**
786 * @description Fetches a conversation's history of messages and events.
787 * @see {@link https://api.slack.com/methods/conversations.history `conversations.history` API reference}.
788 */
789 history: Method<ConversationsHistoryArguments, ConversationsHistoryResponse>;
790 /**
791 * @description Retrieve information about a conversation.
792 * @see {@link https://api.slack.com/methods/conversations.info `conversations.info` API reference}.
793 */
794 info: Method<ConversationsInfoArguments, ConversationsInfoResponse>;
795 /**
796 * @description Invites users to a channel.
797 * @see {@link https://api.slack.com/methods/conversations.invite `conversations.invite` API reference}.
798 */
799 invite: Method<ConversationsInviteArguments, ConversationsInviteResponse>;
800 /**
801 * @description Sends an invitation to a Slack Connect channel.
802 * @see {@link https://api.slack.com/methods/conversations.inviteShared `conversations.inviteShared` API reference}.
803 */
804 inviteShared: Method<ConversationsInviteSharedArguments, ConversationsInviteSharedResponse>;
805 /**
806 * @description Joins an existing conversation.
807 * @see {@link https://api.slack.com/methods/conversations.join `conversations.join` API reference}.
808 */
809 join: Method<ConversationsJoinArguments, ConversationsJoinResponse>;
810 /**
811 * @description Removes a user from a conversation.
812 * @see {@link https://api.slack.com/methods/conversations.kick `conversations.kick` API reference}.
813 */
814 kick: Method<ConversationsKickArguments, ConversationsKickResponse>;
815 /**
816 * @description Leaves a conversation.
817 * @see {@link https://api.slack.com/methods/conversations.leave `conversations.leave` API reference}.
818 */
819 leave: Method<ConversationsLeaveArguments, ConversationsLeaveResponse>;
820 /**
821 * @description List all channels in a Slack team.
822 * @see {@link https://api.slack.com/methods/conversations.list `conversations.list` API reference}.
823 */
824 list: Method<ConversationsListArguments, ConversationsListResponse>;
825 /**
826 * @description Lists shared channel invites that have been generated or received but have not been approved by
827 * all parties.
828 * @see {@link https://api.slack.com/methods/conversations.listConnectInvites `conversations.listConnectInvites` API reference}.
829 */
830 listConnectInvites: Method<ConversationsListConnectInvitesArguments, ConversationsListConnectInvitesResponse>;
831 /**
832 * @description Sets the read cursor in a channel.
833 * @see {@link https://api.slack.com/methods/conversations.mark `conversations.mark` API reference}.
834 */
835 mark: Method<ConversationsMarkArguments, ConversationsMarkResponse>;
836 /**
837 * @description Retrieve members of a conversation.
838 * @see {@link https://api.slack.com/methods/conversations.members `conversations.members` API reference}.
839 */
840 members: Method<ConversationsMembersArguments, ConversationsMembersResponse>;
841 /**
842 * @description Opens or resumes a direct message or multi-person direct message.
843 * @see {@link https://api.slack.com/methods/conversations.open `conversations.open` API reference}.
844 */
845 open: Method<ConversationsOpenArguments, ConversationsOpenResponse>;
846 /**
847 * @description Renames a conversation.
848 * @see {@link https://api.slack.com/methods/conversations.rename `conversations.rename` API reference}.
849 */
850 rename: Method<ConversationsRenameArguments, ConversationsRenameResponse>;
851 /**
852 * @description Retrieve a thread of messages posted to a conversation.
853 * @see {@link https://api.slack.com/methods/conversations.replies `conversations.replies` API reference}.
854 */
855 replies: Method<ConversationsRepliesArguments, ConversationsRepliesResponse>;
856 /**
857 * @description Sets the purpose for a conversation.
858 * @see {@link https://api.slack.com/methods/conversations.setPurpose `conversations.setPurpose` API reference}.
859 */
860 setPurpose: Method<ConversationsSetPurposeArguments, ConversationsSetPurposeResponse>;
861 /**
862 * @description Sets the topic for a conversation.
863 * @see {@link https://api.slack.com/methods/conversations.setTopic `conversations.setTopic` API reference}.
864 */
865 setTopic: Method<ConversationsSetTopicArguments, ConversationsSetTopicResponse>;
866 /**
867 * @description Reverses conversation archival.
868 * @see {@link https://api.slack.com/methods/conversations.unarchive `conversations.unarchive` API reference}.
869 */
870 unarchive: Method<ConversationsUnarchiveArguments, ConversationsUnarchiveResponse>;
871 };
872 readonly dialog: {
873 /**
874 * @description Open a dialog with a user.
875 * @see {@link https://api.slack.com/methods/dialog.open `dialog.open` API reference}.
876 */
877 open: Method<DialogOpenArguments, DialogOpenResponse>;
878 };
879 readonly dnd: {
880 /**
881 * @description Ends the current user's Do Not Disturb session immediately.
882 * @see {@link https://api.slack.com/methods/dnd.endDnd `dnd.endDnd` API reference}.
883 */
884 endDnd: Method<DndEndDndArguments, DndEndDndResponse>;
885 /**
886 * @description Ends the current user's snooze mode immediately.
887 * @see {@link https://api.slack.com/methods/dnd.endSnooze `dnd.endSnooze` API reference}.
888 */
889 endSnooze: Method<DndEndSnoozeArguments, DndEndSnoozeResponse>;
890 /**
891 * @description Retrieves a user's current Do Not Disturb status.
892 * @see {@link https://api.slack.com/methods/dnd.info `dnd.info` API reference}.
893 */
894 info: Method<DndInfoArguments, DndInfoResponse>;
895 /**
896 * @description Turns on Do Not Disturb mode for the current user, or changes its duration.
897 * @see {@link https://api.slack.com/methods/dnd.setSnooze `dnd.setSnooze` API reference}.
898 */
899 setSnooze: Method<DndSetSnoozeArguments, DndSetSnoozeResponse>;
900 /**
901 * @description Retrieves the Do Not Disturb status for up to 50 users on a team.
902 * @see {@link https://api.slack.com/methods/dnd.teamInfo `dnd.teamInfo` API reference}.
903 */
904 teamInfo: Method<DndTeamInfoArguments, DndTeamInfoResponse>;
905 };
906 readonly emoji: {
907 /**
908 * @description Lists custom emoji for a team.
909 * @see {@link https://api.slack.com/methods/emoji.list `emoji.list` API reference}.
910 */
911 list: Method<EmojiListArguments, EmojiListResponse>;
912 };
913 readonly files: {
914 /**
915 * @description Finishes an upload started with {@link https://api.slack.com/methods/files.getUploadURLExternal `files.getUploadURLExternal`}.
916 * @see {@link https://api.slack.com/methods/files.completeUploadExternal `files.completeUploadExternal` API reference}.
917 */
918 completeUploadExternal: Method<FilesCompleteUploadExternalArguments, FilesCompleteUploadExternalResponse>;
919 /**
920 * @description Deletes a file.
921 * @see {@link https://api.slack.com/methods/files.delete `files.delete` API reference}.
922 */
923 delete: Method<FilesDeleteArguments, FilesDeleteResponse>;
924 /**
925 * @description Gets a URL for an edge external file upload.
926 * @see {@link https://api.slack.com/methods/files.getUploadURLExternal `files.getUploadURLExternal` API reference}.
927 */
928 getUploadURLExternal: Method<FilesGetUploadURLExternalArguments, FilesGetUploadURLExternalResponse>;
929 /**
930 * @description Gets information about a file.
931 * @see {@link https://api.slack.com/methods/files.info `files.info` API reference}.
932 */
933 info: Method<FilesInfoArguments, FilesInfoResponse>;
934 /**
935 * @description List files for a team, in a channel, or from a user with applied filters.
936 * @see {@link https://api.slack.com/methods/files.list `files.list` API reference}.
937 */
938 list: Method<FilesListArguments, FilesListResponse>;
939 /**
940 * @description Revokes public/external sharing access for a file.
941 * @see {@link https://api.slack.com/methods/files.revokePublicURL `files.revokePublicURL` API reference}.
942 */
943 revokePublicURL: Method<FilesRevokePublicURLArguments, FilesRevokePublicURLResponse>;
944 /**
945 * @description Enables a file for public/external sharing.
946 * @see {@link https://api.slack.com/methods/files.revokePublicURL `files.revokePublicURL` API reference}.
947 */
948 sharedPublicURL: Method<FilesSharedPublicURLArguments, FilesSharedPublicURLResponse>;
949 /**
950 * @description Uploads or creates a file.
951 * @deprecated Use `uploadV2` instead. See {@link https://api.slack.com/changelog/2024-04-a-better-way-to-upload-files-is-here-to-stay our post on retiring `files.upload`}.
952 * @see {@link https://api.slack.com/methods/files.upload `files.upload` API reference}.
953 */
954 upload: Method<FilesUploadArguments, FilesUploadResponse>;
955 /**
956 * @description Custom method to support a new way of uploading files to Slack.
957 * Supports a single file upload
958 * Supply:
959 * - (required) single file or content
960 * - (optional) channel, alt_text, snippet_type,
961 * Supports multiple file uploads
962 * Supply:
963 * - multiple upload_files
964 * Will try to honor both single file or content data supplied as well
965 * as multiple file uploads property.
966 * @see {@link https://slack.dev/node-slack-sdk/web-api#upload-a-file `@slack/web-api` Upload a file documentation}.
967 */
968 uploadV2: Method<FilesUploadV2Arguments, WebAPICallResult>;
969 comments: {
970 /**
971 * @description Deletes an existing comment on a file.
972 * @see {@link https://api.slack.com/methods/files.comments.delete `files.comments.delete` API reference}.
973 */
974 delete: Method<FilesCommentsDeleteArguments, FilesCommentsDeleteResponse>;
975 };
976 remote: {
977 /**
978 * @description Adds a file from a remote service.
979 * @see {@link https://api.slack.com/methods/files.remote.add `files.remote.add` API reference}.
980 */
981 add: Method<FilesRemoteAddArguments, FilesRemoteAddResponse>;
982 /**
983 * @description Retrieve information about a remote file added to Slack.
984 * @see {@link https://api.slack.com/methods/files.remote.info `files.remote.info` API reference}.
985 */
986 info: Method<FilesRemoteInfoArguments, FilesRemoteInfoResponse>;
987 /**
988 * @description List remote files added to Slack.
989 * @see {@link https://api.slack.com/methods/files.remote.list `files.remote.list` API reference}.
990 */
991 list: Method<FilesRemoteListArguments, FilesRemoteListResponse>;
992 /**
993 * @description Remove a remote file.
994 * @see {@link https://api.slack.com/methods/files.remote.remove `files.remote.remove` API reference}.
995 */
996 remove: Method<FilesRemoteRemoveArguments, FilesRemoteRemoveResponse>;
997 /**
998 * @description Share a remote file into a channel.
999 * @see {@link https://api.slack.com/methods/files.remote.share `files.remote.share` API reference}.
1000 */
1001 share: Method<FilesRemoteShareArguments, FilesRemoteShareResponse>;
1002 /**
1003 * @description Updates an existing remote file.
1004 * @see {@link https://api.slack.com/methods/files.remote.update `files.remote.update` API reference}.
1005 */
1006 update: Method<FilesRemoteUpdateArguments, FilesRemoteUpdateResponse>;
1007 };
1008 };
1009 readonly functions: {
1010 /**
1011 * @description Signal the failure to execute a Custom Function.
1012 * @see {@link https://api.slack.com/methods/functions.completeError `functions.completeError` API reference}.
1013 */
1014 completeError: Method<FunctionsCompleteErrorArguments, FunctionsCompleteErrorResponse>;
1015 /**
1016 * @description Signal the successful completion of a Custom Function.
1017 * @see {@link https://api.slack.com/methods/functions.completeSuccess `functions.completeSuccess` API reference}.
1018 */
1019 completeSuccess: Method<FunctionsCompleteSuccessArguments, FunctionsCompleteSuccessResponse>;
1020 };
1021 readonly migration: {
1022 /**
1023 * @description For Enterprise Grid workspaces, map local user IDs to global user IDs.
1024 * @see {@link https://api.slack.com/methods/migration.exchange `migration.exchange` API reference}.
1025 */
1026 exchange: Method<MigrationExchangeArguments, MigrationExchangeResponse>;
1027 };
1028 readonly oauth: {
1029 /**
1030 * @description Exchanges a temporary OAuth verifier code for an access token.
1031 * @deprecated This is a legacy method only used by classic Slack apps. Use `oauth.v2.access` for new Slack apps.
1032 * @see {@link https://api.slack.com/methods/oauth.access `oauth.access` API reference}.
1033 */
1034 access: Method<OAuthAccessArguments, OauthAccessResponse>;
1035 v2: {
1036 /**
1037 * @description Exchanges a temporary OAuth verifier code for an access token.
1038 * @see {@link https://api.slack.com/methods/oauth.v2.access `oauth.v2.access` API reference}.
1039 */
1040 access: Method<OAuthV2AccessArguments, OauthV2AccessResponse>;
1041 /**
1042 * @description Exchanges a legacy access token for a new expiring access token and refresh token.
1043 * @see {@link https://api.slack.com/methods/oauth.v2.exchange `oauth.v2.exchange` API reference}.
1044 */
1045 exchange: Method<OAuthV2ExchangeArguments, OauthV2ExchangeResponse>;
1046 };
1047 };
1048 readonly openid: {
1049 connect: {
1050 /**
1051 * @description Exchanges a temporary OAuth verifier code for an access token for {@link https://api.slack.com/authentication/sign-in-with-slack Sign in with Slack}.
1052 * @see {@link https://api.slack.com/methods/openid.connect.token `openid.connect.token` API reference}.
1053 */
1054 token: Method<OpenIDConnectTokenArguments, OpenIDConnectTokenResponse>;
1055 /**
1056 * @description Get the identity of a user who has authorized {@link https://api.slack.com/authentication/sign-in-with-slack Sign in with Slack}.
1057 * @see {@link https://api.slack.com/methods/openid.connect.userInfo `openid.connect.userInfo` API reference}.
1058 */
1059 userInfo: Method<OpenIDConnectUserInfoArguments, OpenIDConnectUserInfoResponse>;
1060 };
1061 };
1062 readonly pins: {
1063 /**
1064 * @description Pins an item to a channel.
1065 * @see {@link https://api.slack.com/methods/pins.add `pins.add` API reference}.
1066 */
1067 add: Method<PinsAddArguments, PinsAddResponse>;
1068 /**
1069 * @description Lists items pinned to a channel.
1070 * @see {@link https://api.slack.com/methods/pins.list `pins.list` API reference}.
1071 */
1072 list: Method<PinsListArguments, PinsListResponse>;
1073 /**
1074 * @description Un-pins an item from a channel.
1075 * @see {@link https://api.slack.com/methods/pins.remove `pins.remove` API reference}.
1076 */
1077 remove: Method<PinsRemoveArguments, PinsRemoveResponse>;
1078 };
1079 readonly reactions: {
1080 /**
1081 * @description Adds a reaction to an item.
1082 * @see {@link https://api.slack.com/methods/reactions.add `reactions.add` API reference}.
1083 */
1084 add: Method<ReactionsAddArguments, ReactionsAddResponse>;
1085 /**
1086 * @description Gets reactions for an item.
1087 * @see {@link https://api.slack.com/methods/reactions.get `reactions.get` API reference}.
1088 */
1089 get: Method<ReactionsGetArguments, ReactionsGetResponse>;
1090 /**
1091 * @description List reactions made by a user.
1092 * @see {@link https://api.slack.com/methods/reactions.list `reactions.list` API reference}.
1093 */
1094 list: Method<ReactionsListArguments, ReactionsListResponse>;
1095 /**
1096 * @description Removes a reaction from an item.
1097 * @see {@link https://api.slack.com/methods/reactions.remove `reactions.remove` API reference}.
1098 */
1099 remove: Method<ReactionsRemoveArguments, ReactionsRemoveResponse>;
1100 };
1101 readonly reminders: {
1102 /**
1103 * @description Creates a reminder.
1104 * @see {@link https://api.slack.com/methods/reminders.add `reminders.add` API reference}.
1105 */
1106 add: Method<RemindersAddArguments, RemindersAddResponse>;
1107 /**
1108 * @description Marks a reminder as complete.
1109 * @see {@link https://api.slack.com/methods/reminders.complete `reminders.complete` API reference}.
1110 */
1111 complete: Method<RemindersCompleteArguments, RemindersCompleteResponse>;
1112 /**
1113 * @description Deletes a reminder.
1114 * @see {@link https://api.slack.com/methods/reminders.delete `reminders.delete` API reference}.
1115 */
1116 delete: Method<RemindersDeleteArguments, RemindersDeleteResponse>;
1117 /**
1118 * @description Gets information about a reminder.
1119 * @see {@link https://api.slack.com/methods/reminders.info `reminders.info` API reference}.
1120 */
1121 info: Method<RemindersInfoArguments, RemindersInfoResponse>;
1122 /**
1123 * @description Lists all reminders created by or for a given user.
1124 * @see {@link https://api.slack.com/methods/reminders.list `reminders.list` API reference}.
1125 */
1126 list: Method<RemindersListArguments, RemindersListResponse>;
1127 };
1128 readonly rtm: {
1129 /**
1130 * @description Starts a Real Time Messaging session.
1131 * @see {@link https://api.slack.com/methods/rtm.connect `rtm.connect` API reference}.
1132 */
1133 connect: Method<RTMConnectArguments, RtmConnectResponse>;
1134 /**
1135 * @description Starts a Real Time Messaging session.
1136 * @deprecated Use `rtm.connect` instead. See {@link https://api.slack.com/changelog/2021-10-rtm-start-to-stop our post on retiring `rtm.start`}.
1137 * @see {@link https://api.slack.com/methods/rtm.start `rtm.start` API reference}.
1138 */
1139 start: Method<RTMStartArguments, RtmStartResponse>;
1140 };
1141 readonly search: {
1142 /**
1143 * @description Searches for messages and files matching a query.
1144 * @see {@link https://api.slack.com/methods/search.all search.all` API reference}.
1145 */
1146 all: Method<SearchAllArguments, SearchAllResponse>;
1147 /**
1148 * @description Searches for files matching a query.
1149 * @see {@link https://api.slack.com/methods/search.files search.files` API reference}.
1150 */
1151 files: Method<SearchFilesArguments, SearchFilesResponse>;
1152 /**
1153 * @description Searches for messages matching a query.
1154 * @see {@link https://api.slack.com/methods/search.messages search.messages` API reference}.
1155 */
1156 messages: Method<SearchMessagesArguments, SearchMessagesResponse>;
1157 };
1158 readonly team: {
1159 /**
1160 * @description Gets the access logs for the current team.
1161 * @see {@link https://api.slack.com/methods/team.accessLogs `team.accessLogs` API reference}.
1162 */
1163 accessLogs: Method<TeamAccessLogsArguments, TeamAccessLogsResponse>;
1164 /**
1165 * @description Gets billable users information for the current team.
1166 * @see {@link https://api.slack.com/methods/team.billableInfo `team.billableInfo` API reference}.
1167 */
1168 billableInfo: Method<TeamBillableInfoArguments, TeamBillableInfoResponse>;
1169 billing: {
1170 /**
1171 * @description Reads a workspace's billing plan information.
1172 * @see {@link https://api.slack.com/methods/team.billing.info `team.billing.info` API reference}.
1173 */
1174 info: Method<TeamBillingInfoArguments, TeamBillingInfoResponse>;
1175 };
1176 /**
1177 * @description Gets information about the current team.
1178 * @see {@link https://api.slack.com/methods/team.info `team.info` API reference}.
1179 */
1180 info: Method<TeamInfoArguments, TeamInfoResponse>;
1181 /**
1182 * @description Gets the integration logs for the current team.
1183 * @see {@link https://api.slack.com/methods/team.integrationLogs `team.integrationLogs` API reference}.
1184 */
1185 integrationLogs: Method<TeamIntegrationLogsArguments, TeamIntegrationLogsResponse>;
1186 preferences: {
1187 /**
1188 * @description Retrieve a list of a workspace's team preferences.
1189 * @see {@link https://api.slack.com/methods/team.preferences.list `team.preferences.list` API reference}.
1190 */
1191 list: Method<TeamPreferencesListArguments, TeamPreferencesListResponse>;
1192 };
1193 profile: {
1194 /**
1195 * @description Retrieve a team's profile.
1196 * @see {@link https://api.slack.com/methods/team.profile.get `team.profile.get` API reference}.
1197 */
1198 get: Method<TeamProfileGetArguments, TeamProfileGetResponse>;
1199 };
1200 };
1201 readonly tooling: {
1202 tokens: {
1203 /**
1204 * @description Exchanges a refresh token for a new app configuration token.
1205 * @see {@link https://api.slack.com/methods/tooling.tokens.rotate `tooling.tokens.rotate` API reference}.
1206 */
1207 rotate: Method<ToolingTokensRotateArguments, ToolingTokensRotateResponse>;
1208 };
1209 };
1210 readonly usergroups: {
1211 /**
1212 * @description Create a User Group.
1213 * @see {@link https://api.slack.com/methods/usergroups.create `usergroups.create` API reference}.
1214 */
1215 create: Method<UsergroupsCreateArguments, UsergroupsCreateResponse>;
1216 /**
1217 * @description Disable an existing User Group.
1218 * @see {@link https://api.slack.com/methods/usergroups.disable `usergroups.disable` API reference}.
1219 */
1220 disable: Method<UsergroupsDisableArguments, UsergroupsDisableResponse>;
1221 /**
1222 * @description Enable an existing User Group.
1223 * @see {@link https://api.slack.com/methods/usergroups.enable `usergroups.enable` API reference}.
1224 */
1225 enable: Method<UsergroupsEnableArguments, UsergroupsEnableResponse>;
1226 /**
1227 * @description List all User Groups for a team.
1228 * @see {@link https://api.slack.com/methods/usergroups.list `usergroups.list` API reference}.
1229 */
1230 list: Method<UsergroupsListArguments, UsergroupsListResponse>;
1231 /**
1232 * @description Update an existing User Group.
1233 * @see {@link https://api.slack.com/methods/usergroups.update `usergroups.update` API reference}.
1234 */
1235 update: Method<UsergroupsUpdateArguments, UsergroupsUpdateResponse>;
1236 users: {
1237 /**
1238 * @description List all users in a User Group.
1239 * @see {@link https://api.slack.com/methods/usergroups.users.list `usergroups.users.list` API reference}.
1240 */
1241 list: Method<UsergroupsUsersListArguments, UsergroupsUsersListResponse>;
1242 /**
1243 * @description Update the list of users in a User Group.
1244 * @see {@link https://api.slack.com/methods/usergroups.users.update `usergroups.users.update` API reference}.
1245 */
1246 update: Method<UsergroupsUsersUpdateArguments, UsergroupsUsersUpdateResponse>;
1247 };
1248 };
1249 readonly users: {
1250 /**
1251 * @description List conversations the calling user may access.
1252 * @see {@link https://api.slack.com/methods/users.conversations `users.conversations` API reference}.
1253 */
1254 conversations: Method<UsersConversationsArguments, UsersConversationsResponse>;
1255 /**
1256 * @description Delete the user profile photo.
1257 * @see {@link https://api.slack.com/methods/users.deletePhoto `users.deletePhoto` API reference}.
1258 */
1259 deletePhoto: Method<UsersDeletePhotoArguments, UsersDeletePhotoResponse>;
1260 /**
1261 * @description Gets user presence information.
1262 * @see {@link https://api.slack.com/methods/users.getPresence `users.getPresence` API reference}.
1263 */
1264 getPresence: Method<UsersGetPresenceArguments, UsersGetPresenceResponse>;
1265 /**
1266 * @description Get a user's identity.
1267 * @see {@link https://api.slack.com/methods/users.identity `users.identity` API reference}.
1268 */
1269 identity: Method<UsersIdentityArguments, UsersIdentityResponse>;
1270 /**
1271 * @description Gets information about a user.
1272 * @see {@link https://api.slack.com/methods/users.info `users.info` API reference}.
1273 */
1274 info: Method<UsersInfoArguments, UsersInfoResponse>;
1275 /**
1276 * @description Lists all users in a Slack team.
1277 * @see {@link https://api.slack.com/methods/users.list `users.list` API reference}.
1278 */
1279 list: Method<UsersListArguments, UsersListResponse>;
1280 /**
1281 * @description Find a user with an email address.
1282 * @see {@link https://api.slack.com/methods/users.lookupByEmail `users.lookupByEmail` API reference}.
1283 */
1284 lookupByEmail: Method<UsersLookupByEmailArguments, UsersLookupByEmailResponse>;
1285 /**
1286 * @description Set the user profile photo.
1287 * @see {@link https://api.slack.com/methods/users.setPhoto `users.setPhoto` API reference}.
1288 */
1289 setPhoto: Method<UsersSetPhotoArguments, UsersSetPhotoResponse>;
1290 /**
1291 * @description Manually sets user presence.
1292 * @see {@link https://api.slack.com/methods/users.setPresence `users.setPresence` API reference}.
1293 */
1294 setPresence: Method<UsersSetPresenceArguments, UsersSetPresenceResponse>;
1295 profile: {
1296 /**
1297 * @description Retrieve a user's profile information, including their custom status.
1298 * @see {@link https://api.slack.com/methods/users.profile.get `users.profile.get` API reference}.
1299 */
1300 get: Method<UsersProfileGetArguments, UsersProfileGetResponse>;
1301 /**
1302 * @description Set a user's profile information, including custom status.
1303 * @see {@link https://api.slack.com/methods/users.profile.set `users.profile.set` API reference}.
1304 */
1305 set: Method<UsersProfileSetArguments, UsersProfileSetResponse>;
1306 };
1307 };
1308 readonly views: {
1309 /**
1310 * @description Open a view for a user.
1311 * @see {@link https://api.slack.com/methods/views.open `views.open` API reference}.
1312 */
1313 open: Method<ViewsOpenArguments, ViewsOpenResponse>;
1314 /**
1315 * @description Publish a static view for a user.
1316 * @see {@link https://api.slack.com/methods/views.publish `views.publish` API reference}.
1317 */
1318 publish: Method<ViewsPublishArguments, ViewsPublishResponse>;
1319 /**
1320 * @description Push a view onto the stack of a root view.
1321 * @see {@link https://api.slack.com/methods/views.push `views.push` API reference}.
1322 */
1323 push: Method<ViewsPushArguments, ViewsPushResponse>;
1324 /**
1325 * @description Update an existing view.
1326 * @see {@link https://api.slack.com/methods/views.update `views.update` API reference}.
1327 */
1328 update: Method<ViewsUpdateArguments, ViewsUpdateResponse>;
1329 };
1330 readonly stars: {
1331 /**
1332 * @description Save an item for later. Formerly known as adding a star.
1333 * @deprecated Stars can still be added but they can no longer be viewed or interacted with by end-users.
1334 * See {@link https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders our post on stars and the Later list}.
1335 * @see {@link https://api.slack.com/methods/stars.add `stars.add` API reference}.
1336 */
1337 add: Method<StarsAddRemoveArguments, StarsAddResponse>;
1338 /**
1339 * @description List a user's saved items, formerly known as stars.
1340 * @deprecated Stars can still be listed but they can no longer be viewed or interacted with by end-users.
1341 * See {@link https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders our post on stars and the Later list}.
1342 * @see {@link https://api.slack.com/methods/stars.list `stars.list` API reference}.
1343 */
1344 list: Method<StarsListArguments, StarsListResponse>;
1345 /**
1346 * @description Remove a saved item from a user's saved items, formerly known as stars.
1347 * @deprecated Stars can still be removed but they can no longer be viewed or interacted with by end-users.
1348 * See {@link https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders our post on stars and the Later list}.
1349 * @see {@link https://api.slack.com/methods/stars.remove `stars.remove` API reference}.
1350 */
1351 remove: Method<StarsAddRemoveArguments, StarsRemoveResponse>;
1352 };
1353 readonly workflows: {
1354 /**
1355 * @description Indicate that an app's step in a workflow completed execution.
1356 * @deprecated Steps from Apps is deprecated.
1357 * We're retiring all Slack app functionality around Steps from Apps in September 2024.
1358 * See {@link https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back our post on deprecating Steps from Apps}.
1359 * @see {@link https://api.slack.com/methods/workflows.stepCompleted `workflows.stepCompleted` API reference}.
1360 */
1361 stepCompleted: Method<WorkflowsStepCompletedArguments, WorkflowsStepCompletedResponse>;
1362 /**
1363 * @description Indicate that an app's step in a workflow failed to execute.
1364 * @deprecated Steps from Apps is deprecated.
1365 * We're retiring all Slack app functionality around Steps from Apps in September 2024.
1366 * See {@link https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back our post on deprecating Steps from Apps}.
1367 * @see {@link https://api.slack.com/methods/workflows.stepFailed `workflows.stepFailed` API reference}.
1368 */
1369 stepFailed: Method<WorkflowsStepFailedArguments, WorkflowsStepFailedResponse>;
1370 /**
1371 * @description Update the configuration for a workflow step.
1372 * @deprecated Steps from Apps is deprecated.
1373 * We're retiring all Slack app functionality around Steps from Apps in September 2024.
1374 * See {@link https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back our post on deprecating Steps from Apps}.
1375 * @see {@link https://api.slack.com/methods/workflows.updateStep `workflows.updateStep` API reference}.
1376 */
1377 updateStep: Method<WorkflowsUpdateStepArguments, WorkflowsUpdateStepResponse>;
1378 };
1379}
1380export * from '@slack/types';
1381//# sourceMappingURL=methods.d.ts.map
\No newline at end of file