@slack/web-api

/// <reference types="node" /> /// <reference types="node" /> import { Stream } from 'stream'; import { Dialog, View, KnownBlock, Block, MessageAttachment, LinkUnfurls, CallUser, MessageMetadata } from '@slack/types'; import { EventEmitter } from 'eventemitter3'; import { WebAPICallOptions, WebAPICallResult, WebClientEvent } from './WebClient'; import { 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, 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'; /** * A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the * `apiCall` class method. */ export declare abstract class Methods extends EventEmitter<WebClientEvent> { protected constructor(); abstract apiCall(method: string, options?: WebAPICallOptions): Promise<WebAPICallResult>; abstract filesUploadV2(options?: WebAPICallOptions): Promise<WebAPICallResult>; readonly admin: { analytics: { getFile: Method<AdminAnalyticsGetFileArguments, AdminAnalyticsGetFileResponse>; }; apps: { approve: Method<AdminAppsApproveArguments, AdminAppsApproveResponse>; approved: { list: Method<AdminAppsApprovedListArguments, AdminAppsApprovedListResponse>; }; clearResolution: Method<AdminAppsClearResolutionArguments, AdminAppsClearResolutionResponse>; requests: { cancel: Method<AdminAppsRequestsCancelArguments, AdminAppsRequestsCancelResponse>; list: Method<AdminAppsRequestsListArguments, AdminAppsRequestsListResponse>; }; restrict: Method<AdminAppsRestrictArguments, AdminAppsRestrictResponse>; restricted: { list: Method<AdminAppsRestrictedListArguments, AdminAppsRestrictedListResponse>; }; uninstall: Method<AdminAppsUninstallArguments, AdminAppsUninstallResponse>; }; auth: { policy: { assignEntities: Method<AdminAuthPolicyAssignEntitiesArguments, AdminAuthPolicyAssignEntitiesResponse>; getEntities: Method<AdminAuthPolicyGetEntitiesArguments, AdminAuthPolicyGetEntitiesResponse>; removeEntities: Method<AdminAuthPolicyRemoveEntitiesArguments, AdminAuthPolicyRemoveEntitiesResponse>; }; }; barriers: { create: Method<AdminBarriersCreateArguments, AdminBarriersCreateResponse>; delete: Method<AdminBarriersDeleteArguments, AdminBarriersDeleteResponse>; list: Method<AdminBarriersListArguments, AdminBarriersListResponse>; update: Method<AdminBarriersUpdateArguments, AdminBarriersUpdateResponse>; }; conversations: { archive: Method<AdminConversationsArchiveArguments, AdminConversationsArchiveResponse>; bulkArchive: Method<AdminConversationsBulkArchiveArguments, AdminConversationsBulkArchiveResponse>; bulkDelete: Method<AdminConversationsBulkDeleteArguments, AdminConversationsBulkDeleteResponse>; bulkMove: Method<AdminConversationsBulkMoveArguments, AdminConversationsBulkMoveResponse>; convertToPrivate: Method<AdminConversationsConvertToPrivateArguments, AdminConversationsConvertToPrivateResponse>; create: Method<AdminConversationsCreateArguments, AdminConversationsCreateResponse>; delete: Method<AdminConversationsDeleteArguments, AdminConversationsDeleteResponse>; disconnectShared: Method<AdminConversationsDisconnectSharedArguments, AdminConversationsDisconnectSharedResponse>; ekm: { listOriginalConnectedChannelInfo: Method<AdminConversationsEKMListOriginalConnectedChannelInfoArguments, AdminConversationsEkmListOriginalConnectedChannelInfoResponse>; }; getConversationPrefs: Method<AdminConversationsGetConversationPrefsArguments, AdminConversationsGetConversationPrefsResponse>; getTeams: Method<AdminConversationsGetTeamsArguments, AdminConversationsGetTeamsResponse>; invite: Method<AdminConversationsInviteArguments, AdminConversationsInviteResponse>; rename: Method<AdminConversationsRenameArguments, AdminConversationsRenameResponse>; restrictAccess: { addGroup: Method<AdminConversationsRestrictAccessAddGroupArguments, AdminConversationsRestrictAccessAddGroupResponse>; listGroups: Method<AdminConversationsRestrictAccessListGroupsArguments, AdminConversationsRestrictAccessListGroupsResponse>; removeGroup: Method<AdminConversationsRestrictAccessRemoveGroupArguments, AdminConversationsRestrictAccessRemoveGroupResponse>; }; getCustomRetention: Method<AdminConversationsGetCustomRetentionArguments, AdminConversationsGetCustomRetentionResponse>; setCustomRetention: Method<AdminConversationsSetCustomRetentionArguments, AdminConversationsSetCustomRetentionResponse>; removeCustomRetention: Method<AdminConversationsRemoveCustomRetentionArguments, AdminConversationsRemoveCustomRetentionResponse>; search: Method<AdminConversationsSearchArguments, AdminConversationsSearchResponse>; setConversationPrefs: Method<AdminConversationsSetConversationPrefsArguments, AdminConversationsSetConversationPrefsResponse>; setTeams: Method<AdminConversationsSetTeamsArguments, AdminConversationsSetTeamsResponse>; unarchive: Method<AdminConversationsUnarchiveArguments, AdminConversationsUnarchiveResponse>; }; emoji: { add: Method<AdminEmojiAddArguments, AdminEmojiAddResponse>; addAlias: Method<AdminEmojiAddAliasArguments, AdminEmojiAddAliasResponse>; list: Method<AdminEmojiListArguments, AdminEmojiListResponse>; remove: Method<AdminEmojiRemoveArguments, AdminEmojiRemoveResponse>; rename: Method<AdminEmojiRenameArguments, AdminEmojiRenameResponse>; }; inviteRequests: { approve: Method<AdminInviteRequestsApproveArguments, AdminInviteRequestsApproveResponse>; approved: { list: Method<AdminInviteRequestsApprovedListArguments, AdminInviteRequestsApprovedListResponse>; }; denied: { list: Method<AdminInviteRequestsDeniedListArguments, AdminInviteRequestsDeniedListResponse>; }; deny: Method<AdminInviteRequestsDenyArguments, AdminInviteRequestsDenyResponse>; list: Method<AdminInviteRequestsListArguments, AdminInviteRequestsListResponse>; }; teams: { admins: { list: Method<AdminTeamsAdminsListArguments, AdminTeamsAdminsListResponse>; }; create: Method<AdminTeamsCreateArguments, AdminTeamsCreateResponse>; list: Method<AdminTeamsListArguments, AdminTeamsListResponse>; owners: { list: Method<AdminTeamsOwnersListArguments, AdminTeamsOwnersListResponse>; }; settings: { info: Method<AdminTeamsSettingsInfoArguments, AdminTeamsSettingsInfoResponse>; setDefaultChannels: Method<AdminTeamsSettingsSetDefaultChannelsArguments, AdminTeamsSettingsSetDefaultChannelsResponse>; setDescription: Method<AdminTeamsSettingsSetDescriptionArguments, AdminTeamsSettingsSetDescriptionResponse>; setDiscoverability: Method<AdminTeamsSettingsSetDiscoverabilityArguments, AdminTeamsSettingsSetDiscoverabilityResponse>; setIcon: Method<AdminTeamsSettingsSetIconArguments, AdminTeamsSettingsSetIconResponse>; setName: Method<AdminTeamsSettingsSetNameArguments, AdminTeamsSettingsSetNameResponse>; }; }; usergroups: { addChannels: Method<AdminUsergroupsAddChannelsArguments, AdminUsergroupsAddChannelsResponse>; addTeams: Method<AdminUsergroupsAddTeamsArguments, AdminUsergroupsAddTeamsResponse>; listChannels: Method<AdminUsergroupsListChannelsArguments, AdminUsergroupsListChannelsResponse>; removeChannels: Method<AdminUsergroupsRemoveChannelsArguments, AdminUsergroupsRemoveChannelsResponse>; }; users: { assign: Method<AdminUsersAssignArguments, AdminUsersAssignResponse>; invite: Method<AdminUsersInviteArguments, AdminUsersInviteResponse>; list: Method<AdminUsersListArguments, AdminUsersListResponse>; remove: Method<AdminUsersRemoveArguments, AdminUsersRemoveResponse>; session: { list: Method<AdminUsersSessionListArguments, AdminUsersSessionListResponse>; reset: Method<AdminUsersSessionResetArguments, AdminUsersSessionResetResponse>; resetBulk: Method<AdminUsersSessionResetBulkArguments, AdminUsersSessionResetBulkResponse>; invalidate: Method<AdminUsersSessionInvalidateArguments, AdminUsersSessionInvalidateResponse>; getSettings: Method<AdminUsersSessionGetSettingsArguments, AdminUsersSessionGetSettingsResponse>; setSettings: Method<AdminUsersSessionSetSettingsArguments, AdminUsersSessionSetSettingsResponse>; clearSettings: Method<AdminUsersSessionClearSettingsArguments, AdminUsersSessionClearSettingsResponse>; }; unsupportedVersions: { export: Method<AdminUsersUnsupportedVersionsExportArguments, AdminUsersUnsupportedVersionsExportResponse>; }; setAdmin: Method<AdminUsersSetAdminArguments, AdminUsersSetAdminResponse>; setExpiration: Method<AdminUsersSetExpirationArguments, AdminUsersSetExpirationResponse>; setOwner: Method<AdminUsersSetOwnerArguments, AdminUsersSetOwnerResponse>; setRegular: Method<AdminUsersSetRegularArguments, AdminUsersSetRegularResponse>; }; }; readonly api: { test: Method<APITestArguments, ApiTestResponse>; }; readonly apps: { connections: { open: Method<AppsConnectionsOpenArguments, AppsConnectionsOpenResponse>; }; event: { authorizations: { list: Method<AppsEventAuthorizationsListArguments, AppsEventAuthorizationsListResponse>; }; }; uninstall: Method<AppsUninstallArguments, AppsUninstallResponse>; }; readonly auth: { revoke: Method<AuthRevokeArguments, AuthRevokeResponse>; teams: { list: Method<AuthTeamsListArguments, AuthTeamsListResponse>; }; test: Method<AuthTestArguments, AuthTestResponse>; }; readonly bots: { info: Method<BotsInfoArguments, BotsInfoResponse>; }; readonly bookmarks: { add: Method<BookmarksAddArguments, BookmarksAddResponse>; edit: Method<BookmarksEditArguments, BookmarksEditResponse>; list: Method<BookmarksListArguments, BookmarksListResponse>; remove: Method<BookmarksRemoveArguments, BookmarksRemoveResponse>; }; readonly calls: { add: Method<CallsAddArguments, CallsAddResponse>; end: Method<CallsEndArguments, CallsEndResponse>; info: Method<CallsInfoArguments, CallsInfoResponse>; update: Method<CallsUpdateArguments, CallsUpdateResponse>; participants: { add: Method<CallsParticipantsAddArguments, CallsParticipantsAddResponse>; remove: Method<CallsParticipantsRemoveArguments, CallsParticipantsRemoveResponse>; }; }; readonly chat: { delete: Method<ChatDeleteArguments, ChatDeleteResponse>; deleteScheduledMessage: Method<ChatDeleteScheduledMessageArguments, ChatDeleteScheduledMessageResponse>; getPermalink: Method<ChatGetPermalinkArguments, ChatGetPermalinkResponse>; meMessage: Method<ChatMeMessageArguments, ChatMeMessageResponse>; postEphemeral: Method<ChatPostEphemeralArguments, ChatPostEphemeralResponse>; postMessage: Method<ChatPostMessageArguments, ChatPostMessageResponse>; scheduleMessage: Method<ChatScheduleMessageArguments, ChatScheduleMessageResponse>; scheduledMessages: { list: Method<ChatScheduledMessagesListArguments, ChatScheduledMessagesListResponse>; }; unfurl: Method<ChatUnfurlArguments, ChatUnfurlResponse>; update: Method<ChatUpdateArguments, ChatUpdateResponse>; }; readonly conversations: { acceptSharedInvite: Method<ConversationsAcceptSharedInviteArguments, ConversationsAcceptSharedInviteResponse>; approveSharedInvite: Method<ConversationsApproveSharedInviteArguments, ConversationsApproveSharedInviteResponse>; archive: Method<ConversationsArchiveArguments, ConversationsArchiveResponse>; close: Method<ConversationsCloseArguments, ConversationsCloseResponse>; create: Method<ConversationsCreateArguments, ConversationsCreateResponse>; declineSharedInvite: Method<ConversationsDeclineSharedInviteArguments, ConversationsDeclineSharedInviteResponse>; history: Method<ConversationsHistoryArguments, ConversationsHistoryResponse>; info: Method<ConversationsInfoArguments, ConversationsInfoResponse>; invite: Method<ConversationsInviteArguments, ConversationsInviteResponse>; inviteShared: Method<ConversationsInviteSharedArguments, ConversationsInviteSharedResponse>; join: Method<ConversationsJoinArguments, ConversationsJoinResponse>; kick: Method<ConversationsKickArguments, ConversationsKickResponse>; leave: Method<ConversationsLeaveArguments, ConversationsLeaveResponse>; list: Method<ConversationsListArguments, ConversationsListResponse>; listConnectInvites: Method<ConversationsListConnectInvitesArguments, ConversationsListConnectInvitesResponse>; mark: Method<ConversationsMarkArguments, ConversationsMarkResponse>; members: Method<ConversationsMembersArguments, ConversationsMembersResponse>; open: Method<ConversationsOpenArguments, ConversationsOpenResponse>; rename: Method<ConversationsRenameArguments, ConversationsRenameResponse>; replies: Method<ConversationsRepliesArguments, ConversationsRepliesResponse>; setPurpose: Method<ConversationsSetPurposeArguments, ConversationsSetPurposeResponse>; setTopic: Method<ConversationsSetTopicArguments, ConversationsSetTopicResponse>; unarchive: Method<ConversationsUnarchiveArguments, ConversationsUnarchiveResponse>; }; readonly dialog: { open: Method<DialogOpenArguments, DialogOpenResponse>; }; readonly dnd: { endDnd: Method<DndEndDndArguments, DndEndDndResponse>; endSnooze: Method<DndEndSnoozeArguments, DndEndSnoozeResponse>; info: Method<DndInfoArguments, DndInfoResponse>; setSnooze: Method<DndSetSnoozeArguments, DndSetSnoozeResponse>; teamInfo: Method<DndTeamInfoArguments, DndTeamInfoResponse>; }; readonly emoji: { list: Method<EmojiListArguments, EmojiListResponse>; }; readonly files: { delete: Method<FilesDeleteArguments, FilesDeleteResponse>; info: Method<FilesInfoArguments, FilesInfoResponse>; list: Method<FilesListArguments, FilesListResponse>; revokePublicURL: Method<FilesRevokePublicURLArguments, FilesRevokePublicURLResponse>; sharedPublicURL: Method<FilesSharedPublicURLArguments, FilesSharedPublicURLResponse>; upload: Method<FilesUploadArguments, FilesUploadResponse>; /** * Custom method to support files upload v2 way of uploading files to Slack * Supports a single file upload * Supply: * - (required) single file or content * - (optional) channel, alt_text, snippet_type, * Supports multiple file uploads * Supply: * - multiple upload_files * Will try to honor both single file or content data supplied as well * as multiple file uploads property. */ uploadV2: Method<FilesUploadV2Arguments, WebAPICallResult>; getUploadURLExternal: Method<FilesGetUploadURLExternalArguments, FilesGetUploadURLExternalResponse>; completeUploadExternal: Method<FilesCompleteUploadExternalArguments, FilesCompleteUploadExternalResponse>; comments: { delete: Method<FilesCommentsDeleteArguments, FilesCommentsDeleteResponse>; }; remote: { info: Method<FilesRemoteInfoArguments, FilesRemoteInfoResponse>; list: Method<FilesRemoteListArguments, FilesRemoteListResponse>; add: Method<FilesRemoteAddArguments, FilesRemoteAddResponse>; update: Method<FilesRemoteUpdateArguments, FilesRemoteUpdateResponse>; remove: Method<FilesRemoteRemoveArguments, FilesRemoteRemoveResponse>; share: Method<FilesRemoteShareArguments, FilesRemoteShareResponse>; }; }; readonly migration: { exchange: Method<MigrationExchangeArguments, MigrationExchangeResponse>; }; readonly oauth: { access: Method<OAuthAccessArguments, OauthAccessResponse>; v2: { access: Method<OAuthV2AccessArguments, OauthV2AccessResponse>; exchange: Method<OAuthV2ExchangeArguments, OauthV2ExchangeResponse>; }; }; readonly openid: { connect: { token: Method<OpenIDConnectTokenArguments, OpenIDConnectTokenResponse>; userInfo: Method<OpenIDConnectUserInfoArguments, OpenIDConnectUserInfoResponse>; }; }; readonly pins: { add: Method<PinsAddArguments, PinsAddResponse>; list: Method<PinsListArguments, PinsListResponse>; remove: Method<PinsRemoveArguments, PinsRemoveResponse>; }; readonly reactions: { add: Method<ReactionsAddArguments, ReactionsAddResponse>; get: Method<ReactionsGetArguments, ReactionsGetResponse>; list: Method<ReactionsListArguments, ReactionsListResponse>; remove: Method<ReactionsRemoveArguments, ReactionsRemoveResponse>; }; readonly reminders: { add: Method<RemindersAddArguments, RemindersAddResponse>; complete: Method<RemindersCompleteArguments, RemindersCompleteResponse>; delete: Method<RemindersDeleteArguments, RemindersDeleteResponse>; info: Method<RemindersInfoArguments, RemindersInfoResponse>; list: Method<RemindersListArguments, RemindersListResponse>; }; readonly rtm: { connect: Method<RTMConnectArguments, RtmConnectResponse>; start: Method<RTMStartArguments, RtmStartResponse>; }; readonly search: { all: Method<SearchAllArguments, SearchAllResponse>; files: Method<SearchFilesArguments, SearchFilesResponse>; messages: Method<SearchMessagesArguments, SearchMessagesResponse>; }; readonly stars: { add: Method<StarsAddArguments, StarsAddResponse>; list: Method<StarsListArguments, StarsListResponse>; remove: Method<StarsRemoveArguments, StarsRemoveResponse>; }; readonly team: { accessLogs: Method<TeamAccessLogsArguments, TeamAccessLogsResponse>; billableInfo: Method<TeamBillableInfoArguments, TeamBillableInfoResponse>; billing: { info: Method<TeamBillingInfoArguments, TeamBillingInfoResponse>; }; info: Method<TeamInfoArguments, TeamInfoResponse>; integrationLogs: Method<TeamIntegrationLogsArguments, TeamIntegrationLogsResponse>; preferences: { list: Method<TeamPreferencesListArguments, TeamPreferencesListResponse>; }; profile: { get: Method<TeamProfileGetArguments, TeamProfileGetResponse>; }; }; readonly usergroups: { create: Method<UsergroupsCreateArguments, UsergroupsCreateResponse>; disable: Method<UsergroupsDisableArguments, UsergroupsDisableResponse>; enable: Method<UsergroupsEnableArguments, UsergroupsEnableResponse>; list: Method<UsergroupsListArguments, UsergroupsListResponse>; update: Method<UsergroupsUpdateArguments, UsergroupsUpdateResponse>; users: { list: Method<UsergroupsUsersListArguments, UsergroupsUsersListResponse>; update: Method<UsergroupsUsersUpdateArguments, UsergroupsUsersUpdateResponse>; }; }; readonly users: { conversations: Method<UsersConversationsArguments, UsersConversationsResponse>; deletePhoto: Method<UsersDeletePhotoArguments, UsersDeletePhotoResponse>; getPresence: Method<UsersGetPresenceArguments, UsersGetPresenceResponse>; identity: Method<UsersIdentityArguments, UsersIdentityResponse>; info: Method<UsersInfoArguments, UsersInfoResponse>; list: Method<UsersListArguments, UsersListResponse>; lookupByEmail: Method<UsersLookupByEmailArguments, UsersLookupByEmailResponse>; setPhoto: Method<UsersSetPhotoArguments, UsersSetPhotoResponse>; setPresence: Method<UsersSetPresenceArguments, UsersSetPresenceResponse>; profile: { get: Method<UsersProfileGetArguments, UsersProfileGetResponse>; set: Method<UsersProfileSetArguments, UsersProfileSetResponse>; }; }; readonly views: { open: Method<ViewsOpenArguments, ViewsOpenResponse>; publish: Method<ViewsPublishArguments, ViewsPublishResponse>; push: Method<ViewsPushArguments, ViewsPushResponse>; update: Method<ViewsUpdateArguments, ViewsUpdateResponse>; }; readonly workflows: { stepCompleted: Method<WorkflowsStepCompletedArguments, WorkflowsStepCompletedResponse>; stepFailed: Method<WorkflowsStepFailedArguments, WorkflowsStepFailedResponse>; updateStep: Method<WorkflowsUpdateStepArguments, WorkflowsUpdateStepResponse>; }; readonly channels: { archive: Method<ChannelsArchiveArguments, WebAPICallResult>; create: Method<ChannelsCreateArguments, WebAPICallResult>; history: Method<ChannelsHistoryArguments, WebAPICallResult>; info: Method<ChannelsInfoArguments, WebAPICallResult>; invite: Method<ChannelsInviteArguments, WebAPICallResult>; join: Method<ChannelsJoinArguments, WebAPICallResult>; kick: Method<ChannelsKickArguments, WebAPICallResult>; leave: Method<ChannelsLeaveArguments, WebAPICallResult>; list: Method<ChannelsListArguments, WebAPICallResult>; mark: Method<ChannelsMarkArguments, WebAPICallResult>; rename: Method<ChannelsRenameArguments, WebAPICallResult>; replies: Method<ChannelsRepliesArguments, WebAPICallResult>; setPurpose: Method<ChannelsSetPurposeArguments, WebAPICallResult>; setTopic: Method<ChannelsSetTopicArguments, WebAPICallResult>; unarchive: Method<ChannelsUnarchiveArguments, WebAPICallResult>; }; readonly groups: { archive: Method<GroupsArchiveArguments, WebAPICallResult>; create: Method<GroupsCreateArguments, WebAPICallResult>; createChild: Method<GroupsCreateChildArguments, WebAPICallResult>; history: Method<GroupsHistoryArguments, WebAPICallResult>; info: Method<GroupsInfoArguments, WebAPICallResult>; invite: Method<GroupsInviteArguments, WebAPICallResult>; kick: Method<GroupsKickArguments, WebAPICallResult>; leave: Method<GroupsLeaveArguments, WebAPICallResult>; list: Method<GroupsListArguments, WebAPICallResult>; mark: Method<GroupsMarkArguments, WebAPICallResult>; open: Method<GroupsOpenArguments, WebAPICallResult>; rename: Method<GroupsRenameArguments, WebAPICallResult>; replies: Method<GroupsRepliesArguments, WebAPICallResult>; setPurpose: Method<GroupsSetPurposeArguments, WebAPICallResult>; setTopic: Method<GroupsSetTopicArguments, WebAPICallResult>; unarchive: Method<GroupsUnarchiveArguments, WebAPICallResult>; }; readonly im: { close: Method<IMCloseArguments, WebAPICallResult>; history: Method<IMHistoryArguments, WebAPICallResult>; list: Method<IMListArguments, WebAPICallResult>; mark: Method<IMMarkArguments, WebAPICallResult>; open: Method<IMOpenArguments, WebAPICallResult>; replies: Method<IMRepliesArguments, WebAPICallResult>; }; readonly mpim: { close: Method<MPIMCloseArguments, WebAPICallResult>; history: Method<MPIMHistoryArguments, WebAPICallResult>; list: Method<MPIMListArguments, WebAPICallResult>; mark: Method<MPIMMarkArguments, WebAPICallResult>; open: Method<MPIMOpenArguments, WebAPICallResult>; replies: Method<MPIMRepliesArguments, WebAPICallResult>; }; } /** * Generic method definition */ export default interface Method<MethodArguments extends WebAPICallOptions, MethodResult extends WebAPICallResult = WebAPICallResult> { (options?: MethodArguments): Promise<MethodResult>; } export interface TokenOverridable { token?: string; } export interface LocaleAware { include_locale?: boolean; } export interface Searchable { query: string; highlight?: boolean; sort: 'score' | 'timestamp'; sort_dir: 'asc' | 'desc'; team_id?: string; } export declare const cursorPaginationEnabledMethods: Set<string>; export interface CursorPaginationEnabled { limit?: number; cursor?: string; } export interface TimelinePaginationEnabled { oldest?: string; latest?: string; inclusive?: boolean; } export interface TraditionalPagingEnabled { page?: number; count?: number; } export interface AdminAnalyticsGetFileArguments extends WebAPICallOptions, TokenOverridable { type: string; date?: string; metadata_only?: boolean; } export interface AdminAppsApproveArguments extends WebAPICallOptions, TokenOverridable { app_id?: string; request_id?: string; team_id?: string; } export interface AdminAppsApprovedListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { team_id?: string; enterprise_id?: string; } export interface AdminAppsClearResolutionArguments extends WebAPICallOptions { app_id: string; enterprise_id?: string; team_id?: string; } export interface AdminAppsRequestsCancelArguments extends WebAPICallOptions, TokenOverridable { request_id: string; enterprise_id?: string; team_id?: string; } export interface AdminAppsRequestsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { team_id?: string; } export interface AdminAppsRestrictArguments extends WebAPICallOptions, TokenOverridable { app_id?: string; request_id?: string; team_id?: string; } export interface AdminAppsRestrictedListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { team_id?: string; enterprise_id?: string; } export interface AdminAppsUninstallArguments extends WebAPICallOptions { app_id: string; enterprise_id?: string; team_ids?: string[]; } export interface AdminAuthPolicyAssignEntitiesArguments extends WebAPICallOptions, TokenOverridable { entity_ids: string[]; entity_type: string; policy_name: string; } export interface AdminAuthPolicyGetEntitiesArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { policy_name: string; entity_type?: string; } export interface AdminAuthPolicyRemoveEntitiesArguments extends WebAPICallOptions, TokenOverridable { entity_ids: string[]; entity_type: string; policy_name: string; } export interface AdminBarriersCreateArguments extends WebAPICallOptions, TokenOverridable { barriered_from_usergroup_ids: string[]; primary_usergroup_id: string; restricted_subjects: string[]; } export interface AdminBarriersDeleteArguments extends WebAPICallOptions, TokenOverridable { barrier_id: string; } export interface AdminBarriersListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { } export interface AdminBarriersUpdateArguments extends WebAPICallOptions, TokenOverridable { barrier_id: string; barriered_from_usergroup_ids: string[]; primary_usergroup_id: string; restricted_subjects: string[]; } export interface AdminConversationsArchiveArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; } export interface AdminConversationsBulkArchiveArguments extends WebAPICallOptions, TokenOverridable { channel_ids: string[]; } export interface AdminConversationsBulkDeleteArguments extends WebAPICallOptions, TokenOverridable { channel_ids: string[]; } export interface AdminConversationsBulkMoveArguments extends WebAPICallOptions, TokenOverridable { channel_ids: string[]; target_team_id: string; } export interface AdminConversationsConvertToPrivateArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; } export interface AdminConversationsCreateArguments extends WebAPICallOptions, TokenOverridable { is_private: boolean; name: string; description?: string; org_wide?: boolean; team_id?: string; } export interface AdminConversationsDeleteArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; } export interface AdminConversationsDisconnectSharedArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; leaving_team_ids?: string[]; } export interface AdminConversationsEKMListOriginalConnectedChannelInfoArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { channel_ids?: string[]; team_ids?: string[]; } export interface AdminConversationsGetConversationPrefsArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; } export interface AdminConversationsGetTeamsArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { channel_id: string; } export interface AdminConversationsInviteArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; user_ids: string[]; } export interface AdminConversationsRenameArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; name: string; } export interface AdminConversationsRestrictAccessAddGroupArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; group_id: string; team_id?: string; } export interface AdminConversationsRestrictAccessListGroupsArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; team_id?: string; } export interface AdminConversationsRestrictAccessRemoveGroupArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; group_id: string; team_id: string; } export interface AdminConversationsGetCustomRetentionArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; } export interface AdminConversationsSetCustomRetentionArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; duration_days: number; } export interface AdminConversationsRemoveCustomRetentionArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; } export interface AdminConversationsSearchArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { query?: string; search_channel_types?: string[]; sort?: 'relevant' | 'name' | 'member_count' | 'created'; sort_dir?: 'asc' | 'desc'; team_ids?: string[]; } export interface AdminConversationsSetConversationPrefsArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; prefs: Record<string, unknown>; } export interface AdminConversationsSetTeamsArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; team_id?: string; target_team_ids?: string[]; org_channel?: boolean; } export interface AdminConversationsUnarchiveArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; } export interface AdminEmojiAddArguments extends WebAPICallOptions, TokenOverridable { name: string; url: string; } export interface AdminEmojiAddAliasArguments extends WebAPICallOptions, TokenOverridable { name: string; alias_for: string; } export interface AdminEmojiListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { } export interface AdminEmojiRemoveArguments extends WebAPICallOptions, TokenOverridable { name: string; } export interface AdminEmojiRenameArguments extends WebAPICallOptions, TokenOverridable { name: string; new_name: string; } export interface AdminInviteRequestsApproveArguments extends WebAPICallOptions, TokenOverridable { invite_request_id: string; team_id: string; } export interface AdminInviteRequestsApprovedListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { team_id: string; } export interface AdminInviteRequestsDenyArguments extends WebAPICallOptions, TokenOverridable { invite_request_id: string; team_id: string; } export interface AdminInviteRequestsDeniedListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { team_id: string; } export interface AdminInviteRequestsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { team_id: string; } export interface AdminTeamsAdminsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { team_id: string; } export interface AdminTeamsCreateArguments extends WebAPICallOptions, TokenOverridable { team_domain: string; team_name: string; team_description?: string; team_discoverability?: string; } export interface AdminTeamsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { } export interface AdminTeamsOwnersListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { team_id: string; } export interface AdminTeamsSettingsInfoArguments extends WebAPICallOptions, TokenOverridable { team_id: string; } export interface AdminTeamsSettingsSetDefaultChannelsArguments extends WebAPICallOptions, TokenOverridable { team_id: string; channel_ids: string[]; } export interface AdminTeamsSettingsSetDescriptionArguments extends WebAPICallOptions, TokenOverridable { team_id: string; description: string; } export interface AdminTeamsSettingsSetDiscoverabilityArguments extends WebAPICallOptions, TokenOverridable { team_id: string; discoverability: 'open' | 'invite_only' | 'closed' | 'unlisted'; } export interface AdminTeamsSettingsSetIconArguments extends WebAPICallOptions, TokenOverridable { team_id: string; image_url: string; } export interface AdminTeamsSettingsSetNameArguments extends WebAPICallOptions, TokenOverridable { team_id: string; name: string; } export interface AdminUsergroupsAddChannelsArguments extends WebAPICallOptions, TokenOverridable { usergroup_id: string; team_id?: string; channel_ids: string | string[]; } export interface AdminUsergroupsAddTeamsArguments extends WebAPICallOptions, TokenOverridable { usergroup_id: string; team_ids: string | string[]; auto_provision?: boolean; } export interface AdminUsergroupsListChannelsArguments extends WebAPICallOptions, TokenOverridable { usergroup_id: string; include_num_members?: boolean; team_id?: string; } export interface AdminUsergroupsRemoveChannelsArguments extends WebAPICallOptions, TokenOverridable { usergroup_id: string; channel_ids: string | string[]; } export interface AdminUsersAssignArguments extends WebAPICallOptions, TokenOverridable { team_id: string; user_id: string; is_restricted?: boolean; is_ultra_restricted?: boolean; } export interface AdminUsersInviteArguments extends WebAPICallOptions, TokenOverridable { channel_ids: string; email: string; team_id: string; custom_message?: string; email_password_policy_enabled?: boolean; guest_expiration_ts?: string; is_restricted?: boolean; is_ultra_restricted?: boolean; real_name?: string; resend?: boolean; } export interface AdminUsersListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { team_id: string; } export interface AdminUsersRemoveArguments extends WebAPICallOptions, TokenOverridable { team_id: string; user_id: string; } export interface AdminUsersSetAdminArguments extends WebAPICallOptions, TokenOverridable { team_id: string; user_id: string; } export interface AdminUsersSetExpirationArguments extends WebAPICallOptions, TokenOverridable { team_id: string; user_id: string; expiration_ts: number; } export interface AdminUsersSetOwnerArguments extends WebAPICallOptions, TokenOverridable { team_id: string; user_id: string; } export interface AdminUsersSetRegularArguments extends WebAPICallOptions, TokenOverridable { team_id: string; user_id: string; } export interface AdminUsersSessionListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { user_id?: string; team_id?: string; } export interface AdminUsersSessionResetArguments extends WebAPICallOptions, TokenOverridable { user_id: string; mobile_only?: boolean; web_only?: boolean; } export interface AdminUsersSessionResetBulkArguments extends WebAPICallOptions, TokenOverridable { user_ids: string[]; mobile_only?: boolean; web_only?: boolean; } export interface AdminUsersSessionInvalidateArguments extends WebAPICallOptions, TokenOverridable { session_id: string; team_id: string; } export interface AdminUsersSessionGetSettingsArguments extends WebAPICallOptions, TokenOverridable { user_ids: string[]; } export interface AdminUsersSessionSetSettingsArguments extends WebAPICallOptions, TokenOverridable { user_ids: string[]; desktop_app_browser_quit?: boolean; duration?: number; } export interface AdminUsersSessionClearSettingsArguments extends WebAPICallOptions, TokenOverridable { user_ids: string[]; } export interface AdminUsersUnsupportedVersionsExportArguments extends WebAPICallOptions, TokenOverridable { date_end_of_support?: number; date_sessions_started?: number; } export interface APITestArguments extends WebAPICallOptions { } export interface AppsConnectionsOpenArguments extends WebAPICallOptions { } export interface AppsEventAuthorizationsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { event_context: string; } export interface AppsUninstallArguments extends WebAPICallOptions { client_id: string; client_secret: string; } export interface AuthRevokeArguments extends WebAPICallOptions, TokenOverridable { test?: boolean; } export interface AuthTeamsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { include_icon?: boolean; } export interface AuthTestArguments extends WebAPICallOptions, TokenOverridable { } export interface BotsInfoArguments extends WebAPICallOptions, TokenOverridable { bot?: string; team_id?: string; } export interface BookmarksAddArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; title: string; type: string; emoji?: string; entity_id?: string; link?: string; parent_id?: string; } export interface BookmarksEditArguments extends WebAPICallOptions, TokenOverridable { bookmark_id: string; channel_id: string; emoji?: string; link?: string; title?: string; } export interface BookmarksListArguments extends WebAPICallOptions, TokenOverridable { channel_id: string; } export interface BookmarksRemoveArguments extends WebAPICallOptions, TokenOverridable { bookmark_id: string; channel_id: string; } export interface CallsAddArguments extends WebAPICallOptions, TokenOverridable { external_unique_id: string; join_url: string; created_by?: string; date_start?: number; desktop_app_join_url?: string; external_display_id?: string; title?: string; users?: CallUser[]; } export interface CallsEndArguments extends WebAPICallOptions, TokenOverridable { id: string; duration?: number; } export interface CallsInfoArguments extends WebAPICallOptions, TokenOverridable { id: string; } export interface CallsUpdateArguments extends WebAPICallOptions, TokenOverridable { id: string; join_url?: string; desktop_app_join_url?: string; title?: string; } export interface CallsParticipantsAddArguments extends WebAPICallOptions, TokenOverridable { id: string; users: CallUser[]; } export interface CallsParticipantsRemoveArguments extends WebAPICallOptions, TokenOverridable { id: string; users: CallUser[]; } export interface ChannelsArchiveArguments extends WebAPICallOptions, TokenOverridable { channel: string; } export interface ChannelsCreateArguments extends WebAPICallOptions, TokenOverridable { name: string; validate?: boolean; team_id?: string; } export interface ChannelsHistoryArguments extends WebAPICallOptions, TokenOverridable, TimelinePaginationEnabled { channel: string; count?: number; unreads?: boolean; } export interface ChannelsInfoArguments extends WebAPICallOptions, TokenOverridable, LocaleAware { channel: string; } export interface ChannelsInviteArguments extends WebAPICallOptions, TokenOverridable { channel: string; user: string; } export interface ChannelsJoinArguments extends WebAPICallOptions, TokenOverridable { name: string; validate?: boolean; } export interface ChannelsKickArguments extends WebAPICallOptions, TokenOverridable { channel: string; user: string; } export interface ChannelsLeaveArguments extends WebAPICallOptions, TokenOverridable { channel: string; } export interface ChannelsListArguments extends WebAPICallOptions, TokenOverridable, CursorPaginationEnabled { exclude_archived?: boolean; exclude_members?: boolean; team_id?: string; } export interface ChannelsMarkArguments extends WebAPICallOptions, TokenOverridable { channel: string; ts: string; } export interface ChannelsRenameArguments extends WebAPICallOptions, TokenOverridable { channel: string; name: string; validate?: boolean; } export interface ChannelsRepliesArguments extends WebAPICallOptions, TokenOverridable { channel: string; thread_ts: string; } export interface ChannelsSetPurposeArguments extends WebAPICallOptions, TokenOverridable { channel: string; purpose: string; } export interface ChannelsSetTopicArguments extends WebAPICallOptions, TokenOverridable { channel: string; topic: string; } export interface ChannelsUnarchiveArguments extends WebAPICallOptions, TokenOverridable { channel: string; } export interface ChatDeleteArguments extends WebAPICallOptions, TokenOverridable { channel: string; ts: string; as_user?: boolean; } export interface ChatDeleteScheduledMessageArguments extends WebAPICallOptions, TokenOverridable { channel: string; scheduled_message_id: string; as_user?: boolean; } export interface ChatGetPermalinkArguments extends WebAPICallOptions, TokenOverridable { channel: string; message_ts: string; } export interface ChatMeMessageArguments extends WebAPICallOptions, TokenOverridable { channel: string; text: string; } export interface ChatPostEphemeralArguments extends WebAPICallOptions, TokenOverridable { channel: string; text?: string; user: string; as_user?: boolean; attachments?: MessageAttachment[]; blocks?: (KnownBlock | Block)[]; link_names?: boolean; parse?: 'full' | 'none'; thread_ts?: string; icon_emoji?: string; icon_url?: string; username?: string; } export interface ChatPostMessageArguments extends W