@slack/web-api

@slack/web-api

Version 7.8.0
Published 26 days ago
2.58 MB
12 dependencies
MIT license

Install

npm i @slack/web-api

yarn add @slack/web-api

pnpm add @slack/web-api

Overview

Official library for using the Slack Platform's Web API

Index

Variables

variable retryPolicies

const retryPolicies: {
    tenRetriesInAboutThirtyMinutes: RetryOptions;
    fiveRetriesInFiveMinutes: RetryOptions;
    rapidRetryPolicy: RetryOptions;
};

Functions

function addAppMetadata

addAppMetadata: ({ name, version }: { name: string; version: string }) => void;

Appends the app metadata into the User-Agent value
Parameter
appMetadata.name - name of tool to be counted in instrumentation
Parameter
appMetadata.version - version of tool to be counted in instrumentation

Classes

class Methods

abstract class Methods extends EventEmitter<WebClientEvent> {}

A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the apiCall class method.

constructor

protected constructor();

property admin

readonly admin: {
    analytics: {
        getFile: MethodWithRequiredArgument<
            AdminAnalyticsGetFileArguments,
            AdminAnalyticsGetFileResponse
        >;
    };
    apps: {
        activities: {
            list: MethodWithOptionalArgument<
                AdminAppsActivitiesListArguments,
                AdminAppsActivitiesListResponse
            >;
        };
        approve: MethodWithRequiredArgument<
            AdminAppsApproveArguments,
            AdminAppsApproveResponse
        >;
        approved: {
            list: MethodWithRequiredArgument<
                AdminAppsApprovedListArguments,
                AdminAppsApprovedListResponse
            >;
        };
        clearResolution: MethodWithRequiredArgument<
            AdminAppsClearResolutionArguments,
            AdminAppsClearResolutionResponse
        >;
        config: {
            lookup: MethodWithRequiredArgument<
                AdminAppsConfigLookupArguments,
                AdminAppsConfigLookupResponse
            >;
            set: MethodWithRequiredArgument<
                AdminAppsConfigSetArguments,
                AdminAppsConfigSetResponse
            >;
        };
        requests: {
            cancel: MethodWithRequiredArgument<
                AdminAppsRequestsCancelArguments,
                AdminAppsRequestsCancelResponse
            >;
            list: MethodWithRequiredArgument<
                AdminAppsRequestsListArguments,
                AdminAppsRequestsListResponse
            >;
        };
        restrict: MethodWithRequiredArgument<
            AdminAppsRestrictArguments,
            AdminAppsRestrictResponse
        >;
        restricted: {
            list: MethodWithRequiredArgument<
                AdminAppsRestrictedListArguments,
                AdminAppsRestrictedListResponse
            >;
        };
        uninstall: MethodWithRequiredArgument<
            AdminAppsUninstallArguments,
            AdminAppsUninstallResponse
        >;
    };
    auth: {
        policy: {
            assignEntities: MethodWithRequiredArgument<
                AdminAuthPolicyAssignEntitiesArguments,
                AdminAuthPolicyAssignEntitiesResponse
            >;
            getEntities: MethodWithRequiredArgument<
                AdminAuthPolicyGetEntitiesArguments,
                AdminAuthPolicyGetEntitiesResponse
            >;
            removeEntities: MethodWithRequiredArgument<
                AdminAuthPolicyRemoveEntitiesArguments,
                AdminAuthPolicyRemoveEntitiesResponse
            >;
        };
    };
    barriers: {
        create: MethodWithRequiredArgument<
            AdminBarriersCreateArguments,
            AdminBarriersCreateResponse
        >;
        delete: MethodWithRequiredArgument<
            AdminBarriersDeleteArguments,
            AdminBarriersDeleteResponse
        >;
        list: MethodWithOptionalArgument<
            AdminBarriersListArguments,
            AdminBarriersListResponse
        >;
        update: MethodWithRequiredArgument<
            AdminBarriersUpdateArguments,
            AdminBarriersUpdateResponse
        >;
    };
    conversations: {
        archive: MethodWithRequiredArgument<
            AdminConversationsArchiveArguments,
            AdminConversationsArchiveResponse
        >;
        bulkArchive: MethodWithRequiredArgument<
            AdminConversationsBulkArchiveArguments,
            AdminConversationsBulkArchiveResponse
        >;
        bulkDelete: MethodWithRequiredArgument<
            AdminConversationsBulkDeleteArguments,
            AdminConversationsBulkDeleteResponse
        >;
        bulkMove: MethodWithRequiredArgument<
            AdminConversationsBulkMoveArguments,
            AdminConversationsBulkMoveResponse
        >;
        convertToPrivate: MethodWithRequiredArgument<
            AdminConversationsConvertToPrivateArguments,
            AdminConversationsConvertToPrivateResponse
        >;
        convertToPublic: MethodWithRequiredArgument<
            AdminConversationsConvertToPublicArguments,
            AdminConversationsConvertToPublicResponse
        >;
        create: MethodWithRequiredArgument<
            AdminConversationsCreateArguments,
            AdminConversationsCreateResponse
        >;
        delete: MethodWithRequiredArgument<
            AdminConversationsDeleteArguments,
            AdminConversationsDeleteResponse
        >;
        disconnectShared: MethodWithRequiredArgument<
            AdminConversationsDisconnectSharedArguments,
            AdminConversationsDisconnectSharedResponse
        >;
        ekm: {
            listOriginalConnectedChannelInfo: MethodWithOptionalArgument<
                AdminConversationsEKMListOriginalConnectedChannelInfoArguments,
                AdminConversationsEkmListOriginalConnectedChannelInfoResponse
            >;
        };
        getConversationPrefs: MethodWithRequiredArgument<
            AdminConversationsGetConversationPrefsArguments,
            AdminConversationsGetConversationPrefsResponse
        >;
        getCustomRetention: MethodWithRequiredArgument<
            AdminConversationsGetCustomRetentionArguments,
            AdminConversationsGetCustomRetentionResponse
        >;
        getTeams: MethodWithRequiredArgument<
            AdminConversationsGetTeamsArguments,
            AdminConversationsGetTeamsResponse
        >;
        invite: MethodWithRequiredArgument<
            AdminConversationsInviteArguments,
            AdminConversationsInviteResponse
        >;
        lookup: MethodWithRequiredArgument<
            AdminConversationsLookupArguments,
            AdminConversationsLookupResponse
        >;
        removeCustomRetention: MethodWithRequiredArgument<
            AdminConversationsRemoveCustomRetentionArguments,
            AdminConversationsRemoveCustomRetentionResponse
        >;
        rename: MethodWithRequiredArgument<
            AdminConversationsRenameArguments,
            AdminConversationsRenameResponse
        >;
        restrictAccess: {
            addGroup: MethodWithRequiredArgument<
                AdminConversationsRestrictAccessAddGroupArguments,
                AdminConversationsRestrictAccessAddGroupResponse
            >;
            listGroups: MethodWithRequiredArgument<
                AdminConversationsRestrictAccessListGroupsArguments,
                AdminConversationsRestrictAccessListGroupsResponse
            >;
            removeGroup: MethodWithRequiredArgument<
                AdminConversationsRestrictAccessRemoveGroupArguments,
                AdminConversationsRestrictAccessRemoveGroupResponse
            >;
        };
        search: MethodWithOptionalArgument<
            AdminConversationsSearchArguments,
            AdminConversationsSearchResponse
        >;
        setConversationPrefs: MethodWithRequiredArgument<
            AdminConversationsSetConversationPrefsArguments,
            AdminConversationsSetConversationPrefsResponse
        >;
        setCustomRetention: MethodWithRequiredArgument<
            AdminConversationsSetCustomRetentionArguments,
            AdminConversationsSetCustomRetentionResponse
        >;
        setTeams: MethodWithRequiredArgument<
            AdminConversationsSetTeamsArguments,
            AdminConversationsSetTeamsResponse
        >;
        unarchive: MethodWithRequiredArgument<
            AdminConversationsUnarchiveArguments,
            AdminConversationsUnarchiveResponse
        >;
    };
    emoji: {
        add: MethodWithRequiredArgument<
            AdminEmojiAddArguments,
            AdminEmojiAddResponse
        >;
        addAlias: MethodWithRequiredArgument<
            AdminEmojiAddAliasArguments,
            AdminEmojiAddAliasResponse
        >;
        list: MethodWithOptionalArgument<
            AdminEmojiListArguments,
            AdminEmojiListResponse
        >;
        remove: MethodWithRequiredArgument<
            AdminEmojiRemoveArguments,
            AdminEmojiRemoveResponse
        >;
        rename: MethodWithRequiredArgument<
            AdminEmojiRenameArguments,
            AdminEmojiRenameResponse
        >;
    };
    functions: {
        list: MethodWithRequiredArgument<
            AdminFunctionsListArguments,
            AdminFunctionsListResponse
        >;
        permissions: {
            lookup: MethodWithRequiredArgument<
                AdminFunctionsPermissionsLookupArguments,
                AdminFunctionsPermissionsLookupResponse
            >;
            set: MethodWithRequiredArgument<
                AdminFunctionsPermissionsSetArguments,
                AdminFunctionsPermissionsSetResponse
            >;
        };
    };
    inviteRequests: {
        approve: MethodWithRequiredArgument<
            AdminInviteRequestsApproveArguments,
            AdminInviteRequestsApproveResponse
        >;
        approved: {
            list: MethodWithRequiredArgument<
                AdminInviteRequestsApprovedListArguments,
                AdminInviteRequestsApprovedListResponse
            >;
        };
        denied: {
            list: MethodWithRequiredArgument<
                AdminInviteRequestsDeniedListArguments,
                AdminInviteRequestsDeniedListResponse
            >;
        };
        deny: MethodWithRequiredArgument<
            AdminInviteRequestsDenyArguments,
            AdminInviteRequestsDenyResponse
        >;
        list: MethodWithRequiredArgument<
            AdminInviteRequestsListArguments,
            AdminInviteRequestsListResponse
        >;
    };
    roles: {
        addAssignments: MethodWithRequiredArgument<
            AdminRolesAddAssignmentsArguments,
            AdminRolesAddAssignmentsResponse
        >;
        listAssignments: MethodWithOptionalArgument<
            AdminRolesListAssignmentsArguments,
            AdminRolesListAssignmentsResponse
        >;
        removeAssignments: MethodWithRequiredArgument<
            AdminRolesRemoveAssignmentsArguments,
            AdminRolesRemoveAssignmentsResponse
        >;
    };
    teams: {
        admins: {
            list: MethodWithRequiredArgument<
                AdminTeamsAdminsListArguments,
                AdminTeamsAdminsListResponse
            >;
        };
        create: MethodWithRequiredArgument<
            AdminTeamsCreateArguments,
            AdminTeamsCreateResponse
        >;
        list: MethodWithOptionalArgument<
            AdminTeamsListArguments,
            AdminTeamsListResponse
        >;
        owners: {
            list: MethodWithRequiredArgument<
                AdminTeamsOwnersListArguments,
                AdminTeamsOwnersListResponse
            >;
        };
        settings: {
            info: MethodWithRequiredArgument<
                AdminTeamsSettingsInfoArguments,
                AdminTeamsSettingsInfoResponse
            >;
            setDefaultChannels: MethodWithRequiredArgument<
                AdminTeamsSettingsSetDefaultChannelsArguments,
                AdminTeamsSettingsSetDefaultChannelsResponse
            >;
            setDescription: MethodWithRequiredArgument<
                AdminTeamsSettingsSetDescriptionArguments,
                AdminTeamsSettingsSetDescriptionResponse
            >;
            setDiscoverability: MethodWithRequiredArgument<
                AdminTeamsSettingsSetDiscoverabilityArguments,
                AdminTeamsSettingsSetDiscoverabilityResponse
            >;
            setIcon: MethodWithRequiredArgument<
                AdminTeamsSettingsSetIconArguments,
                AdminTeamsSettingsSetIconResponse
            >;
            setName: MethodWithRequiredArgument<
                AdminTeamsSettingsSetNameArguments,
                AdminTeamsSettingsSetNameResponse
            >;
        };
    };
    usergroups: {
        addChannels: MethodWithRequiredArgument<
            AdminUsergroupsAddChannelsArguments,
            AdminUsergroupsAddChannelsResponse
        >;
        addTeams: MethodWithRequiredArgument<
            AdminUsergroupsAddTeamsArguments,
            AdminUsergroupsAddTeamsResponse
        >;
        listChannels: MethodWithRequiredArgument<
            AdminUsergroupsListChannelsArguments,
            AdminUsergroupsListChannelsResponse
        >;
        removeChannels: MethodWithRequiredArgument<
            AdminUsergroupsRemoveChannelsArguments,
            AdminUsergroupsRemoveChannelsResponse
        >;
    };
    users: {
        assign: MethodWithRequiredArgument<
            AdminUsersAssignArguments,
            AdminUsersAssignResponse
        >;
        invite: MethodWithRequiredArgument<
            AdminUsersInviteArguments,
            AdminUsersInviteResponse
        >;
        list: MethodWithOptionalArgument<
            AdminUsersListArguments,
            AdminUsersListResponse
        >;
        remove: MethodWithRequiredArgument<
            AdminUsersRemoveArguments,
            AdminUsersRemoveResponse
        >;
        session: {
            clearSettings: MethodWithRequiredArgument<
                AdminUsersSessionClearSettingsArguments,
                AdminUsersSessionClearSettingsResponse
            >;
            getSettings: MethodWithRequiredArgument<
                AdminUsersSessionGetSettingsArguments,
                AdminUsersSessionGetSettingsResponse
            >;
            invalidate: MethodWithRequiredArgument<
                AdminUsersSessionInvalidateArguments,
                AdminUsersSessionInvalidateResponse
            >;
            list: MethodWithOptionalArgument<
                AdminUsersSessionListArguments,
                AdminUsersSessionListResponse
            >;
            reset: MethodWithRequiredArgument<
                AdminUsersSessionResetArguments,
                AdminUsersSessionResetResponse
            >;
            resetBulk: MethodWithRequiredArgument<
                AdminUsersSessionResetBulkArguments,
                AdminUsersSessionResetBulkResponse
            >;
            setSettings: MethodWithRequiredArgument<
                AdminUsersSessionSetSettingsArguments,
                AdminUsersSessionSetSettingsResponse
            >;
        };
        setAdmin: MethodWithRequiredArgument<
            AdminUsersSetAdminArguments,
            AdminUsersSetAdminResponse
        >;
        setExpiration: MethodWithRequiredArgument<
            AdminUsersSetExpirationArguments,
            AdminUsersSetExpirationResponse
        >;
        setOwner: MethodWithRequiredArgument<
            AdminUsersSetOwnerArguments,
            AdminUsersSetOwnerResponse
        >;
        setRegular: MethodWithRequiredArgument<
            AdminUsersSetRegularArguments,
            AdminUsersSetRegularResponse
        >;
        unsupportedVersions: {
            export: MethodWithRequiredArgument<
                AdminUsersUnsupportedVersionsExportArguments,
                AdminUsersUnsupportedVersionsExportResponse
            >;
        };
    };
    workflows: {
        collaborators: {
            add: MethodWithRequiredArgument<
                AdminWorkflowsCollaboratorsAddArguments,
                AdminWorkflowsCollaboratorsAddResponse
            >;
            remove: MethodWithRequiredArgument<
                AdminWorkflowsCollaboratorsRemoveArguments,
                AdminWorkflowsCollaboratorsRemoveResponse
            >;
        };
        permissions: {
            lookup: MethodWithRequiredArgument<
                AdminWorkflowsPermissionsLookupArguments,
                AdminWorkflowsPermissionsLookupResponse
            >;
        };
        search: MethodWithOptionalArgument<
            AdminWorkflowsSearchArguments,
            AdminWorkflowsSearchResponse
        >;
        unpublish: MethodWithRequiredArgument<
            AdminWorkflowsUnpublishArguments,
            AdminWorkflowsUnpublishResponse
        >;
    };
};

property api

readonly api: {
    test: MethodWithOptionalArgument<APITestArguments, ApiTestResponse>;
};

property apps

readonly apps: {
    connections: {
        open: MethodWithOptionalArgument<
            AppsConnectionsOpenArguments,
            AppsConnectionsOpenResponse
        >;
    };
    event: {
        authorizations: {
            list: MethodWithRequiredArgument<
                AppsEventAuthorizationsListArguments,
                AppsEventAuthorizationsListResponse
            >;
        };
    };
    manifest: {
        create: MethodWithRequiredArgument<
            AppsManifestCreateArguments,
            AppsManifestCreateResponse
        >;
        delete: MethodWithRequiredArgument<
            AppsManifestDeleteArguments,
            AppsManifestDeleteResponse
        >;
        export: MethodWithRequiredArgument<
            AppsManifestExportArguments,
            AppsManifestExportResponse
        >;
        update: MethodWithRequiredArgument<
            AppsManifestUpdateArguments,
            AppsManifestUpdateResponse
        >;
        validate: MethodWithRequiredArgument<
            AppsManifestValidateArguments,
            AppsManifestValidateResponse
        >;
    };
    uninstall: MethodWithRequiredArgument<
        AppsUninstallArguments,
        AppsUninstallResponse
    >;
};

property assistant

readonly assistant: {
    threads: {
        setStatus: MethodWithRequiredArgument<
            AssistantThreadsSetStatusArguments,
            AssistantThreadsSetStatusResponse
        >;
        setSuggestedPrompts: MethodWithRequiredArgument<
            AssistantThreadsSetSuggestedPromptsArguments,
            AssistantThreadsSetSuggestedPromptsResponse
        >;
        setTitle: MethodWithRequiredArgument<
            AssistantThreadsSetTitleArguments,
            AssistantThreadsSetTitleResponse
        >;
    };
};

property auth

readonly auth: {
    revoke: MethodWithOptionalArgument<AuthRevokeArguments, AuthRevokeResponse>;
    teams: {
        list: MethodWithOptionalArgument<
            AuthTeamsListArguments,
            AuthTeamsListResponse
        >;
    };
    test: MethodWithOptionalArgument<AuthTestArguments, AuthTestResponse>;
};

property bookmarks

readonly bookmarks: {
    add: MethodWithRequiredArgument<BookmarksAddArguments, BookmarksAddResponse>;
    edit: MethodWithRequiredArgument<
        BookmarksEditArguments,
        BookmarksEditResponse
    >;
    list: MethodWithRequiredArgument<
        BookmarksListArguments,
        BookmarksListResponse
    >;
    remove: MethodWithRequiredArgument<
        BookmarksRemoveArguments,
        BookmarksRemoveResponse
    >;
};

property bots

readonly bots: {
    info: MethodWithOptionalArgument<BotsInfoArguments, BotsInfoResponse>;
};

property calls

readonly calls: {
    add: MethodWithRequiredArgument<CallsAddArguments, CallsAddResponse>;
    end: MethodWithRequiredArgument<CallsEndArguments, CallsEndResponse>;
    info: MethodWithRequiredArgument<CallsInfoArguments, CallsInfoResponse>;
    update: MethodWithRequiredArgument<
        CallsUpdateArguments,
        CallsUpdateResponse
    >;
    participants: {
        add: MethodWithRequiredArgument<
            CallsParticipantsAddArguments,
            CallsParticipantsAddResponse
        >;
        remove: MethodWithRequiredArgument<
            CallsParticipantsRemoveArguments,
            CallsParticipantsRemoveResponse
        >;
    };
};

property canvases

readonly canvases: {
    access: {
        delete: MethodWithRequiredArgument<
            CanvasesAccessDeleteArguments,
            CanvasesAccessDeleteResponse
        >;
        set: MethodWithRequiredArgument<
            CanvasesAccessSetArguments,
            CanvasesAccessSetResponse
        >;
    };
    create: MethodWithOptionalArgument<
        CanvasesCreateArguments,
        CanvasesCreateResponse
    >;
    delete: MethodWithRequiredArgument<
        CanvasesDeleteArguments,
        CanvasesDeleteResponse
    >;
    edit: MethodWithRequiredArgument<
        CanvasesEditArguments,
        CanvasesEditResponse
    >;
    sections: {
        lookup: MethodWithRequiredArgument<
            CanvasesSectionsLookupArguments,
            CanvasesSectionsLookupResponse
        >;
    };
};

property chat

readonly chat: {
    delete: MethodWithRequiredArgument<ChatDeleteArguments, ChatDeleteResponse>;
    deleteScheduledMessage: MethodWithRequiredArgument<
        ChatDeleteScheduledMessageArguments,
        ChatDeleteScheduledMessageResponse
    >;
    getPermalink: MethodWithRequiredArgument<
        ChatGetPermalinkArguments,
        ChatGetPermalinkResponse
    >;
    meMessage: MethodWithRequiredArgument<
        ChatMeMessageArguments,
        ChatMeMessageResponse
    >;
    postEphemeral: MethodWithRequiredArgument<
        ChatPostEphemeralArguments,
        ChatPostEphemeralResponse
    >;
    postMessage: MethodWithRequiredArgument<
        ChatPostMessageArguments,
        ChatPostMessageResponse
    >;
    scheduleMessage: MethodWithRequiredArgument<
        ChatScheduleMessageArguments,
        ChatScheduleMessageResponse
    >;
    scheduledMessages: {
        list: MethodWithOptionalArgument<
            ChatScheduledMessagesListArguments,
            ChatScheduledMessagesListResponse
        >;
    };
    unfurl: MethodWithRequiredArgument<ChatUnfurlArguments, ChatUnfurlResponse>;
    update: MethodWithRequiredArgument<ChatUpdateArguments, ChatUpdateResponse>;
};

property conversations

readonly conversations: {
    acceptSharedInvite: MethodWithRequiredArgument<
        ConversationsAcceptSharedInviteArguments,
        ConversationsAcceptSharedInviteResponse
    >;
    approveSharedInvite: MethodWithRequiredArgument<
        ConversationsApproveSharedInviteArguments,
        ConversationsApproveSharedInviteResponse
    >;
    archive: MethodWithRequiredArgument<
        ConversationsArchiveArguments,
        ConversationsArchiveResponse
    >;
    canvases: {
        create: MethodWithRequiredArgument<
            ConversationsCanvasesCreateArguments,
            ConversationsCanvasesCreateResponse
        >;
    };
    close: MethodWithRequiredArgument<
        ConversationsCloseArguments,
        ConversationsCloseResponse
    >;
    create: MethodWithRequiredArgument<
        ConversationsCreateArguments,
        ConversationsCreateResponse
    >;
    declineSharedInvite: MethodWithRequiredArgument<
        ConversationsDeclineSharedInviteArguments,
        ConversationsDeclineSharedInviteResponse
    >;
    externalInvitePermissions: {
        set: MethodWithRequiredArgument<
            ConversationsExternalInvitePermissionsSetArguments,
            ConversationsExternalInvitePermissionsSetResponse
        >;
    };
    history: MethodWithRequiredArgument<
        ConversationsHistoryArguments,
        ConversationsHistoryResponse
    >;
    info: MethodWithRequiredArgument<
        ConversationsInfoArguments,
        ConversationsInfoResponse
    >;
    invite: MethodWithRequiredArgument<
        ConversationsInviteArguments,
        ConversationsInviteResponse
    >;
    inviteShared: MethodWithRequiredArgument<
        ConversationsInviteSharedArguments,
        ConversationsInviteSharedResponse
    >;
    join: MethodWithRequiredArgument<
        ConversationsJoinArguments,
        ConversationsJoinResponse
    >;
    kick: MethodWithRequiredArgument<
        ConversationsKickArguments,
        ConversationsKickResponse
    >;
    leave: MethodWithRequiredArgument<
        ConversationsLeaveArguments,
        ConversationsLeaveResponse
    >;
    list: MethodWithOptionalArgument<
        ConversationsListArguments,
        ConversationsListResponse
    >;
    listConnectInvites: MethodWithOptionalArgument<
        ConversationsListConnectInvitesArguments,
        ConversationsListConnectInvitesResponse
    >;
    mark: MethodWithRequiredArgument<
        ConversationsMarkArguments,
        ConversationsMarkResponse
    >;
    members: MethodWithRequiredArgument<
        ConversationsMembersArguments,
        ConversationsMembersResponse
    >;
    open: MethodWithRequiredArgument<
        ConversationsOpenArguments,
        ConversationsOpenResponse
    >;
    rename: MethodWithRequiredArgument<
        ConversationsRenameArguments,
        ConversationsRenameResponse
    >;
    replies: MethodWithRequiredArgument<
        ConversationsRepliesArguments,
        ConversationsRepliesResponse
    >;
    requestSharedInvite: {
        approve: MethodWithRequiredArgument<
            ConversationsRequestSharedInviteApproveArguments,
            ConversationsRequestSharedInviteApproveResponse
        >;
        deny: MethodWithRequiredArgument<
            ConversationsRequestSharedInviteDenyArguments,
            ConversationsRequestSharedInviteDenyResponse
        >;
        list: MethodWithOptionalArgument<
            ConversationsRequestSharedInviteListArguments,
            ConversationsRequestSharedInviteListResponse
        >;
    };
    setPurpose: MethodWithRequiredArgument<
        ConversationsSetPurposeArguments,
        ConversationsSetPurposeResponse
    >;
    setTopic: MethodWithRequiredArgument<
        ConversationsSetTopicArguments,
        ConversationsSetTopicResponse
    >;
    unarchive: MethodWithRequiredArgument<
        ConversationsUnarchiveArguments,
        ConversationsUnarchiveResponse
    >;
};

property dialog

readonly dialog: {
    open: MethodWithRequiredArgument<DialogOpenArguments, DialogOpenResponse>;
};

property dnd

readonly dnd: {
    endDnd: MethodWithOptionalArgument<DndEndDndArguments, DndEndDndResponse>;
    endSnooze: MethodWithOptionalArgument<
        DndEndSnoozeArguments,
        DndEndSnoozeResponse
    >;
    info: MethodWithOptionalArgument<DndInfoArguments, DndInfoResponse>;
    setSnooze: MethodWithRequiredArgument<
        DndSetSnoozeArguments,
        DndSetSnoozeResponse
    >;
    teamInfo: MethodWithRequiredArgument<
        DndTeamInfoArguments,
        DndTeamInfoResponse
    >;
};

property emoji

readonly emoji: {
    list: MethodWithOptionalArgument<EmojiListArguments, EmojiListResponse>;
};

property files

readonly files: {
    completeUploadExternal: MethodWithRequiredArgument<
        FilesCompleteUploadExternalArguments,
        FilesCompleteUploadExternalResponse
    >;
    delete: MethodWithRequiredArgument<
        FilesDeleteArguments,
        FilesDeleteResponse
    >;
    getUploadURLExternal: MethodWithRequiredArgument<
        FilesGetUploadURLExternalArguments,
        FilesGetUploadURLExternalResponse
    >;
    info: MethodWithRequiredArgument<FilesInfoArguments, FilesInfoResponse>;
    list: MethodWithRequiredArgument<FilesListArguments, FilesListResponse>;
    revokePublicURL: MethodWithRequiredArgument<
        FilesRevokePublicURLArguments,
        FilesRevokePublicURLResponse
    >;
    sharedPublicURL: MethodWithRequiredArgument<
        FilesSharedPublicURLArguments,
        FilesSharedPublicURLResponse
    >;
    upload: MethodWithRequiredArgument<
        FilesUploadArguments,
        FilesUploadResponse
    >;
    uploadV2: MethodWithRequiredArgument<
        FilesUploadV2Arguments,
        WebAPICallResult
    >;
    comments: {
        delete: MethodWithRequiredArgument<
            FilesCommentsDeleteArguments,
            FilesCommentsDeleteResponse
        >;
    };
    remote: {
        add: MethodWithRequiredArgument<
            FilesRemoteAddArguments,
            FilesRemoteAddResponse
        >;
        info: MethodWithRequiredArgument<
            FilesRemoteInfoArguments,
            FilesRemoteInfoResponse
        >;
        list: MethodWithRequiredArgument<
            FilesRemoteListArguments,
            FilesRemoteListResponse
        >;
        remove: MethodWithRequiredArgument<
            FilesRemoteRemoveArguments,
            FilesRemoteRemoveResponse
        >;
        share: MethodWithRequiredArgument<
            FilesRemoteShareArguments,
            FilesRemoteShareResponse
        >;
        update: MethodWithRequiredArgument<
            FilesRemoteUpdateArguments,
            FilesRemoteUpdateResponse
        >;
    };
};

property functions

readonly functions: {
    completeError: MethodWithRequiredArgument<
        FunctionsCompleteErrorArguments,
        FunctionsCompleteErrorResponse
    >;
    completeSuccess: MethodWithRequiredArgument<
        FunctionsCompleteSuccessArguments,
        FunctionsCompleteSuccessResponse
    >;
};

property migration

readonly migration: {
    exchange: MethodWithRequiredArgument<
        MigrationExchangeArguments,
        MigrationExchangeResponse
    >;
};

property oauth

readonly oauth: {
    access: MethodWithRequiredArgument<
        OAuthAccessArguments,
        OauthAccessResponse
    >;
    v2: {
        access: MethodWithRequiredArgument<
            OAuthV2AccessArguments,
            OauthV2AccessResponse
        >;
        exchange: MethodWithRequiredArgument<
            OAuthV2ExchangeArguments,
            OauthV2ExchangeResponse
        >;
    };
};

property openid

readonly openid: {
    connect: {
        token: MethodWithRequiredArgument<
            OpenIDConnectTokenArguments,
            OpenIDConnectTokenResponse
        >;
        userInfo: MethodWithOptionalArgument<
            OpenIDConnectUserInfoArguments,
            OpenIDConnectUserInfoResponse
        >;
    };
};

property pins

readonly pins: {
    add: MethodWithRequiredArgument<PinsAddArguments, PinsAddResponse>;
    list: MethodWithRequiredArgument<PinsListArguments, PinsListResponse>;
    remove: MethodWithRequiredArgument<PinsRemoveArguments, PinsRemoveResponse>;
};

property reactions

readonly reactions: {
    add: MethodWithRequiredArgument<ReactionsAddArguments, ReactionsAddResponse>;
    get: MethodWithRequiredArgument<ReactionsGetArguments, ReactionsGetResponse>;
    list: MethodWithOptionalArgument<
        ReactionsListArguments,
        ReactionsListResponse
    >;
    remove: MethodWithRequiredArgument<
        ReactionsRemoveArguments,
        ReactionsRemoveResponse
    >;
};

property reminders

readonly reminders: {
    add: MethodWithRequiredArgument<RemindersAddArguments, RemindersAddResponse>;
    complete: MethodWithRequiredArgument<
        RemindersCompleteArguments,
        RemindersCompleteResponse
    >;
    delete: MethodWithRequiredArgument<
        RemindersDeleteArguments,
        RemindersDeleteResponse
    >;
    info: MethodWithRequiredArgument<
        RemindersInfoArguments,
        RemindersInfoResponse
    >;
    list: MethodWithOptionalArgument<
        RemindersListArguments,
        RemindersListResponse
    >;
};

property rtm

readonly rtm: {
    connect: MethodWithOptionalArgument<RTMConnectArguments, RtmConnectResponse>;
    start: MethodWithOptionalArgument<RTMStartArguments, RtmStartResponse>;
};

property search

readonly search: {
    all: MethodWithRequiredArgument<SearchAllArguments, SearchAllResponse>;
    files: MethodWithRequiredArgument<SearchFilesArguments, SearchFilesResponse>;
    messages: MethodWithRequiredArgument<
        SearchMessagesArguments,
        SearchMessagesResponse
    >;
};

property stars

readonly stars: {
    add: MethodWithRequiredArgument<StarsAddRemoveArguments, StarsAddResponse>;
    list: MethodWithRequiredArgument<StarsListArguments, StarsListResponse>;
    remove: MethodWithRequiredArgument<
        StarsAddRemoveArguments,
        StarsRemoveResponse
    >;
};

property team

readonly team: {
    accessLogs: MethodWithOptionalArgument<
        TeamAccessLogsArguments,
        TeamAccessLogsResponse
    >;
    billableInfo: MethodWithOptionalArgument<
        TeamBillableInfoArguments,
        TeamBillableInfoResponse
    >;
    billing: {
        info: MethodWithRequiredArgument<
            TeamBillingInfoArguments,
            TeamBillingInfoResponse
        >;
    };
    externalTeams: {
        disconnect: MethodWithRequiredArgument<
            TeamExternalTeamsDisconnectArguments,
            TeamExternalTeamsDisconnectResponse
        >;
        list: MethodWithRequiredArgument<
            TeamExternalTeamsListArguments,
            TeamExternalTeamsListResponse
        >;
    };
    info: MethodWithOptionalArgument<TeamInfoArguments, TeamInfoResponse>;
    integrationLogs: MethodWithOptionalArgument<
        TeamIntegrationLogsArguments,
        TeamIntegrationLogsResponse
    >;
    preferences: {
        list: MethodWithOptionalArgument<
            TeamPreferencesListArguments,
            TeamPreferencesListResponse
        >;
    };
    profile: {
        get: MethodWithOptionalArgument<
            TeamProfileGetArguments,
            TeamProfileGetResponse
        >;
    };
};

property tooling

readonly tooling: {
    tokens: {
        rotate: MethodWithRequiredArgument<
            ToolingTokensRotateArguments,
            ToolingTokensRotateResponse
        >;
    };
};

property usergroups

readonly usergroups: {
    create: MethodWithRequiredArgument<
        UsergroupsCreateArguments,
        UsergroupsCreateResponse
    >;
    disable: MethodWithRequiredArgument<
        UsergroupsDisableArguments,
        UsergroupsDisableResponse
    >;
    enable: MethodWithRequiredArgument<
        UsergroupsEnableArguments,
        UsergroupsEnableResponse
    >;
    list: MethodWithOptionalArgument<
        UsergroupsListArguments,
        UsergroupsListResponse
    >;
    update: MethodWithRequiredArgument<
        UsergroupsUpdateArguments,
        UsergroupsUpdateResponse
    >;
    users: {
        list: MethodWithRequiredArgument<
            UsergroupsUsersListArguments,
            UsergroupsUsersListResponse
        >;
        update: MethodWithRequiredArgument<
            UsergroupsUsersUpdateArguments,
            UsergroupsUsersUpdateResponse
        >;
    };
};

property users

readonly users: {
    conversations: MethodWithRequiredArgument<
        UsersConversationsArguments,
        UsersConversationsResponse
    >;
    deletePhoto: MethodWithRequiredArgument<
        UsersDeletePhotoArguments,
        UsersDeletePhotoResponse
    >;
    discoverableContacts: {
        lookup: MethodWithRequiredArgument<
            UsersDiscoverableContactsLookupArguments,
            UsersDiscoverableContactsLookupResponse
        >;
    };
    getPresence: MethodWithRequiredArgument<
        UsersGetPresenceArguments,
        UsersGetPresenceResponse
    >;
    identity: MethodWithRequiredArgument<
        UsersIdentityArguments,
        UsersIdentityResponse
    >;
    info: MethodWithRequiredArgument<UsersInfoArguments, UsersInfoResponse>;
    list: MethodWithRequiredArgument<UsersListArguments, UsersListResponse>;
    lookupByEmail: MethodWithRequiredArgument<
        UsersLookupByEmailArguments,
        UsersLookupByEmailResponse
    >;
    setPhoto: MethodWithRequiredArgument<
        UsersSetPhotoArguments,
        UsersSetPhotoResponse
    >;
    setPresence: MethodWithRequiredArgument<
        UsersSetPresenceArguments,
        UsersSetPresenceResponse
    >;
    profile: {
        get: MethodWithRequiredArgument<
            UsersProfileGetArguments,
            UsersProfileGetResponse
        >;
        set: MethodWithRequiredArgument<
            UsersProfileSetArguments,
            UsersProfileSetResponse
        >;
    };
};

property views

readonly views: {
    open: MethodWithRequiredArgument<ViewsOpenArguments, ViewsOpenResponse>;
    publish: MethodWithRequiredArgument<
        ViewsPublishArguments,
        ViewsPublishResponse
    >;
    push: MethodWithRequiredArgument<ViewsPushArguments, ViewsPushResponse>;
    update: MethodWithRequiredArgument<
        ViewsUpdateArguments,
        ViewsUpdateResponse
    >;
};

property workflows

readonly workflows: {
    stepCompleted: MethodWithRequiredArgument<
        WorkflowsStepCompletedArguments,
        WorkflowsStepCompletedResponse
    >;
    stepFailed: MethodWithRequiredArgument<
        WorkflowsStepFailedArguments,
        WorkflowsStepFailedResponse
    >;
    updateStep: MethodWithRequiredArgument<
        WorkflowsUpdateStepArguments,
        WorkflowsUpdateStepResponse
    >;
};

method apiCall

abstract apiCall: (
    method: string,
    options?: Record<string, unknown>
) => Promise<WebAPICallResult>;

method filesUploadV2

abstract filesUploadV2: (
    options: FilesUploadV2Arguments
) => Promise<WebAPICallResult>;

class WebClient

class WebClient extends Methods {}

A client for Slack's Web API
This client provides an alias for each Web API method. Each method is a convenience wrapper for calling the WebClient#apiCall method using the method name as the first parameter.

constructor

constructor(
    token?: string,
    {
        slackApiUrl,
        logger,
        logLevel,
        maxRequestConcurrency,
        retryConfig,
        agent,
        tls,
        timeout,
        rejectRateLimitedCalls,
        headers,
        teamId,
        attachOriginalToWebAPIRequestError,
        requestInterceptor,
        adapter,
    }?: WebClientOptions
);

Parameter token
An API token to authenticate/authorize with Slack (usually start with xoxp, xoxb)
Parameter webClientOptions
Configuration options.
Parameter
{Function} [webClientOptions.requestInterceptor] - An interceptor to mutate outgoing requests. See
Parameter
{Function} [webClientOptions.adapter] - An adapter to allow custom handling of requests. Useful if you would like to use a pre-configured http client. See

property slackApiUrl

readonly slackApiUrl: string;

The base URL for reaching Slack's Web API. Consider changing this value for testing purposes.

property token

readonly token?: string;

Authentication and authorization token for accessing Slack Web API (usually begins with xoxp or xoxb)

method apiCall

apiCall: (
    method: string,
    options?: Record<string, unknown>
) => Promise<WebAPICallResult>;

Generic method for calling a Web API method
Parameter method
the Web API method to call https://api.slack.com/methods
Parameter options
options

method filesUploadV2

filesUploadV2: (
    options: FilesUploadV2Arguments
) => Promise<
    WebAPICallResult & { files: FilesCompleteUploadExternalResponse[] }
>;

This wrapper method provides an easy way to upload files using the following endpoints:
**#1**: For each file submitted with this method, submit filenames and file metadata to to request a URL to which to send the file data to and an id for the file
**#2**: for each returned file upload_url, upload corresponding file to URLs returned from step 1 (e.g. https://files.slack.com/upload/v1/...")
**#3**: Complete uploads
Parameter options

method paginate

paginate: {
    (
        method: string,
        options?: Record<string, unknown>
    ): AsyncIterable<WebAPICallResult>;
    (
        method: string,
        options: Record<string, unknown>,
        shouldStop: PaginatePredicate
    ): Promise<void>;
    <R extends PageReducer<any>, A extends PageAccumulator<R>>(
        method: string,
        options: Record<string, unknown>,
        shouldStop: PaginatePredicate,
        reduce?: PageReducer<A>
    ): Promise<A>;
};

Iterate over the result pages of a cursor-paginated Web API method. This method can return two types of values, depending on which arguments are used. When up to two parameters are used, the return value is an async iterator which can be used as the iterable in a for-await-of loop. When three or four parameters are used, the return value is a promise that resolves at the end of iteration. The third parameter, shouldStop, is a function that is called with each page and can end iteration by returning true. The fourth parameter, reduce, is a function that is called with three arguments: accumulator, page, and index. The accumulator is a value of any type you choose, but it will contain undefined when reduce is called for the first time. The page argument and index arguments are exactly what they say they are. The reduce function's return value will be passed in as accumulator the next time its called, and the returned promise will resolve to the last value of accumulator.
The for-await-of syntax is part of ES2018. It is available natively in Node starting with v10.0.0. You may be able to use it in earlier JavaScript runtimes by transpiling your source with a tool like Babel. However, the transpiled code will likely sacrifice performance.
Parameter method
the cursor-paginated Web API method to call https://api.slack.com/docs/pagination
Parameter options
options
Parameter shouldStop
a predicate that is called with each page, and should return true when pagination can end.
Parameter reduce
a callback that can be used to accumulate a value that the return promise is resolved to

Interfaces

interface AdminAnalyticsMemberDetails

interface AdminAnalyticsMemberDetails {}

property channel_messages_posted_count

channel_messages_posted_count: number;

property date

date: string;

property date_claimed

date_claimed: number;

property email_address

email_address: string;

property enterprise_id

enterprise_id: string;

property files_added_count

files_added_count: number;

property is_active

is_active: boolean;

property is_active_android

is_active_android: boolean;

property is_active_apps

is_active_apps: boolean;

property is_active_desktop

is_active_desktop: boolean;

property is_active_ios

is_active_ios: boolean;

property is_active_slack_connect

is_active_slack_connect: boolean;

property is_active_workflows

is_active_workflows: boolean;

property is_billable_seat

is_billable_seat: boolean;

property is_guest

is_guest: boolean;

property messages_posted_count

messages_posted_count: number;

property reactions_added_count

reactions_added_count: number;

property search_count

search_count: number;

property slack_calls_count

slack_calls_count: number;

property slack_huddles_count

slack_huddles_count: number;

property team_id

team_id: string;

property total_calls_count

total_calls_count: number;

property user_id

user_id: string;

interface AdminAnalyticsPublicChannelDetails

interface AdminAnalyticsPublicChannelDetails {}

property channel_id

channel_id: string;

property channel_type

channel_type: string;

property date

date: string;

property date_created

date_created: number;

property date_last_active

date_last_active: number;

property enterprise_id

enterprise_id: string;

property externally_shared_with_organizations

externally_shared_with_organizations: AdminAnalyticsExternallySharedWithOrganizationsDetails[];

property full_members_count

full_members_count: number;

property guest_member_count

guest_member_count: number;

property is_shared_externally

is_shared_externally: boolean;

property members_who_posted_count

members_who_posted_count: number;

property members_who_viewed_count

members_who_viewed_count: number;

property messages_posted_by_members_count

messages_posted_by_members_count: number;

property messages_posted_count

messages_posted_count: number;

property originating_team

originating_team: AdminAnalyticsOriginatingTeamDetails;

property reactions_added_count

reactions_added_count: number;

property shared_with

shared_with: AdminAnalyticsSharedWithDetails[];

property total_members_count

total_members_count: number;

property visibility

visibility: string;

interface AdminAnalyticsPublicChannelMetadataDetails

interface AdminAnalyticsPublicChannelMetadataDetails {}

property channel_id

channel_id: string;

property date

date: string;

property description

description: string;

property name

name: string;

property topic

topic: string;

interface AdminAppsConfigLookupArguments

interface AdminAppsConfigLookupArguments extends TokenOverridable {}

property app_ids

app_ids: string[];

An array of app IDs to get app configs for.

interface AdminAppsConfigSetArguments

interface AdminAppsConfigSetArguments extends AppID, TokenOverridable {}

property domain_restrictions

domain_restrictions?: {
    /** @description Sets allowed URLs for the app. */
    urls?: string[];
    /** @description Sets emails for connector authorization. */
    emails?: string[];
};

Domain restrictions for the app.

property workflow_auth_strategy

workflow_auth_strategy?: 'builder_choice' | 'end_user_only';

The workflow auth permission.

interface AdminAuthPolicyAssignEntitiesArguments

interface AdminAuthPolicyAssignEntitiesArguments
    extends EntityIDs,
        EntityType,
        PolicyName,
        TokenOverridable {}

interface AdminAuthPolicyGetEntitiesArguments

interface AdminAuthPolicyGetEntitiesArguments
    extends Partial<EntityType>,
        PolicyName,
        TokenOverridable,
        CursorPaginationEnabled {}

interface AdminAuthPolicyRemoveEntitiesArguments

interface AdminAuthPolicyRemoveEntitiesArguments
    extends EntityIDs,
        EntityType,
        PolicyName,
        TokenOverridable {}

interface AdminBarriersCreateArguments

interface AdminBarriersCreateArguments extends TokenOverridable {}

property barriered_from_usergroup_ids

barriered_from_usergroup_ids: string[];

A list of IDs ti associate with the barrier.

property primary_usergroup_id

primary_usergroup_id: string;

The ID of the primary .

property restricted_subjects

restricted_subjects: ['im', 'mpim', 'call'];

What kind of interactions are blocked by this barrier? Currently you must provide all three: im, mpim, call.

interface AdminBarriersDeleteArguments

interface AdminBarriersDeleteArguments extends BarrierID, TokenOverridable {}

interface AdminBarriersUpdateArguments

interface AdminBarriersUpdateArguments
    extends AdminBarriersCreateArguments,
        BarrierID {}

interface AdminConversationsArchiveArguments

interface AdminConversationsArchiveArguments extends ChannelID, TokenOverridable {}

interface AdminConversationsBulkArchiveArguments

interface AdminConversationsBulkArchiveArguments
    extends ChannelIDs,
        TokenOverridable {}

interface AdminConversationsBulkDeleteArguments

interface AdminConversationsBulkDeleteArguments
    extends ChannelIDs,
        TokenOverridable {}

interface AdminConversationsBulkMoveArguments

interface AdminConversationsBulkMoveArguments extends ChannelIDs, TokenOverridable {}

property target_team_id

target_team_id: string;

Target team ID to move channels to.

interface AdminConversationsConvertToPrivateArguments

interface AdminConversationsConvertToPrivateArguments
    extends ChannelID,
        TokenOverridable {}

property name

name?: string;

Name of private channel to create. Only respected when converting an MPIM.

interface AdminConversationsConvertToPublicArguments

interface AdminConversationsConvertToPublicArguments
    extends ChannelID,
        TokenOverridable {}

interface AdminConversationsDeleteArguments

interface AdminConversationsDeleteArguments extends ChannelID, TokenOverridable {}

interface AdminConversationsDisconnectSharedArguments

interface AdminConversationsDisconnectSharedArguments
    extends ChannelID,
        TokenOverridable {}

property leaving_team_ids

leaving_team_ids?: string[];

Team IDs getting removed from the channel, optional if there are only two teams in the channel.

interface AdminConversationsGetConversationPrefsArguments

interface AdminConversationsGetConversationPrefsArguments
    extends ChannelID,
        TokenOverridable {}

interface AdminConversationsGetCustomRetentionArguments

interface AdminConversationsGetCustomRetentionArguments
    extends ChannelID,
        TokenOverridable {}

interface AdminConversationsGetTeamsArguments

interface AdminConversationsGetTeamsArguments
    extends ChannelID,
        TokenOverridable,
        CursorPaginationEnabled {}

interface AdminConversationsInviteArguments

interface AdminConversationsInviteArguments
    extends ChannelID,
        UserIDs,
        TokenOverridable {}

interface AdminConversationsLookupArguments

interface AdminConversationsLookupArguments
    extends TeamIDs,
        TokenOverridable,
        CursorPaginationEnabled {}

property last_message_activity_before

last_message_activity_before: number;

UNIX timestamp to filter by public channels where the most recent message was sent before this parameter.

property max_member_count

max_member_count?: number;

Filter by public channels with member count equal to or less than the specified number.

interface AdminConversationsRemoveCustomRetentionArguments

interface AdminConversationsRemoveCustomRetentionArguments
    extends ChannelID,
        TokenOverridable {}

interface AdminConversationsRenameArguments

interface AdminConversationsRenameArguments extends ChannelID, TokenOverridable {}

property name

name: string;

The new name for the channel.

interface AdminConversationsRestrictAccessAddGroupArguments

interface AdminConversationsRestrictAccessAddGroupArguments
    extends ChannelID,
        GroupID,
        RestrictAccessTeamID,
        TokenOverridable {}

interface AdminConversationsRestrictAccessListGroupsArguments

interface AdminConversationsRestrictAccessListGroupsArguments
    extends ChannelID,
        RestrictAccessTeamID,
        TokenOverridable {}

interface AdminConversationsRestrictAccessRemoveGroupArguments

interface AdminConversationsRestrictAccessRemoveGroupArguments
    extends ChannelID,
        GroupID,
        RestrictAccessTeamID,
        TokenOverridable {}

interface AdminConversationsSetConversationPrefsArguments

interface AdminConversationsSetConversationPrefsArguments
    extends ChannelID,
        TokenOverridable {}

property prefs

prefs: Record<string, unknown>;

The prefs for this channel.

interface AdminConversationsSetCustomRetentionArguments

interface AdminConversationsSetCustomRetentionArguments
    extends ChannelID,
        TokenOverridable {}

property duration_days

duration_days: number;

The message retention duration in days to set for this conversation.

interface AdminConversationsSetTeamsArguments

interface AdminConversationsSetTeamsArguments extends ChannelID, TokenOverridable {}

property org_channel

org_channel?: boolean;

Set to true if channel has to be converted to an org channel. Defaults to false.

property target_team_ids

target_team_ids?: string[];

A list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.

property team_id

team_id?: string;

The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.

interface AdminConversationsUnarchiveArguments

interface AdminConversationsUnarchiveArguments extends ChannelID, TokenOverridable {}

interface AdminEmojiAddAliasArguments

interface AdminEmojiAddAliasArguments extends Name, TokenOverridable {}

property alias_for

alias_for: string;

Name of the emoji for which the alias is being made. Any wrapping whitespace or colons will be automatically trimmed.

interface AdminEmojiAddArguments

interface AdminEmojiAddArguments extends Name, TokenOverridable {}

property url

url: string;

The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best.

interface AdminEmojiRemoveArguments

interface AdminEmojiRemoveArguments extends Name, TokenOverridable {}

interface AdminEmojiRenameArguments

interface AdminEmojiRenameArguments extends Name, TokenOverridable {}

property new_name

new_name: string;

The new name of the emoji.

interface AdminFunctionsListArguments

interface AdminFunctionsListArguments
    extends TokenOverridable,
        CursorPaginationEnabled {}

property app_ids

app_ids: string[];

Array of app IDs to get functions for; max 50.

property team_id

team_id?: string;

The team context to retrieve functions from.

interface AdminFunctionsPermissionsLookupArguments

interface AdminFunctionsPermissionsLookupArguments extends TokenOverridable {}

property function_ids

function_ids: [string, ...string[]];

An array of function IDs to get permissions for.

interface AdminFunctionsPermissionsSetArguments

interface AdminFunctionsPermissionsSetArguments
    extends TokenOverridable,
        Partial<UserIDs> {}

property function_id

function_id: string;

The function ID to set permissions for.

property visibility

visibility: 'everyone' | 'app_collaborators' | 'named_entities' | 'no_one';

The function visibility.

interface AdminInviteRequestsApproveArguments

interface AdminInviteRequestsApproveArguments
    extends InviteRequestID,
        Required<OptionalTeamAssignable>,
        TokenOverridable {}

interface AdminInviteRequestsApprovedListArguments

interface AdminInviteRequestsApprovedListArguments
    extends Required<OptionalTeamAssignable>,
        TokenOverridable,
        CursorPaginationEnabled {}

interface AdminInviteRequestsDeniedListArguments

interface AdminInviteRequestsDeniedListArguments
    extends Required<OptionalTeamAssignable>,
        TokenOverridable,
        CursorPaginationEnabled {}

interface AdminInviteRequestsDenyArguments

interface AdminInviteRequestsDenyArguments
    extends InviteRequestID,
        Required<OptionalTeamAssignable>,
        TokenOverridable {}

interface AdminInviteRequestsListArguments

interface AdminInviteRequestsListArguments
    extends Required<OptionalTeamAssignable>,
        TokenOverridable,
        CursorPaginationEnabled {}

interface AdminRolesAddAssignmentsArguments

interface AdminRolesAddAssignmentsArguments
    extends EntityIDs,
        RoleID,
        UserIDs,
        TokenOverridable {}

interface AdminRolesRemoveAssignmentsArguments

interface AdminRolesRemoveAssignmentsArguments
    extends EntityIDs,
        RoleID,
        UserIDs,
        TokenOverridable {}

interface AdminTeamsAdminsListArguments

interface AdminTeamsAdminsListArguments
    extends TeamID,
        TokenOverridable,
        CursorPaginationEnabled {}

interface AdminTeamsCreateArguments

interface AdminTeamsCreateArguments extends TokenOverridable {}

property team_description

team_description?: string;

Description for the team.

property team_discoverability

team_discoverability?: TeamDiscoverability;

Who can join the team.

property team_domain

team_domain: string;

Team domain (for example, slacksoftballteam). Domains are limited to 21 characters.

property team_name

team_name: string;

Team name (for example, Slack Softball Team).

interface AdminTeamsOwnersListArguments

interface AdminTeamsOwnersListArguments
    extends TeamID,
        TokenOverridable,
        CursorPaginationEnabled {}

interface AdminTeamsSettingsInfoArguments

interface AdminTeamsSettingsInfoArguments extends TeamID, TokenOverridable {}

interface AdminTeamsSettingsSetDefaultChannelsArguments

interface AdminTeamsSettingsSetDefaultChannelsArguments
    extends ChannelIDs,
        TeamID,
        TokenOverridable {}

interface AdminTeamsSettingsSetDescriptionArguments

interface AdminTeamsSettingsSetDescriptionArguments
    extends TeamID,
        TokenOverridable {}

property description

description: string;

The new description for the workspace.

interface AdminTeamsSettingsSetDiscoverabilityArguments

interface AdminTeamsSettingsSetDiscoverabilityArguments
    extends TeamID,
        TokenOverridable {}

property discoverability

discoverability: TeamDiscoverability;

This workspace's discovery setting.

interface AdminTeamsSettingsSetIconArguments

interface AdminTeamsSettingsSetIconArguments extends TeamID, TokenOverridable {}

property image_url

image_url: string;

Image URL for the icon.

interface AdminTeamsSettingsSetNameArguments

interface AdminTeamsSettingsSetNameArguments extends TeamID, TokenOverridable {}

property name

name: string;

The new name of the workspace.

interface AdminUsergroupsAddChannelsArguments

interface AdminUsergroupsAddChannelsArguments
    extends ChannelIDs,
        UsergroupID,
        OptionalTeamAssignable,
        TokenOverridable {}

interface AdminUsergroupsAddTeamsArguments

interface AdminUsergroupsAddTeamsArguments extends UsergroupID, TokenOverridable {}

property auto_provision

auto_provision?: boolean;

When true, this method automatically creates new workspace accounts for the IDP group members. Defaults to false.

property team_ids

team_ids: string | string[];

One or more encoded team (workspace) IDs. Each workspace MUST belong to the organization associated with the token.

interface AdminUsergroupsListChannelsArguments

interface AdminUsergroupsListChannelsArguments
    extends UsergroupID,
        OptionalTeamAssignable,
        TokenOverridable {}

property include_num_members

include_num_members?: boolean;

Flag to include or exclude the count of members per channel.

interface AdminUsergroupsRemoveChannelsArguments

interface AdminUsergroupsRemoveChannelsArguments
    extends ChannelIDs,
        UsergroupID,
        TokenOverridable {}

interface AdminUsersAssignArguments

interface AdminUsersAssignArguments
    extends TeamID,
        UserID,
        Partial<ChannelIDs>,
        IsRestricted,
        IsUltraRestricted,
        TokenOverridable {}

interface AdminUsersInviteArguments

interface AdminUsersInviteArguments
    extends ChannelIDs,
        TeamID,
        IsRestricted,
        IsUltraRestricted,
        TokenOverridable {}

property custom_message

custom_message?: string;

An optional message to send to the user in the invite email.

property email

email: string;

The email address of the person to invite.

property email_password_policy_enabled

email_password_policy_enabled?: boolean;

Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via admin invite.

property guest_expiration_ts

guest_expiration_ts?: string;

Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.

property real_name

real_name?: string;

Full name of the user.

property resend

resend?: boolean;

Allow this invite to be resent in the future if a user has not signed up yet. Resending can only be done via the UI and has no expiration. Defaults to false.

interface AdminUsersRemoveArguments

interface AdminUsersRemoveArguments extends TeamID, UserID, TokenOverridable {}

interface AdminUsersSessionClearSettingsArguments

interface AdminUsersSessionClearSettingsArguments
    extends UserIDs,
        TokenOverridable {}

interface AdminUsersSessionGetSettingsArguments

interface AdminUsersSessionGetSettingsArguments extends UserIDs, TokenOverridable {}

interface AdminUsersSessionInvalidateArguments

interface AdminUsersSessionInvalidateArguments extends TeamID, TokenOverridable {}

property session_id

session_id: string;

ID of the session to invalidate.

interface AdminUsersSessionResetArguments

interface AdminUsersSessionResetArguments
    extends UserID,
        SessionExpirationTarget,
        TokenOverridable {}

interface AdminUsersSessionResetBulkArguments

interface AdminUsersSessionResetBulkArguments
    extends UserIDs,
        SessionExpirationTarget,
        TokenOverridable {}

interface AdminUsersSessionSetSettingsArguments

interface AdminUsersSessionSetSettingsArguments extends UserIDs, TokenOverridable {}

property desktop_app_browser_quit

desktop_app_browser_quit?: boolean;

Terminate the session when the client—either the desktop app or a browser window—is closed.

property duration

duration?: number;

The session duration in seconds. The minimum value is 28800, which represents 8 hours; the max value is 315569520 or 10 years (that's a long Slack session).

interface AdminUsersSetAdminArguments

interface AdminUsersSetAdminArguments extends TeamID, UserID, TokenOverridable {}

interface AdminUsersSetExpirationArguments

interface AdminUsersSetExpirationArguments
    extends UserID,
        TokenOverridable,
        OptionalTeamAssignable {}

property expiration_ts

expiration_ts: number;

Epoch timestamp in seconds when guest account should be disabled.

interface AdminUsersSetOwnerArguments

interface AdminUsersSetOwnerArguments extends TeamID, UserID, TokenOverridable {}

interface AdminUsersSetRegularArguments

interface AdminUsersSetRegularArguments extends TeamID, UserID, TokenOverridable {}

interface AdminUsersUnsupportedVersionsExportArguments

interface AdminUsersUnsupportedVersionsExportArguments extends TokenOverridable {}

property date_end_of_support

date_end_of_support?: number;

Unix timestamp of the date of past or upcoming end of support cycles. If not provided will include all announced end of support cycles. Defaults to 0.

property date_sessions_started

date_sessions_started?: number;

Unix timestamp of a date to start looking for user sessions. If not provided will start six months ago.

interface AdminWorkflowsCollaboratorsAddArguments

interface AdminWorkflowsCollaboratorsAddArguments
    extends CollaboratorIDs,
        WorkflowIDs,
        TokenOverridable {}

interface AdminWorkflowsCollaboratorsRemoveArguments

interface AdminWorkflowsCollaboratorsRemoveArguments
    extends CollaboratorIDs,
        WorkflowIDs,
        TokenOverridable {}

interface AdminWorkflowsPermissionsLookupArguments

interface AdminWorkflowsPermissionsLookupArguments
    extends WorkflowIDs,
        TokenOverridable {}

property max_workflow_triggers

max_workflow_triggers?: number;

Maximum number of triggers to fetch for each workflow when determining overall run permissions. Defaults to 100. Maximum of 1000.

interface AdminWorkflowsUnpublishArguments

interface AdminWorkflowsUnpublishArguments extends WorkflowIDs, TokenOverridable {}

interface AppsEventAuthorizationsListArguments

interface AppsEventAuthorizationsListArguments
    extends TokenOverridable,
        CursorPaginationEnabled {}

property event_context

event_context: string;

interface AppsManifestCreateArguments

interface AppsManifestCreateArguments extends TokenOverridable {}

property manifest

manifest: Manifest;

interface AppsManifestDeleteArguments

interface AppsManifestDeleteArguments extends AppID, TokenOverridable {}

interface AppsManifestExportArguments

interface AppsManifestExportArguments extends AppID, TokenOverridable {}

interface AppsManifestUpdateArguments

interface AppsManifestUpdateArguments extends AppID, TokenOverridable {}

property manifest

manifest: Manifest;

interface AppsManifestValidateArguments

interface AppsManifestValidateArguments extends Partial<AppID>, TokenOverridable {}

property manifest

manifest: Manifest;

interface AppsUninstallArguments

interface AppsUninstallArguments
    extends Pick<OAuthCredentials, 'client_id' | 'client_secret'>,
        TokenOverridable {}

interface AssistantThreadsSetStatusArguments

interface AssistantThreadsSetStatusArguments extends TokenOverridable {}

property channel_id

channel_id: string;

Channel ID containing the assistant thread.

property status

status: string;

Status of the assistant (e.g. 'is thinking...')

property thread_ts

thread_ts: string;

Message timestamp of the thread.

interface AssistantThreadsSetSuggestedPromptsArguments

interface AssistantThreadsSetSuggestedPromptsArguments extends TokenOverridable {}

property channel_id

channel_id: string;

Channel ID containing the assistant thread.

property prompts

prompts: [AssistantPrompt, ...AssistantPrompt[]];

Prompt suggestions that appear when opening assistant thread.

property thread_ts

thread_ts: string;

Message timestamp of the thread.

property title

title?: string;

Title for the prompts.

interface AssistantThreadsSetTitleArguments

interface AssistantThreadsSetTitleArguments extends TokenOverridable {}

property channel_id

channel_id: string;

Channel ID containing the assistant thread.

property thread_ts

thread_ts: string;

Message timestamp of the thread.

property title

title: string;

Title of the thread.

interface BookmarksAddArguments

interface BookmarksAddArguments
    extends ChannelID,
        BookmarkFields,
        TokenOverridable {}

property entity_id

entity_id?: string;

ID of the entity being bookmarked. Only applies to message and file types.

property parent_id

parent_id?: string;

ID of this bookmark's parent.

property type

type: 'link';

Type of the bookmark. Only link is supported at the moment.

interface BookmarksEditArguments

interface BookmarksEditArguments
    extends ChannelID,
        ID,
        Partial<BookmarkFields>,
        TokenOverridable {}

interface BookmarksListArguments

interface BookmarksListArguments extends ChannelID, TokenOverridable {}

interface BookmarksRemoveArguments

interface BookmarksRemoveArguments extends ChannelID, ID, TokenOverridable {}

interface CallsAddArguments

interface CallsAddArguments extends Partial<Users>, CallDetails, TokenOverridable {}

property created_by

created_by?: string;

ID of the user who created this Call. When this method is called with a user token, this field is optional and defaults to the authed user of the token. Otherwise, the field is required.

property date_start

date_start?: number;

Unix timestamp of the call start time.

property external_display_id

external_display_id?: string;

An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.

property external_unique_id

external_unique_id: string;

An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.

interface CallsEndArguments

interface CallsEndArguments extends ID, TokenOverridable {}

property duration

duration?: number;

Call duration in seconds.

interface CallsInfoArguments

interface CallsInfoArguments extends ID, TokenOverridable {}

interface CallsParticipantsAddArguments

interface CallsParticipantsAddArguments extends ID, Users, TokenOverridable {}

interface CallsParticipantsRemoveArguments

interface CallsParticipantsRemoveArguments extends ID, Users, TokenOverridable {}

interface CallsUpdateArguments

interface CallsUpdateArguments extends ID, Partial<CallDetails>, TokenOverridable {}

interface CanvasesAccessDeleteArguments

interface CanvasesAccessDeleteArguments
    extends CanvasID,
        Partial<ChannelIDs>,
        TokenOverridable,
        Partial<UserIDs> {}

interface CanvasesAccessSetArguments

interface CanvasesAccessSetArguments
    extends CanvasID,
        Partial<ChannelIDs>,
        TokenOverridable,
        Partial<UserIDs> {}

property access_level

access_level: 'read' | 'write';

Desired level of access.

interface CanvasesDeleteArguments

interface CanvasesDeleteArguments extends CanvasID, TokenOverridable {}

interface CanvasesEditArguments

interface CanvasesEditArguments extends CanvasID, TokenOverridable {}

property changes

changes: [Change, ...Change[]];

List of changes to apply to the canvas.

interface CanvasesSectionsLookupArguments

interface CanvasesSectionsLookupArguments extends CanvasID, TokenOverridable {}

property criteria

criteria: Criteria;

Filtering criteria.

interface ChatDeleteArguments

interface ChatDeleteArguments extends ChannelAndTS, AsUser, TokenOverridable {}

interface ChatDeleteScheduledMessageArguments

interface ChatDeleteScheduledMessageArguments
    extends Channel,
        AsUser,
        TokenOverridable {}

property scheduled_message_id

scheduled_message_id: string;

The scheduled_message_id returned from call to .

interface ChatGetPermalinkArguments

interface ChatGetPermalinkArguments extends ChannelAndMessageTS, TokenOverridable {}

interface ChatMeMessageArguments

interface ChatMeMessageArguments extends ChannelAndText, TokenOverridable {}

interface CodedError

interface CodedError extends NodeJS.ErrnoException {}

All errors produced by this package adhere to this interface

property code

code: ErrorCode;

interface ConversationsApproveSharedInviteArguments

interface ConversationsApproveSharedInviteArguments
    extends InviteID,
        TargetTeam,
        TokenOverridable {}

interface ConversationsArchiveArguments

interface ConversationsArchiveArguments extends Channel, TokenOverridable {}

interface ConversationsCanvasesCreateArguments

interface ConversationsCanvasesCreateArguments extends ChannelID, TokenOverridable {}

property document_content

document_content?: DocumentContent;

Structure describing the type and contents of the Canvas being created.

interface ConversationsCloseArguments

interface ConversationsCloseArguments extends Channel, TokenOverridable {}

interface ConversationsCreateArguments

interface ConversationsCreateArguments
    extends IsPrivate,
        TokenOverridable,
        OptionalTeamAssignable {}

property name

name: string;

Name of the public or private channel to create.

interface ConversationsDeclineSharedInviteArguments

interface ConversationsDeclineSharedInviteArguments
    extends InviteID,
        TargetTeam,
        TokenOverridable {}

interface ConversationsExternalInvitePermissionsSetArguments

interface ConversationsExternalInvitePermissionsSetArguments
    extends Channel,
        Required<TargetTeam>,
        TokenOverridable {}

property action

action: 'downgrade' | 'upgrade';

The type of action be taken: upgrade or downgrade.

interface ConversationsHistoryArguments

interface ConversationsHistoryArguments
    extends Channel,
        IncludeAllMetadata,
        TokenOverridable,
        CursorPaginationEnabled,
        TimelinePaginationEnabled {}

interface ConversationsInfoArguments

interface ConversationsInfoArguments
    extends Channel,
        TokenOverridable,
        LocaleAware {}

property include_num_members

include_num_members?: boolean;

Set to true to include the member count for the specified conversation. Defaults to false.

interface ConversationsInviteArguments

interface ConversationsInviteArguments extends Channel, Users, TokenOverridable {}

property force

force?: boolean;

When set to true and multiple user IDs are provided, continue inviting the valid ones while disregarding invalid IDs. Defaults to false.

interface ConversationsJoinArguments

interface ConversationsJoinArguments extends Channel, TokenOverridable {}

interface ConversationsKickArguments

interface ConversationsKickArguments extends Channel, TokenOverridable {}

property user

user: string;

interface ConversationsLeaveArguments

interface ConversationsLeaveArguments extends Channel, TokenOverridable {}

interface ConversationsMarkArguments

interface ConversationsMarkArguments extends MessageSpecifier, TokenOverridable {}

interface ConversationsMembersArguments

interface ConversationsMembersArguments
    extends Channel,
        TokenOverridable,
        CursorPaginationEnabled {}

interface ConversationsRenameArguments

interface ConversationsRenameArguments extends Channel, TokenOverridable {}

property name

name: string;

New name for conversation.

interface ConversationsRepliesArguments

interface ConversationsRepliesArguments
    extends MessageSpecifier,
        IncludeAllMetadata,
        TokenOverridable,
        CursorPaginationEnabled,
        TimelinePaginationEnabled {}

interface ConversationsRequestSharedInviteApproveArguments

interface ConversationsRequestSharedInviteApproveArguments
    extends InviteID,
        Partial<ChannelID>,
        TokenOverridable {}

property is_external_limited

is_external_limited?: boolean;

Whether the invited team will have post-only permissions in the channel. Will override the value on the requested invite.

property message

message?: {
    /**
     * @description When `true`, will override the user specified message. Otherwise, `text` will be appended to the
     * user specified message on the invite request.
     */
    is_override: boolean;
    /** @description Text to include along with the email invite. */
    text: string;
};

Optional additional messaging to attach to the invite approval message.

interface ConversationsRequestSharedInviteDenyArguments

interface ConversationsRequestSharedInviteDenyArguments
    extends InviteID,
        Message,
        TokenOverridable {}

interface ConversationsSetPurposeArguments

interface ConversationsSetPurposeArguments extends Channel, TokenOverridable {}

property purpose

purpose: string;

A new, specialer purpose.

interface ConversationsSetTopicArguments

interface ConversationsSetTopicArguments extends Channel, TokenOverridable {}

property topic

topic: string;

The new topic string. Does not support formatting or linkification.

interface ConversationsUnarchiveArguments

interface ConversationsUnarchiveArguments extends Channel, TokenOverridable {}

interface DialogOpenArguments

interface DialogOpenArguments extends TokenOverridable {}

property dialog

dialog: Dialog;

The dialog definition.

property trigger_id

trigger_id: string;

Exchange a trigger to post to the user.

interface DndSetSnoozeArguments

interface DndSetSnoozeArguments extends TokenOverridable {}

property num_minutes

num_minutes: number;

Number of minutes, from now, to snooze until.

interface DndTeamInfoArguments

interface DndTeamInfoArguments extends TokenOverridable, OptionalTeamAssignable {}

property users

users: string;

Comma-separated list of users to fetch Do Not Disturb status for.

interface FilesCommentsDeleteArguments

interface FilesCommentsDeleteArguments extends FileArgument, TokenOverridable {}

property id

id: string;

The ID of the comment to delete.

interface FilesDeleteArguments

interface FilesDeleteArguments extends FileArgument, TokenOverridable {}

interface FilesGetUploadURLExternalArguments

interface FilesGetUploadURLExternalArguments extends TokenOverridable {}

property alt_text

alt_text?: string;

Description of image for screen-reader.

property filename

filename: string;

Name of the file being uploaded.

property length

length: number;

Size in bytes of the file being uploaded.

property snippet_type

snippet_type?: string;

Syntax type of the snippet being uploaded. E.g. python.

interface FilesInfoArguments

interface FilesInfoArguments
    extends FileArgument,
        TokenOverridable,
        CursorPaginationEnabled,
        TraditionalPagingEnabled {}

interface FilesListArguments

interface FilesListArguments
    extends TokenOverridable,
        TraditionalPagingEnabled,
        OptionalTeamAssignable {}

property channel

channel?: string;

Filter files appearing in a specific channel, indicated by its ID.

property show_files_hidden_by_limit

show_files_hidden_by_limit?: boolean;

Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.

property ts_from

ts_from?: string;

Filter files created after this timestamp (inclusive).

property ts_to

ts_to?: string;

Filter files created before this timestamp (inclusive).

property types

types?: string;

Filter files by type. Pass multiple values for types argument by comma-seperating the values. The default value is all, which does not filter the list. Available types are all, spaces, snippets, images, gdocs, zips and pdfs.

property user

user?: string;

Filter files created by a single user.

interface FilesRemoteAddArguments

interface FilesRemoteAddArguments
    extends SharedFile,
        FileType,
        ExternalIDArgument,
        TokenOverridable {}

interface FilesRemoteListArguments

interface FilesRemoteListArguments
    extends TokenOverridable,
        CursorPaginationEnabled {}

property channel

channel?: string;

Filter files appearing in a specific channel, indicated by its ID.

property ts_from

ts_from?: string;

Filter files created after this timestamp (inclusive).

property ts_to

ts_to?: string;

Filter files created before this timestamp (inclusive).

interface FilesRevokePublicURLArguments

interface FilesRevokePublicURLArguments extends FileArgument, TokenOverridable {}

interface FilesSharedPublicURLArguments

interface FilesSharedPublicURLArguments extends FileArgument, TokenOverridable {}

interface FunctionsCompleteErrorArguments

interface FunctionsCompleteErrorArguments extends ExecutionID, TokenOverridable {}

property error

error: string;

interface FunctionsCompleteSuccessArguments

interface FunctionsCompleteSuccessArguments extends ExecutionID, TokenOverridable {}

property outputs

outputs: Record<string, unknown>;

interface MigrationExchangeArguments

interface MigrationExchangeArguments
    extends TokenOverridable,
        OptionalTeamAssignable {}

property to_old

to_old?: boolean;

Specify true to convert W global user IDs to workspace-specific U IDs. Defaults to false.

property users

users: string;

A comma-separated list of user IDs, up to 400 per request.

interface OAuthAccessArguments

interface OAuthAccessArguments extends OAuthCredentials {}

property single_channel

single_channel?: boolean;

Request the user to add your app only to a single channel. Only valid with a . Defaults to false.

interface OAuthV2AccessArguments

interface OAuthV2AccessArguments extends OAuthCredentials, OAuthGrantRefresh {}

interface OAuthV2ExchangeArguments

interface OAuthV2ExchangeArguments
    extends Pick<OAuthCredentials, 'client_id' | 'client_secret'> {}

property token

token: string;

The legacy xoxb or xoxp token being migrated.

interface OpenIDConnectTokenArguments

interface OpenIDConnectTokenArguments extends OAuthCredentials, OAuthGrantRefresh {}

interface PinsAddArguments

interface PinsAddArguments extends MessageArgument, TokenOverridable {}

interface PinsListArguments

interface PinsListArguments extends TokenOverridable {}

property channel

channel: string;

Channel to get pinned items for.

interface PinsRemoveArguments

interface PinsRemoveArguments extends MessageArgument, TokenOverridable {}

interface ReactionsAddArguments

interface ReactionsAddArguments
    extends MessageArgument,
        TokenOverridable,
        ReactionName {}

interface RemindersAddArguments

interface RemindersAddArguments extends TokenOverridable, OptionalTeamAssignable {}

property recurrence

recurrence?: ReminderRecurrence;

Specify the repeating behavior of a reminder. If you set the sub-property frequency to weekly, you must also set the weekdays array to specify which days of the week to recur on.

property text

text: string;

The content of the reminder.

property time

time: string | number;

When this reminder should happen, one of: - the Unix timestamp (up to five years from now), - the number of seconds until the reminder (if within 24 hours), or - a natural language description (Ex. "in 15 minutes," or "every Thursday").

property user

user?: string;

No longer supported - reminders cannot be set for other users.
See Also
- .
Deprecated

interface RemindersCompleteArguments

interface RemindersCompleteArguments
    extends TokenOverridable,
        OptionalTeamAssignable {}

property reminder

reminder: string;

The ID of the reminder to be marked as complete.

interface RemindersDeleteArguments

interface RemindersDeleteArguments
    extends TokenOverridable,
        OptionalTeamAssignable {}

property reminder

reminder: string;

The ID of the reminder to delete.

interface RemindersInfoArguments

interface RemindersInfoArguments extends TokenOverridable, OptionalTeamAssignable {}

property reminder

reminder: string;

The ID of the reminder to retrieve information about.

interface RetryOptions

interface RetryOptions extends OperationOptions {}

Options to create retry policies. Extends from https://github.com/tim-kos/node-retry.

interface SearchAllArguments

interface SearchAllArguments
    extends TokenOverridable,
        TraditionalPagingEnabled,
        Searchable {}

interface SearchFilesArguments

interface SearchFilesArguments
    extends TokenOverridable,
        TraditionalPagingEnabled,
        Searchable {}

interface SearchMessagesArguments

interface SearchMessagesArguments
    extends TokenOverridable,
        TraditionalPagingEnabled,
        Searchable {}

interface StarsListArguments

interface StarsListArguments
    extends TokenOverridable,
        TraditionalPagingEnabled,
        CursorPaginationEnabled,
        OptionalTeamAssignable {}

interface ToolingTokensRotateArguments

interface ToolingTokensRotateArguments {}

property refresh_token

refresh_token: string;

The xoxe refresh token that was issued along with the old app configuration token.

interface UsergroupsCreateArguments

interface UsergroupsCreateArguments
    extends TokenOverridable,
        OptionalTeamAssignable,
        UsergroupsIncludeCount {}

property channels

channels?: string;

A comma separated string of encoded channel IDs for which the User Group uses as a default.

property description

description?: string;

A short description of the User Group.

property handle

handle?: string;

A mention handle. Must be unique among channels, users and User Groups.

property name

name: string;

A name for the User Group. Must be unique among User Groups.

interface UsergroupsDisableArguments

interface UsergroupsDisableArguments
    extends TokenOverridable,
        OptionalTeamAssignable,
        UsergroupsIncludeCount {}

property usergroup

usergroup: string;

The encoded ID of the User Group to disable.

interface UsergroupsEnableArguments

interface UsergroupsEnableArguments
    extends TokenOverridable,
        OptionalTeamAssignable,
        UsergroupsIncludeCount {}

property usergroup

usergroup: string;

The encoded ID of the User Group to enable.

interface UsergroupsUpdateArguments

interface UsergroupsUpdateArguments
    extends TokenOverridable,
        OptionalTeamAssignable,
        Partial<UsergroupsCreateArguments> {}

property usergroup

usergroup: string;

The encoded ID of the User Group to update.

interface UsergroupsUsersListArguments

interface UsergroupsUsersListArguments
    extends TokenOverridable,
        OptionalTeamAssignable {}

property include_disabled

include_disabled?: boolean;

Allow results that involve disabled User Groups.

property usergroup

usergroup: string;

The encoded ID of the User Group to list users for.

interface UsergroupsUsersUpdateArguments

interface UsergroupsUsersUpdateArguments
    extends TokenOverridable,
        OptionalTeamAssignable,
        UsergroupsIncludeCount {}

property usergroup

usergroup: string;

The encoded ID of the User Group to update users for.

property users

users: string;

A comma separated string of encoded user IDs that represent the entire list of users for the User Group.

interface UsersConversationsArguments

interface UsersConversationsArguments
    extends TokenOverridable,
        CursorPaginationEnabled,
        OptionalTeamAssignable {}

property exclude_archived

exclude_archived?: boolean;

Set to true to exclude archived channels from the list. Default is false.

property types

types?: string;

Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim and im. Defaults to public_channel.

property user

user?: string;

Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.

interface UsersDeletePhotoArguments

interface UsersDeletePhotoArguments extends TokenOverridable {}

interface UsersDiscoverableContactsLookupArguments

interface UsersDiscoverableContactsLookupArguments extends Email, TokenOverridable {}

interface UsersGetPresenceArguments

interface UsersGetPresenceArguments extends TokenOverridable {}

property user

user?: string;

User to get presence info on. Defaults to the authed user.

interface UsersIdentityArguments

interface UsersIdentityArguments extends TokenOverridable {}

interface UsersInfoArguments

interface UsersInfoArguments extends TokenOverridable, LocaleAware {}

property user

user: string;

User to get info on.

interface UsersListArguments

interface UsersListArguments
    extends TokenOverridable,
        CursorPaginationEnabled,
        LocaleAware,
        OptionalTeamAssignable {}

interface UsersLookupByEmailArguments

interface UsersLookupByEmailArguments extends Email, TokenOverridable {}

interface UsersProfileGetArguments

interface UsersProfileGetArguments extends TokenOverridable {}

property include_labels

include_labels?: boolean;

Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended. Defaults to false.

property user

user?: string;

User to retrieve profile info for.

interface UsersProfileSetArguments

interface UsersProfileSetArguments extends TokenOverridable {}

property name

name?: string;

Name of a single profile field to set. If both name and profile are set, name takes precedence.
See Also
- .

property profile

profile?: Record<string, unknown>;

Sets profile fields using a single argument. Collection of key:value pairs presented. At most 50 fields may be set. Each field name is limited to 255 characters.
See Also
- .

property user

user?: string;

ID of user to change. This argument may only be specified by admins on paid teams.

property value

value?: string;

Value to set for the profile field specified by name. Usable only if profile is not passed.
See Also
- .

interface UsersSetPhotoArguments

interface UsersSetPhotoArguments extends TokenOverridable {}

property crop_w

crop_w?: number;

Width/height of crop box (always square).

property crop_x

crop_x?: number;

X coordinate of top-left corner of crop box.

property crop_y

crop_y?: number;

Y coordinate of top-left corner of crop box.

property image

image: Buffer | Stream;

Image file contents.

interface UsersSetPresenceArguments

interface UsersSetPresenceArguments extends TokenOverridable {}

property presence

presence: 'auto' | 'away';

Either auto or away.

interface ViewsPublishArguments

interface ViewsPublishArguments
    extends BaseViewsArguments,
        TokenOverridable,
        ViewHash {}

property user_id

user_id: string;

ID of the user you want publish a view to.

interface WebAPICallResult

interface WebAPICallResult {}

property error

error?: string;

property ok

ok: boolean;

property response_metadata

response_metadata?: {
    warnings?: string[];
    next_cursor?: string;
    scopes?: string[];
    acceptedScopes?: string[];
    retryAfter?: number;
    messages?: string[];
};

interface WebAPIHTTPError

interface WebAPIHTTPError extends CodedError {}

property body

body?: any;

property code

code: ErrorCode.HTTPError;

property headers

headers: IncomingHttpHeaders;

property statusCode

statusCode: number;

property statusMessage

statusMessage: string;

interface WebAPIPlatformError

interface WebAPIPlatformError extends CodedError {}

property code

code: ErrorCode.PlatformError;

property data

data: WebAPICallResult & {
    error: string;
};

interface WebAPIRateLimitedError

interface WebAPIRateLimitedError extends CodedError {}

property code

code: ErrorCode.RateLimitedError;

property retryAfter

retryAfter: number;

interface WebAPIRequestError

interface WebAPIRequestError extends CodedError {}

property code

code: ErrorCode.RequestError;

property original

original: Error;

interface WebClientOptions

interface WebClientOptions {}

property adapter

adapter?: AdapterConfig;

Custom functions for modifing and handling outgoing requests. Useful if you would like to manage outgoing request with a custom http client. See for more information. {Function | undefined} undefined

property agent

agent?: Agent;

property attachOriginalToWebAPIRequestError

attachOriginalToWebAPIRequestError?: boolean;

Indicates whether to attach the original error to a Web API request error. When set to true, the original error object will be attached to the Web API request error. {boolean} true

property headers

headers?: Record<string, string>;

property logger

logger?: Logger;

property logLevel

logLevel?: LogLevel;

property maxRequestConcurrency

maxRequestConcurrency?: number;

property rejectRateLimitedCalls

rejectRateLimitedCalls?: boolean;

property requestInterceptor

requestInterceptor?: RequestInterceptor;

Custom function to modify outgoing requests. See for more details. {Function | undefined} undefined

property retryConfig

retryConfig?: RetryOptions;

property slackApiUrl

slackApiUrl?: string;

property teamId

teamId?: string;

property timeout

timeout?: number;

property tls

tls?: TLSOptions;

interface WorkflowsStepCompletedArguments

interface WorkflowsStepCompletedArguments extends TokenOverridable {}

property outputs

outputs?: Record<string, unknown>;

property workflow_step_execute_id

workflow_step_execute_id: string;

interface WorkflowsStepFailedArguments

interface WorkflowsStepFailedArguments extends TokenOverridable {}

property error

error: {
    message: string;
};

property workflow_step_execute_id

workflow_step_execute_id: string;

interface WorkflowsUpdateStepArguments

interface WorkflowsUpdateStepArguments extends TokenOverridable {}

property inputs

inputs?: {
    [name: string]: {
        value: any;
        skip_variable_replacement?: boolean;
        variables?: {
            [key: string]: any;
        };
    };
};

property outputs

outputs?: {
    type: string;
    name: string;
    label: string;
}[];

property step_image_url

step_image_url?: string;

property step_name

step_name?: string;

property workflow_step_edit_id

workflow_step_edit_id: string;

Enums

enum ErrorCode

enum ErrorCode {
    RequestError = 'slack_webapi_request_error',
    HTTPError = 'slack_webapi_http_error',
    PlatformError = 'slack_webapi_platform_error',
    RateLimitedError = 'slack_webapi_rate_limited_error',
    FileUploadInvalidArgumentsError = 'slack_webapi_file_upload_invalid_args_error',
    FileUploadReadFileDataError = 'slack_webapi_file_upload_read_file_data_error',
}

A dictionary of codes for errors produced by this package

member FileUploadInvalidArgumentsError

FileUploadInvalidArgumentsError = 'slack_webapi_file_upload_invalid_args_error'

member FileUploadReadFileDataError

FileUploadReadFileDataError = 'slack_webapi_file_upload_read_file_data_error'

member HTTPError

HTTPError = 'slack_webapi_http_error'

member PlatformError

PlatformError = 'slack_webapi_platform_error'

member RateLimitedError

RateLimitedError = 'slack_webapi_rate_limited_error'

member RequestError

RequestError = 'slack_webapi_request_error'

enum WebClientEvent

enum WebClientEvent {
    RATE_LIMITED = 'rate_limited',
}

member RATE_LIMITED

RATE_LIMITED = 'rate_limited'

Type Aliases

type AdminAnalyticsGetFileArguments

type AdminAnalyticsGetFileArguments = TokenOverridable &
    (MemberArgs | PublicChannelArgs);

type AdminAnalyticsGetFileResponse

type AdminAnalyticsGetFileResponse = WebAPICallResult & {
    file_data?: (
        | AdminAnalyticsMemberDetails
        | AdminAnalyticsPublicChannelDetails
        | AdminAnalyticsPublicChannelMetadataDetails
    )[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminAppsActivitiesListArguments

type AdminAppsActivitiesListArguments = OptionalArgument<
    Partial<AppID> &
        Partial<TeamID> &
        TokenOverridable &
        CursorPaginationEnabled & {
            /**
             * @description The component ID of log events to be returned. Will be `FnXXXXXX` for functions,
             * and `WfXXXXXX` for worflows.
             */
            component_id?: string;
            /** @description The component type of log events to be returned. */
            component_type?: 'events_api' | 'workflows' | 'functions' | 'tables';
            /** @description The event type of log events to be returned. */
            log_event_type?: string;
            /** @description The latest timestamp of the log to retrieve (epoch microseconds). */
            max_date_created?: number;
            /** @description The earliest timestamp of the log to retrieve (epoch microseconds). */
            min_date_created?: number;
            /** @description The minimum log level of the log events to be returned. Defaults to `info`. */
            min_log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
            /** @description The direction you want the data sorted by (always by timestamp). */
            sort_direction?: 'asc' | 'desc';
            /** @description The source of log events to be returned. */
            source?: 'slack' | 'developer';
            /** @description The trace ID of log events to be returned. */
            trace_id?: string;
        }
>;

type AdminAppsActivitiesListResponse

type AdminAppsActivitiesListResponse = WebAPICallResult & {
    activities?: Activity[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminAppsApproveArguments

type AdminAppsApproveArguments = AppOrRequestID &
    TeamOrEnterpriseID &
    TokenOverridable;

type AdminAppsApprovedListArguments

type AdminAppsApprovedListArguments = Partial<TeamOrEnterpriseID> &
    TokenOverridable &
    CursorPaginationEnabled &
    Certified;

type AdminAppsApprovedListResponse

type AdminAppsApprovedListResponse = WebAPICallResult & {
    approved_apps?: ApprovedApp[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type AdminAppsApproveResponse

type AdminAppsApproveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    warning?: string;
};

type AdminAppsClearResolutionArguments

type AdminAppsClearResolutionArguments = AppID &
    TeamOrEnterpriseID &
    TokenOverridable;

type AdminAppsClearResolutionResponse

type AdminAppsClearResolutionResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    warning?: string;
};

type AdminAppsConfigLookupResponse

type AdminAppsConfigLookupResponse = WebAPICallResult & {
    configs?: Config[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminAppsConfigSetResponse

type AdminAppsConfigSetResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminAppsRequestsCancelArguments

type AdminAppsRequestsCancelArguments = RequestID &
    TeamOrEnterpriseID &
    TokenOverridable;

type AdminAppsRequestsCancelResponse

type AdminAppsRequestsCancelResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminAppsRequestsListArguments

type AdminAppsRequestsListArguments = TeamOrEnterpriseID &
    Certified &
    TokenOverridable &
    CursorPaginationEnabled;

type AdminAppsRequestsListResponse

type AdminAppsRequestsListResponse = WebAPICallResult & {
    app_requests?: AppRequest[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type AdminAppsRestrictArguments

type AdminAppsRestrictArguments = AppOrRequestID &
    TeamOrEnterpriseID &
    TokenOverridable;

type AdminAppsRestrictedListArguments

type AdminAppsRestrictedListArguments = TeamOrEnterpriseID &
    Certified &
    TokenOverridable &
    CursorPaginationEnabled;

type AdminAppsRestrictedListResponse

type AdminAppsRestrictedListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    restricted_apps?: RestrictedApp[];
    warning?: string;
};

type AdminAppsRestrictResponse

type AdminAppsRestrictResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    warning?: string;
};

type AdminAppsUninstallArguments

type AdminAppsUninstallArguments = AppID & TeamOrEnterpriseID & TokenOverridable;

type AdminAppsUninstallResponse

type AdminAppsUninstallResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    warning?: string;
};

type AdminAuthPolicyAssignEntitiesResponse

type AdminAuthPolicyAssignEntitiesResponse = WebAPICallResult & {
    entity_total_count?: number;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminAuthPolicyGetEntitiesResponse

type AdminAuthPolicyGetEntitiesResponse = WebAPICallResult & {
    entities?: Entity[];
    entity_total_count?: number;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminAuthPolicyRemoveEntitiesResponse

type AdminAuthPolicyRemoveEntitiesResponse = WebAPICallResult & {
    entity_total_count?: number;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminBarriersCreateResponse

type AdminBarriersCreateResponse = WebAPICallResult & {
    barrier?: Barrier;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminBarriersDeleteResponse

type AdminBarriersDeleteResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminBarriersListArguments

type AdminBarriersListArguments = OptionalArgument<
    TokenOverridable & CursorPaginationEnabled
>;

type AdminBarriersListResponse

type AdminBarriersListResponse = WebAPICallResult & {
    barriers?: Barrier[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminBarriersUpdateResponse

type AdminBarriersUpdateResponse = WebAPICallResult & {
    barrier?: Barrier;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsArchiveResponse

type AdminConversationsArchiveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsBulkArchiveResponse

type AdminConversationsBulkArchiveResponse = WebAPICallResult & {
    bulk_action_id?: string;
    error?: string;
    needed?: string;
    not_added?: NotAdded[];
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminConversationsBulkDeleteResponse

type AdminConversationsBulkDeleteResponse = WebAPICallResult & {
    bulk_action_id?: string;
    error?: string;
    needed?: string;
    not_added?: NotAdded[];
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminConversationsBulkMoveResponse

type AdminConversationsBulkMoveResponse = WebAPICallResult & {
    bulk_action_id?: string;
    error?: string;
    needed?: string;
    not_added?: NotAdded[];
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminConversationsConvertToPrivateResponse

type AdminConversationsConvertToPrivateResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsConvertToPublicResponse

type AdminConversationsConvertToPublicResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminConversationsCreateArguments

type AdminConversationsCreateArguments = TokenOverridable &
    WorkspaceAccess & {
        /** @description When `true`, creates a private channel instead of a public channel. */
        is_private: boolean;
        /** @description Name of the public or private channel to create. */
        name: string;
        /** @description Description of the public or private channel to create. */
        description?: string;
    };

type AdminConversationsCreateResponse

type AdminConversationsCreateResponse = WebAPICallResult & {
    channel_id?: string;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminConversationsDeleteResponse

type AdminConversationsDeleteResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsDisconnectSharedResponse

type AdminConversationsDisconnectSharedResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsEKMListOriginalConnectedChannelInfoArguments

type AdminConversationsEKMListOriginalConnectedChannelInfoArguments =
    OptionalArgument<
        Partial<TeamIDs> &
            TokenOverridable &
            CursorPaginationEnabled &
            Partial<ChannelIDs>
    >;

type AdminConversationsEkmListOriginalConnectedChannelInfoResponse

type AdminConversationsEkmListOriginalConnectedChannelInfoResponse =
    WebAPICallResult & {
        error?: string;
        needed?: string;
        ok?: boolean;
        provided?: string;
    };

type AdminConversationsGetConversationPrefsResponse

type AdminConversationsGetConversationPrefsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    prefs?: Prefs;
    provided?: string;
};

type AdminConversationsGetCustomRetentionResponse

type AdminConversationsGetCustomRetentionResponse = WebAPICallResult & {
    duration_days?: number;
    error?: string;
    is_policy_enabled?: boolean;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsGetTeamsResponse

type AdminConversationsGetTeamsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    team_ids?: string[];
};

type AdminConversationsInviteResponse

type AdminConversationsInviteResponse = WebAPICallResult & {
    error?: string;
    failed_user_ids?: FailedUserids;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsLookupResponse

type AdminConversationsLookupResponse = WebAPICallResult & {
    channel_ids?: string[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminConversationsRemoveCustomRetentionResponse

type AdminConversationsRemoveCustomRetentionResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsRenameResponse

type AdminConversationsRenameResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsRestrictAccessAddGroupResponse

type AdminConversationsRestrictAccessAddGroupResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminConversationsRestrictAccessListGroupsResponse

type AdminConversationsRestrictAccessListGroupsResponse = WebAPICallResult & {
    error?: string;
    group_ids?: string[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminConversationsRestrictAccessRemoveGroupResponse

type AdminConversationsRestrictAccessRemoveGroupResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminConversationsSearchArguments

type AdminConversationsSearchArguments = OptionalArgument<
    SortDir &
        Partial<TeamIDs> &
        TokenOverridable &
        CursorPaginationEnabled & {
            /** @description Array of encoded team IDs, signifying the external orgs to search through. */
            connected_team_ids?: string[];
            /** @description Name of the channel to query by. */
            query?: string;
            /**
             * @description The type of channels to include or exclude in the search. For example `private` will search
             * private channels, while `private_exclude` will exclude them.
             * @see {@link https://api.slack.com/methods/admin.conversations.search#types Full list of channel types}.
             */
            search_channel_types?: ChannelType[];
            /**
             * @description Possible values are:
             * - `relevant`: search ranking based on what we think is closest,
             * - `name`: alphabetical,
             * - `member_count`: number of users in the channel,
             * - `created`: date channel was created.
             * Defaults to `member_count`.
             * You can optionally pair this with the `sort_dir` argument to change how it is sorted.
             */
            sort?: 'relevant' | 'name' | 'member_count' | 'created';
            /**
             * @description Only return the total count of channels.
             * Omits channel data and allows access for admins without channel manager permissions. Defaults to `false`.
             */
            total_count_only?: boolean;
        }
>;

type AdminConversationsSearchResponse

type AdminConversationsSearchResponse = WebAPICallResult & {
    conversations?: Conversation[];
    error?: string;
    needed?: string;
    next_cursor?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    total_count?: number;
};

type AdminConversationsSetConversationPrefsResponse

type AdminConversationsSetConversationPrefsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsSetCustomRetentionResponse

type AdminConversationsSetCustomRetentionResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsSetTeamsResponse

type AdminConversationsSetTeamsResponse = WebAPICallResult & {
    channel?: string;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsUnarchiveResponse

type AdminConversationsUnarchiveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminConversationsWhitelistAddResponse

type AdminConversationsWhitelistAddResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type AdminConversationsWhitelistListGroupsLinkedToChannelResponse

type AdminConversationsWhitelistListGroupsLinkedToChannelResponse =
    WebAPICallResult & {
        error?: string;
        group_ids?: string[];
        needed?: string;
        ok?: boolean;
        provided?: string;
        response_metadata?: ResponseMetadata;
        warning?: string;
    };

type AdminConversationsWhitelistRemoveResponse

type AdminConversationsWhitelistRemoveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type AdminEmojiAddAliasResponse

type AdminEmojiAddAliasResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminEmojiAddResponse

type AdminEmojiAddResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminEmojiListArguments

type AdminEmojiListArguments = OptionalArgument<
    TokenOverridable & CursorPaginationEnabled
>;

type AdminEmojiListResponse

type AdminEmojiListResponse = WebAPICallResult & {
    emoji?: {
        [key: string]: Emoji;
    };
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminEmojiRemoveResponse

type AdminEmojiRemoveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminEmojiRenameResponse

type AdminEmojiRenameResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminFunctionsListResponse

type AdminFunctionsListResponse = WebAPICallResult & {
    error?: string;
    functions?: Function[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminFunctionsPermissionsLookupResponse

type AdminFunctionsPermissionsLookupResponse = WebAPICallResult & {
    error?: string;
    errors?: Errors;
    needed?: string;
    ok?: boolean;
    permissions?: {
        [key: string]: Permission;
    };
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminFunctionsPermissionsSetResponse

type AdminFunctionsPermissionsSetResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminInviteRequestsApprovedListResponse

type AdminInviteRequestsApprovedListResponse = WebAPICallResult & {
    approved_requests?: ApprovedRequest[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminInviteRequestsApproveResponse

type AdminInviteRequestsApproveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminInviteRequestsDeniedListResponse

type AdminInviteRequestsDeniedListResponse = WebAPICallResult & {
    denied_requests?: DeniedRequest[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminInviteRequestsDenyResponse

type AdminInviteRequestsDenyResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminInviteRequestsListResponse

type AdminInviteRequestsListResponse = WebAPICallResult & {
    error?: string;
    invite_requests?: InviteRequest[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminRolesAddAssignmentsResponse

type AdminRolesAddAssignmentsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    rejected_users?: RejectedUser[];
};

type AdminRolesListAssignmentsArguments

type AdminRolesListAssignmentsArguments = OptionalArgument<
    Partial<EntityIDs> &
        TokenOverridable &
        CursorPaginationEnabled &
        SortDir & {
            /**
             * @description Collection of role ids to scope results by.
             * @see {@link https://api.slack.com/methods/admin.roles.addAssignments#markdown Admin Roles under Usage info}.
             */
            role_ids?: string[];
        }
>;

type AdminRolesListAssignmentsResponse

type AdminRolesListAssignmentsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    role_assignments?: RoleAssignment[];
};

type AdminRolesRemoveAssignmentsResponse

type AdminRolesRemoveAssignmentsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminTeamsAdminsListResponse

type AdminTeamsAdminsListResponse = WebAPICallResult & {
    admin_ids?: string[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminTeamsCreateResponse

type AdminTeamsCreateResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    team?: string;
};

type AdminTeamsListArguments

type AdminTeamsListArguments = OptionalArgument<
    TokenOverridable & CursorPaginationEnabled
>;

type AdminTeamsListResponse

type AdminTeamsListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    teams?: Team[];
};

type AdminTeamsOwnersListResponse

type AdminTeamsOwnersListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    owner_ids?: string[];
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminTeamsSettingsInfoResponse

type AdminTeamsSettingsInfoResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    team?: Team;
};

type AdminTeamsSettingsSetDefaultChannelsResponse

type AdminTeamsSettingsSetDefaultChannelsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminTeamsSettingsSetDescriptionResponse

type AdminTeamsSettingsSetDescriptionResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminTeamsSettingsSetDiscoverabilityResponse

type AdminTeamsSettingsSetDiscoverabilityResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminTeamsSettingsSetIconResponse

type AdminTeamsSettingsSetIconResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminTeamsSettingsSetNameResponse

type AdminTeamsSettingsSetNameResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsergroupsAddChannelsResponse

type AdminUsergroupsAddChannelsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsergroupsAddTeamsResponse

type AdminUsergroupsAddTeamsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsergroupsListChannelsResponse

type AdminUsergroupsListChannelsResponse = WebAPICallResult & {
    channels?: Channel[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsergroupsRemoveChannelsResponse

type AdminUsergroupsRemoveChannelsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsersAssignResponse

type AdminUsersAssignResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsersInviteResponse

type AdminUsersInviteResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminUsersListArguments

type AdminUsersListArguments = OptionalArgument<
    TeamIDOrDeactivatedWorkspaces &
        TokenOverridable &
        CursorPaginationEnabled & {
            /**
             * @description If `true`, only active users will be returned. If `false`, only deactivated users will be returned.
             * Default is `true`.
             */
            is_active?: boolean;
        }
>;

type AdminUsersListResponse

type AdminUsersListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    users?: User[];
};

type AdminUsersRemoveResponse

type AdminUsersRemoveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsersSessionClearSettingsResponse

type AdminUsersSessionClearSettingsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsersSessionGetSettingsResponse

type AdminUsersSessionGetSettingsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    no_settings_applied?: string[];
    ok?: boolean;
    provided?: string;
    session_settings?: SessionSetting[];
};

type AdminUsersSessionInvalidateResponse

type AdminUsersSessionInvalidateResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminUsersSessionListArguments

type AdminUsersSessionListArguments = OptionalArgument<
    EitherTeamAndUserIDOrNeither & TokenOverridable & CursorPaginationEnabled
>;

type AdminUsersSessionListResponse

type AdminUsersSessionListResponse = WebAPICallResult & {
    active_sessions?: ActiveSession[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminUsersSessionResetBulkResponse

type AdminUsersSessionResetBulkResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsersSessionResetResponse

type AdminUsersSessionResetResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsersSessionSetSettingsResponse

type AdminUsersSessionSetSettingsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsersSetAdminResponse

type AdminUsersSetAdminResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsersSetExpirationResponse

type AdminUsersSetExpirationResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsersSetOwnerResponse

type AdminUsersSetOwnerResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsersSetRegularResponse

type AdminUsersSetRegularResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminUsersUnsupportedVersionsExportResponse

type AdminUsersUnsupportedVersionsExportResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminWorkflowsCollaboratorsAddResponse

type AdminWorkflowsCollaboratorsAddResponse = WebAPICallResult & {
    error?: string;
    errors?: Error[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AdminWorkflowsCollaboratorsRemoveResponse

type AdminWorkflowsCollaboratorsRemoveResponse = WebAPICallResult & {
    error?: string;
    errors?: Error[];
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AdminWorkflowsPermissionsLookupResponse

type AdminWorkflowsPermissionsLookupResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    permissions?: {
        [key: string]: Permission;
    };
    provided?: string;
};

type AdminWorkflowsSearchArguments

type AdminWorkflowsSearchArguments = OptionalArgument<
    Partial<AppID> &
        Partial<CollaboratorIDs> &
        SortDir &
        TokenOverridable &
        CursorPaginationEnabled & {
            /** @description Only include workflows with no collaborators in the result; default is `false`. */
            no_collaborators?: boolean;
            /** @description Number of trigger IDs to fetch for each workflow; default is `0`. */
            num_trigger_ids?: number;
            /** @description A search query to filter for workflow name or description. */
            query?: string;
            /** @description The field used to sort the returned workflows. Currently only `premium_runs` is supported. */
            sort?: 'premium_runs';
            /** @description Source of workflow creation, either from `code` or `workflow_builder`. */
            source?: 'code' | 'workflow_builder';
        }
>;

type AdminWorkflowsSearchResponse

type AdminWorkflowsSearchResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    total_found?: number;
    workflows?: Workflow[];
};

type AdminWorkflowsUnpublishResponse

type AdminWorkflowsUnpublishResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type APITestArguments

type APITestArguments = OptionalArgument<{
    /** @description Error response to return. */
    error?: string;
}>;

type ApiTestResponse

type ApiTestResponse = WebAPICallResult & {
    args?: Args;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AppsConnectionsOpenArguments

type AppsConnectionsOpenArguments = OptionalArgument<object>;

type AppsConnectionsOpenResponse

type AppsConnectionsOpenResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    url?: string;
};

type AppsEventAuthorizationsListResponse

type AppsEventAuthorizationsListResponse = WebAPICallResult & {
    authorizations?: Authorization[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AppsManifestCreateResponse

type AppsManifestCreateResponse = WebAPICallResult & {
    app_id?: string;
    credentials?: Credentials;
    error?: string;
    errors?: Error[];
    needed?: string;
    oauth_authorize_url?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AppsManifestDeleteResponse

type AppsManifestDeleteResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AppsManifestExportResponse

type AppsManifestExportResponse = WebAPICallResult & {
    error?: string;
    manifest?: Manifest;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AppsManifestUpdateResponse

type AppsManifestUpdateResponse = WebAPICallResult & {
    app_id?: string;
    error?: string;
    needed?: string;
    ok?: boolean;
    permissions_updated?: boolean;
    provided?: string;
};

type AppsManifestValidateResponse

type AppsManifestValidateResponse = WebAPICallResult & {
    error?: string;
    errors?: Error[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AppsPermissionsInfoResponse

type AppsPermissionsInfoResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AppsPermissionsRequestResponse

type AppsPermissionsRequestResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AppsPermissionsResourcesListResponse

type AppsPermissionsResourcesListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AppsPermissionsScopesListResponse

type AppsPermissionsScopesListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AppsPermissionsUsersListResponse

type AppsPermissionsUsersListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AppsPermissionsUsersRequestResponse

type AppsPermissionsUsersRequestResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AppsUninstallResponse

type AppsUninstallResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type AssistantThreadsSetStatusResponse

type AssistantThreadsSetStatusResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    warning?: string;
};

type AssistantThreadsSetSuggestedPromptsResponse

type AssistantThreadsSetSuggestedPromptsResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    warning?: string;
};

type AssistantThreadsSetTitleResponse

type AssistantThreadsSetTitleResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    warning?: string;
};

type AuthRevokeArguments

type AuthRevokeArguments = OptionalArgument<
    TokenOverridable & {
        /**
         * @description Setting this parameter to `true` triggers a testing mode where the specified token
         * will not actually be revoked.
         */
        test?: boolean;
    }
>;

type AuthRevokeResponse

type AuthRevokeResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type AuthTeamsListArguments

type AuthTeamsListArguments = OptionalArgument<
    TokenOverridable &
        CursorPaginationEnabled & {
            /**
             * @description Whether to return icon paths for each workspace.
             * An icon path represents a URI pointing to the image signifying the workspace.
             * Defaults to `false`.
             */
            include_icon?: boolean;
        }
>;

type AuthTeamsListResponse

type AuthTeamsListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    teams?: Team[];
};

type AuthTestArguments

type AuthTestArguments = OptionalArgument<TokenOverridable>;

type AuthTestResponse

type AuthTestResponse = WebAPICallResult & {
    app_id?: string;
    app_name?: string;
    bot_id?: string;
    enterprise_id?: string;
    error?: string;
    expires_in?: number;
    is_enterprise_install?: boolean;
    needed?: string;
    ok?: boolean;
    provided?: string;
    team?: string;
    team_id?: string;
    url?: string;
    user?: string;
    user_id?: string;
};

type BookmarksAddResponse

type BookmarksAddResponse = WebAPICallResult & {
    bookmark?: Bookmark;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type BookmarksEditResponse

type BookmarksEditResponse = WebAPICallResult & {
    bookmark?: Bookmark;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type BookmarksListResponse

type BookmarksListResponse = WebAPICallResult & {
    bookmarks?: Bookmark[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type BookmarksRemoveResponse

type BookmarksRemoveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type BotsInfoArguments

type BotsInfoArguments = OptionalArgument<
    TokenOverridable &
        OptionalTeamAssignable & {
            /** @description Bot ID, which starts with 'B', to retrieve information about. */
            bot?: string;
        }
>;

type BotsInfoResponse

type BotsInfoResponse = WebAPICallResult & {
    bot?: Bot;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type CallsAddResponse

type CallsAddResponse = WebAPICallResult & {
    call?: Call;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type CallsEndResponse

type CallsEndResponse = WebAPICallResult & {
    call?: Call;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type CallsInfoResponse

type CallsInfoResponse = WebAPICallResult & {
    call?: Call;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type CallsParticipantsAddResponse

type CallsParticipantsAddResponse = WebAPICallResult & {
    call?: Call;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type CallsParticipantsRemoveResponse

type CallsParticipantsRemoveResponse = WebAPICallResult & {
    call?: Call;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type CallsUpdateResponse

type CallsUpdateResponse = WebAPICallResult & {
    call?: Call;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type CanvasesAccessDeleteResponse

type CanvasesAccessDeleteResponse = WebAPICallResult & {
    error?: string;
    failed_to_update_channel_ids?: string[];
    failed_to_update_user_ids?: string[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type CanvasesAccessSetResponse

type CanvasesAccessSetResponse = WebAPICallResult & {
    error?: string;
    failed_to_update_channel_ids?: string[];
    failed_to_update_user_ids?: string[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type CanvasesCreateArguments

type CanvasesCreateArguments = OptionalArgument<
    TokenOverridable & {
        /** @description Title of the newly created canvas. */
        title?: string;
        /** @description Structure describing the type and contents of the Canvas being created. */
        document_content?: DocumentContent;
    }
>;

type CanvasesCreateResponse

type CanvasesCreateResponse = WebAPICallResult & {
    canvas_id?: string;
    detail?: string;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type CanvasesDeleteResponse

type CanvasesDeleteResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type CanvasesEditResponse

type CanvasesEditResponse = WebAPICallResult & {
    detail?: string;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type CanvasesSectionsLookupResponse

type CanvasesSectionsLookupResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    sections?: Section[];
};

type ChannelsArchiveResponse

type ChannelsArchiveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChannelsCreateResponse

type ChannelsCreateResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChannelsHistoryResponse

type ChannelsHistoryResponse = WebAPICallResult & {
    channel_actions_count?: number;
    channel_actions_ts?: number;
    error?: string;
    has_more?: boolean;
    latest?: string;
    messages?: Message[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type ChannelsInfoResponse

type ChannelsInfoResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChannelsInviteResponse

type ChannelsInviteResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChannelsJoinResponse

type ChannelsJoinResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChannelsKickResponse

type ChannelsKickResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChannelsLeaveResponse

type ChannelsLeaveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChannelsListResponse

type ChannelsListResponse = WebAPICallResult & {
    channels?: Channel[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type ChannelsMarkResponse

type ChannelsMarkResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChannelsRenameResponse

type ChannelsRenameResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChannelsRepliesResponse

type ChannelsRepliesResponse = WebAPICallResult & {
    error?: string;
    has_more?: boolean;
    messages?: Message[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type ChannelsSetPurposeResponse

type ChannelsSetPurposeResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    purpose?: string;
};

type ChannelsSetTopicResponse

type ChannelsSetTopicResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    topic?: string;
};

type ChannelsUnarchiveResponse

type ChannelsUnarchiveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChatDeleteResponse

type ChatDeleteResponse = WebAPICallResult & {
    channel?: string;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    ts?: string;
};

type ChatDeleteScheduledMessageResponse

type ChatDeleteScheduledMessageResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChatGetPermalinkResponse

type ChatGetPermalinkResponse = WebAPICallResult & {
    channel?: string;
    error?: string;
    needed?: string;
    ok?: boolean;
    permalink?: string;
    provided?: string;
};

type ChatMeMessageResponse

type ChatMeMessageResponse = WebAPICallResult & {
    channel?: string;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    ts?: string;
};

type ChatPostEphemeralArguments

type ChatPostEphemeralArguments = TokenOverridable &
    MessageContents & {
        /**
         * @description `id` of the user who will receive the ephemeral message.
         * The user should be in the channel specified by the `channel` argument.
         */
        user: string;
    } & Authorship &
    Parse &
    LinkNames &
    Partial<ThreadTS>;

type ChatPostEphemeralResponse

type ChatPostEphemeralResponse = WebAPICallResult & {
    error?: string;
    message_ts?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChatPostMessageArguments

type ChatPostMessageArguments = TokenOverridable &
    MessageContents &
    ReplyInThread &
    Authorship &
    Parse &
    LinkNames &
    Metadata &
    Unfurls & {
        /** @description Disable Slack markup parsing by setting to `false`. Enabled by default. */
        mrkdwn?: boolean;
    };

type ChatPostMessageResponse

type ChatPostMessageResponse = WebAPICallResult & {
    channel?: string;
    deprecated_argument?: string;
    error?: string;
    errors?: string[];
    message?: ChatPostMessageResponseMessage;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    ts?: string;
};

type ChatScheduledMessagesListArguments

type ChatScheduledMessagesListArguments = OptionalArgument<
    TokenOverridable &
        CursorPaginationEnabled &
        OptionalTeamAssignable &
        Pick<TimelinePaginationEnabled, 'latest' | 'oldest'> &
        Partial<Channel>
>;

type ChatScheduledMessagesListResponse

type ChatScheduledMessagesListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    scheduled_messages?: ScheduledMessage[];
};

type ChatScheduleMessageArguments

type ChatScheduleMessageArguments = TokenOverridable &
    MessageContents & {
        /** @description Unix EPOCH timestamp of time in future to send the message. */
        post_at: string | number;
    } & ReplyInThread &
    Parse &
    LinkNames &
    AsUser &
    Metadata &
    Unfurls;

type ChatScheduleMessageResponse

type ChatScheduleMessageResponse = WebAPICallResult & {
    channel?: string;
    error?: string;
    message?: Message;
    needed?: string;
    ok?: boolean;
    post_at?: number;
    provided?: string;
    response_metadata?: ResponseMetadata;
    scheduled_message_id?: string;
};

type ChatUnfurlArguments

type ChatUnfurlArguments = {
    /**
     * @description URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl
     * blocks or message attachments.
     */
    unfurls: LinkUnfurls;
} & UnfurlTarget &
    TokenOverridable & {
        /**
         * @description Provide a simply-formatted string to send as an ephemeral message to the user as invitation to
         * authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again.
         */
        user_auth_message?: string;
        /**
         * @description Set to `true` to indicate the user must install your Slack app to trigger unfurls for this domain.
         * Defaults to `false`.
         */
        user_auth_required?: boolean;
        /**
         * @description Send users to this custom URL where they will complete authentication in your app to fully trigger
         * unfurling. Value should be properly URL-encoded.
         */
        user_auth_url?: string;
        /**
         * @description Provide a JSON based array of structured blocks presented as URL-encoded string to send as an
         * ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.
         */
        user_auth_blocks?: (KnownBlock | Block)[];
    };

type ChatUnfurlResponse

type ChatUnfurlResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ChatUpdateArguments

type ChatUpdateArguments = MessageContents & {
    /** @description Timestamp of the message to be updated. */
    ts: string;
} & TokenOverridable &
    AsUser &
    LinkNames &
    Metadata &
    Parse & {
        /** @description Array of new file ids that will be sent with this message. */
        file_ids?: string[];
        /** @description Broadcast an existing thread reply to make it visible to everyone in the channel or conversation. */
        reply_broadcast?: boolean;
    };

type ChatUpdateResponse

type ChatUpdateResponse = WebAPICallResult & {
    channel?: string;
    error?: string;
    message?: Message;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    text?: string;
    ts?: string;
};

type ConversationsAcceptSharedInviteArguments

type ConversationsAcceptSharedInviteArguments = TokenOverridable &
    OptionalTeamAssignable &
    (ChannelID | InviteID) &
    IsPrivate & {
        /**
         * @description Name of the channel. If the channel does not exist already in your workspace,
         * this name is the one that the channel will take.
         */
        channel_name: string;
        /** @description Whether you'd like to use your workspace's free trial to begin using Slack Connect. */
        free_trial_accepted?: boolean;
    };

type ConversationsAcceptSharedInviteResponse

type ConversationsAcceptSharedInviteResponse = WebAPICallResult & {
    can_open_scdm?: boolean;
    channel_id?: string;
    error?: string;
    implicit_approval?: boolean;
    invite_id?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsApproveSharedInviteResponse

type ConversationsApproveSharedInviteResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsArchiveResponse

type ConversationsArchiveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsCanvasesCreateResponse

type ConversationsCanvasesCreateResponse = WebAPICallResult & {
    canvas_id?: string;
    detail?: string;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type ConversationsCloseResponse

type ConversationsCloseResponse = WebAPICallResult & {
    already_closed?: boolean;
    error?: string;
    needed?: string;
    no_op?: boolean;
    ok?: boolean;
    provided?: string;
};

type ConversationsCreateResponse

type ConversationsCreateResponse = WebAPICallResult & {
    channel?: Channel;
    detail?: string;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsDeclineSharedInviteResponse

type ConversationsDeclineSharedInviteResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsExternalInvitePermissionsSetResponse

type ConversationsExternalInvitePermissionsSetResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsHistoryResponse

type ConversationsHistoryResponse = WebAPICallResult & {
    channel_actions_count?: number;
    channel_actions_ts?: number;
    error?: string;
    has_more?: boolean;
    messages?: MessageElement[];
    needed?: string;
    ok?: boolean;
    oldest?: string;
    pin_count?: number;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type ConversationsInfoResponse

type ConversationsInfoResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsInviteResponse

type ConversationsInviteResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    errors?: Error[];
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsInviteSharedArguments

type ConversationsInviteSharedArguments = Channel &
    TokenOverridable &
    (Emails | UserIDs) & {
        /** @description Whether invite is to an external limited member. Defaults to `true`. */
        external_limited?: boolean;
    };

type ConversationsInviteSharedResponse

type ConversationsInviteSharedResponse = WebAPICallResult & {
    conf_code?: string;
    error?: string;
    invite_id?: string;
    is_legacy_shared_channel?: boolean;
    needed?: string;
    ok?: boolean;
    provided?: string;
    url?: string;
};

type ConversationsJoinResponse

type ConversationsJoinResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type ConversationsKickResponse

type ConversationsKickResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsLeaveResponse

type ConversationsLeaveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsListArguments

type ConversationsListArguments = OptionalArgument<
    TokenOverridable &
        CursorPaginationEnabled &
        OptionalTeamAssignable & {
            /** @description Set to `true` to exclude archived channels from the list. Defaults to `false`. */
            exclude_archived?: boolean;
            /**
             * @description Mix and match channel types by providing a comma-separated list of any combination of:
             * `public_channel`, `private_channel`, `mpim` or `im`. Defaults to `public_channel`.
             */
            types?: string;
        }
>;

type ConversationsListConnectInvitesArguments

type ConversationsListConnectInvitesArguments = OptionalArgument<
    TokenOverridable &
        OptionalTeamAssignable & {
            /** @description Maximum number of invites to return. Defaults to `100`. */
            count?: number;
            /** @description Set to `next_cursor` returned by previous call to list items in subsequent page. */
            cursor?: string;
        }
>;

type ConversationsListConnectInvitesResponse

type ConversationsListConnectInvitesResponse = WebAPICallResult & {
    arg?: string;
    error?: string;
    invites?: InviteElement[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type ConversationsListResponse

type ConversationsListResponse = WebAPICallResult & {
    channels?: Channel[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type ConversationsMarkResponse

type ConversationsMarkResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsMembersResponse

type ConversationsMembersResponse = WebAPICallResult & {
    error?: string;
    members?: string[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type ConversationsOpenArguments

type ConversationsOpenArguments = (Channel | Users) &
    TokenOverridable & {
        /**
         * @description Do not create a direct message or multi-person direct message.
         * This is used to see if there is an existing dm or mpdm.
         */
        prevent_creation?: boolean;
        /** @description Indicates you want the full IM channel definition in the response. */
        return_im?: boolean;
    };

type ConversationsOpenResponse

type ConversationsOpenResponse = WebAPICallResult & {
    already_open?: boolean;
    channel?: Channel;
    error?: string;
    needed?: string;
    no_op?: boolean;
    ok?: boolean;
    provided?: string;
};

type ConversationsRenameResponse

type ConversationsRenameResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsRepliesResponse

type ConversationsRepliesResponse = WebAPICallResult & {
    error?: string;
    has_more?: boolean;
    messages?: MessageElement[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type ConversationsRequestSharedInviteApproveResponse

type ConversationsRequestSharedInviteApproveResponse = WebAPICallResult & {
    error?: string;
    invite_id?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsRequestSharedInviteDenyResponse

type ConversationsRequestSharedInviteDenyResponse = WebAPICallResult & {
    error?: string;
    invite_id?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsRequestSharedInviteListArguments

type ConversationsRequestSharedInviteListArguments = OptionalArgument<
    CursorPaginationEnabled &
        TokenOverridable & {
            /** @description When `true` approved invitation requests will be returned, otherwise they will be excluded. */
            include_approved?: boolean;
            /** @description When `true` denied invitation requests will be returned, otherwise they will be excluded. */
            include_denied?: boolean;
            /** @description When `true` expired invitation requests will be returned, otherwise they will be excluded. */
            include_expired?: boolean;
            /** @description An optional list of invitation ids to look up. */
            invite_ids?: string[];
            /** @description Optional filter to return invitation requests for the inviting user. */
            user_id?: string;
        }
>;

type ConversationsRequestSharedInviteListResponse

type ConversationsRequestSharedInviteListResponse = WebAPICallResult & {
    error?: string;
    invite_requests?: InviteRequest[];
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsSetPurposeResponse

type ConversationsSetPurposeResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsSetTopicResponse

type ConversationsSetTopicResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ConversationsUnarchiveResponse

type ConversationsUnarchiveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type DialogOpenResponse

type DialogOpenResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type DndEndDndArguments

type DndEndDndArguments = OptionalArgument<TokenOverridable>;

type DndEndDndResponse

type DndEndDndResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type DndEndSnoozeArguments

type DndEndSnoozeArguments = OptionalArgument<TokenOverridable>;

type DndEndSnoozeResponse

type DndEndSnoozeResponse = WebAPICallResult & {
    dnd_enabled?: boolean;
    error?: string;
    needed?: string;
    next_dnd_end_ts?: number;
    next_dnd_start_ts?: number;
    ok?: boolean;
    provided?: string;
    snooze_enabled?: boolean;
};

type DndInfoArguments

type DndInfoArguments = OptionalArgument<
    TokenOverridable &
        OptionalTeamAssignable & {
            /** @description User to fetch status for (defaults to authed user). */
            user?: string;
        }
>;

type DndInfoResponse

type DndInfoResponse = WebAPICallResult & {
    dnd_enabled?: boolean;
    error?: string;
    needed?: string;
    next_dnd_end_ts?: number;
    next_dnd_start_ts?: number;
    ok?: boolean;
    provided?: string;
};

type DndSetSnoozeResponse

type DndSetSnoozeResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    snooze_enabled?: boolean;
    snooze_endtime?: number;
    snooze_is_indefinite?: boolean;
    snooze_remaining?: number;
};

type DndTeamInfoResponse

type DndTeamInfoResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    users?: {
        [key: string]: User;
    };
};

type EmojiListArguments

type EmojiListArguments = OptionalArgument<
    TokenOverridable & {
        /** @description Include a list of categories for Unicode emoji and the emoji in each category. */
        include_categories?: boolean;
    }
>;

type EmojiListResponse

type EmojiListResponse = WebAPICallResult & {
    cache_ts?: string;
    categories?: Category[];
    categories_version?: string;
    emoji?: {
        [key: string]: string;
    };
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesCommentsAddResponse

type FilesCommentsAddResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    req_method?: string;
};

type FilesCommentsDeleteResponse

type FilesCommentsDeleteResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesCommentsEditResponse

type FilesCommentsEditResponse = WebAPICallResult & {
    comment?: Comment;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesCompleteUploadExternalArguments

type FilesCompleteUploadExternalArguments = FileDestinationArgument &
    TokenOverridable & {
        /** @description Array of file IDs and their corresponding (optional) titles. */
        files: [FileUploadComplete, ...FileUploadComplete[]];
        /** @description The message text introducing the file in the specified channel. */
        initial_comment?: string;
    };

type FilesCompleteUploadExternalResponse

type FilesCompleteUploadExternalResponse = WebAPICallResult & {
    error?: string;
    files?: File[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type FilesDeleteResponse

type FilesDeleteResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesGetUploadURLExternalResponse

type FilesGetUploadURLExternalResponse = WebAPICallResult & {
    error?: string;
    file_id?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    upload_url?: string;
};

type FilesInfoResponse

type FilesInfoResponse = WebAPICallResult & {
    comments?: Comment[];
    content?: string;
    content_highlight_css?: string;
    content_highlight_html?: string;
    content_highlight_html_truncated?: boolean;
    error?: string;
    file?: File;
    is_truncated?: boolean;
    needed?: string;
    ok?: boolean;
    paging?: Paging;
    provided?: string;
};

type FilesListResponse

type FilesListResponse = WebAPICallResult & {
    error?: string;
    files?: File[];
    needed?: string;
    ok?: boolean;
    paging?: Paging;
    provided?: string;
};

type FilesRemoteAddResponse

type FilesRemoteAddResponse = WebAPICallResult & {
    error?: string;
    file?: File;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesRemoteInfoArguments

type FilesRemoteInfoArguments = FileOrExternalID & TokenOverridable;

type FilesRemoteInfoResponse

type FilesRemoteInfoResponse = WebAPICallResult & {
    error?: string;
    file?: File;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesRemoteListResponse

type FilesRemoteListResponse = WebAPICallResult & {
    error?: string;
    files?: File[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type FilesRemoteRemoveArguments

type FilesRemoteRemoveArguments = FileOrExternalID & TokenOverridable;

type FilesRemoteRemoveResponse

type FilesRemoteRemoveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesRemoteShareArguments

type FilesRemoteShareArguments = Required<ChannelsArgument> &
    FileOrExternalID &
    TokenOverridable;

type FilesRemoteShareResponse

type FilesRemoteShareResponse = WebAPICallResult & {
    error?: string;
    file?: File;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesRemoteUpdateArguments

type FilesRemoteUpdateArguments = Partial<SharedFile> &
    FileOrExternalID &
    FileType &
    TokenOverridable;

type FilesRemoteUpdateResponse

type FilesRemoteUpdateResponse = WebAPICallResult & {
    error?: string;
    file?: File;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesRevokePublicURLResponse

type FilesRevokePublicURLResponse = WebAPICallResult & {
    error?: string;
    file?: File;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesSharedPublicURLResponse

type FilesSharedPublicURLResponse = WebAPICallResult & {
    error?: string;
    file?: File;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesUploadArguments

type FilesUploadArguments = FileUpload & TokenOverridable;

type FilesUploadResponse

type FilesUploadResponse = WebAPICallResult & {
    error?: string;
    file?: File;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FilesUploadV2Arguments

type FilesUploadV2Arguments = TokenOverridable &
    (
        | FileUploadV2
        | (Omit<FileUploadV2, 'file' | 'content'> &
              FilesUploadV2ArgumentsMultipleFiles)
    );

type FunctionsCompleteErrorResponse

type FunctionsCompleteErrorResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type FunctionsCompleteSuccessResponse

type FunctionsCompleteSuccessResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type GroupsArchiveResponse

type GroupsArchiveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsCloseResponse

type GroupsCloseResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type GroupsCreateChildResponse

type GroupsCreateChildResponse = WebAPICallResult & {
    error?: string;
    group?: Group;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsCreateResponse

type GroupsCreateResponse = WebAPICallResult & {
    error?: string;
    group?: Group;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsHistoryResponse

type GroupsHistoryResponse = WebAPICallResult & {
    channel_actions_count?: number;
    error?: string;
    has_more?: boolean;
    messages?: Message[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsInfoResponse

type GroupsInfoResponse = WebAPICallResult & {
    error?: string;
    group?: Group;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsInviteResponse

type GroupsInviteResponse = WebAPICallResult & {
    error?: string;
    group?: Group;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsKickResponse

type GroupsKickResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsLeaveResponse

type GroupsLeaveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsListResponse

type GroupsListResponse = WebAPICallResult & {
    error?: string;
    groups?: Group[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsMarkResponse

type GroupsMarkResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsOpenResponse

type GroupsOpenResponse = WebAPICallResult & {
    already_open?: boolean;
    error?: string;
    needed?: string;
    no_op?: boolean;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsRenameResponse

type GroupsRenameResponse = WebAPICallResult & {
    channel?: Channel;
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsRepliesResponse

type GroupsRepliesResponse = WebAPICallResult & {
    error?: string;
    has_more?: boolean;
    messages?: Message[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsSetPurposeResponse

type GroupsSetPurposeResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    purpose?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type GroupsSetTopicResponse

type GroupsSetTopicResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    topic?: string;
    warning?: string;
};

type GroupsUnarchiveResponse

type GroupsUnarchiveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type ImCloseResponse

type ImCloseResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type ImHistoryResponse

type ImHistoryResponse = WebAPICallResult & {
    channel_actions_count?: number;
    error?: string;
    has_more?: boolean;
    messages?: Message[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type ImListResponse

type ImListResponse = WebAPICallResult & {
    error?: string;
    ims?: Im[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type ImMarkResponse

type ImMarkResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type ImOpenResponse

type ImOpenResponse = WebAPICallResult & {
    already_open?: boolean;
    channel?: Channel;
    error?: string;
    needed?: string;
    no_op?: boolean;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type ImRepliesResponse

type ImRepliesResponse = WebAPICallResult & {
    error?: string;
    has_more?: boolean;
    messages?: Message[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type Method

type MethodWithOptionalArgument<
    MethodArguments,
    MethodResult extends WebAPICallResult = WebAPICallResult
> = (options?: MethodArguments) => Promise<MethodResult>;

type MigrationExchangeResponse

type MigrationExchangeResponse = WebAPICallResult & {
    enterprise_id?: string;
    error?: string;
    invalid_user_ids?: string[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    team_id?: string;
    user_id_map?: {
        [key: string]: string;
    };
    warning?: string;
};

type MpimCloseResponse

type MpimCloseResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type MpimHistoryResponse

type MpimHistoryResponse = WebAPICallResult & {
    channel_actions_count?: number;
    error?: string;
    has_more?: boolean;
    messages?: Message[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type MpimListResponse

type MpimListResponse = WebAPICallResult & {
    error?: string;
    groups?: Group[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type MpimMarkResponse

type MpimMarkResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type MpimOpenResponse

type MpimOpenResponse = WebAPICallResult & {
    error?: string;
    group?: Group;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type MpimRepliesResponse

type MpimRepliesResponse = WebAPICallResult & {
    error?: string;
    has_more?: boolean;
    messages?: Message[];
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    warning?: string;
};

type OauthAccessResponse

type OauthAccessResponse = WebAPICallResult & {
    access_token?: string;
    authorizing_user?: User;
    bot?: Bot;
    enterprise_id?: string;
    error?: string;
    incoming_webhook?: IncomingWebhook;
    installer_user?: User;
    needed?: string;
    ok?: boolean;
    provided?: string;
    scope?: string;
    scopes?: Scopes;
    team_id?: string;
    team_name?: string;
    token_type?: string;
    user_id?: string;
    warning?: string;
};

type OauthTokenResponse

type OauthTokenResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    req_method?: string;
};

type OauthV2AccessResponse

type OauthV2AccessResponse = WebAPICallResult & {
    access_token?: string;
    app_id?: string;
    authed_user?: AuthedUser;
    bot_user_id?: string;
    enterprise?: Enterprise;
    error?: string;
    expires_in?: number;
    incoming_webhook?: IncomingWebhook;
    is_enterprise_install?: boolean;
    needed?: string;
    ok?: boolean;
    provided?: string;
    refresh_token?: string;
    scope?: string;
    team?: Enterprise;
    token_type?: string;
    warning?: string;
};

type OauthV2ExchangeResponse

type OauthV2ExchangeResponse = WebAPICallResult & {
    access_token?: string;
    app_id?: string;
    authed_user?: AuthedUser;
    bot_user_id?: string;
    enterprise?: Enterprise;
    error?: string;
    expires_in?: number;
    incoming_webhook?: IncomingWebhook;
    is_enterprise_install?: boolean;
    needed?: string;
    ok?: boolean;
    provided?: string;
    refresh_token?: string;
    response_metadata?: ResponseMetadata;
    scope?: string;
    team?: Enterprise;
    token_type?: string;
    warning?: string;
};

type OpenIDConnectTokenResponse

type OpenIDConnectTokenResponse = WebAPICallResult & {
    access_token?: string;
    error?: string;
    expires_in?: number;
    id_token?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    refresh_token?: string;
    token_type?: string;
    warning?: string;
};

type OpenIDConnectUserInfoArguments

type OpenIDConnectUserInfoArguments = OptionalArgument<object>;

type OpenIDConnectUserInfoResponse

type OpenIDConnectUserInfoResponse = WebAPICallResult & {
    date_email_verified?: number;
    email?: string;
    email_verified?: boolean;
    error?: string;
    family_name?: string;
    given_name?: string;
    'https://slack.com/enterprise_domain'?: string;
    'https://slack.com/enterprise_id'?: string;
    'https://slack.com/enterprise_name'?: string;
    'https://slack.com/team_domain'?: string;
    'https://slack.com/team_id'?: string;
    'https://slack.com/team_image_102'?: string;
    'https://slack.com/team_image_132'?: string;
    'https://slack.com/team_image_230'?: string;
    'https://slack.com/team_image_34'?: string;
    'https://slack.com/team_image_44'?: string;
    'https://slack.com/team_image_68'?: string;
    'https://slack.com/team_image_88'?: string;
    'https://slack.com/team_name'?: string;
    'https://slack.com/user_id'?: string;
    'https://slack.com/user_image_1024'?: string;
    'https://slack.com/user_image_192'?: string;
    'https://slack.com/user_image_24'?: string;
    'https://slack.com/user_image_32'?: string;
    'https://slack.com/user_image_48'?: string;
    'https://slack.com/user_image_512'?: string;
    'https://slack.com/user_image_72'?: string;
    locale?: string;
    name?: string;
    needed?: string;
    ok?: boolean;
    picture?: string;
    provided?: string;
    sub?: string;
    warning?: string;
};

type PageAccumulator

type PageAccumulator<R extends PageReducer> = R extends (
    accumulator: infer A | undefined,
    page: WebAPICallResult,
    index: number
) => infer A
    ? A
    : never;

type PageReducer

type PageReducer<A = any> = (
    accumulator: A | undefined,
    page: WebAPICallResult,
    index: number
) => A;

type PaginatePredicate

type PaginatePredicate = (page: WebAPICallResult) => boolean | undefined | undefined;

type PinsAddResponse

type PinsAddResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type PinsListResponse

type PinsListResponse = WebAPICallResult & {
    error?: string;
    items?: Item[];
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type PinsRemoveResponse

type PinsRemoveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ReactionsAddResponse

type ReactionsAddResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ReactionsGetArguments

type ReactionsGetArguments = ReactionsFull &
    TokenOverridable &
    (MessageArgument | FileArgument | FileCommentArgument);

type ReactionsGetResponse

type ReactionsGetResponse = WebAPICallResult & {
    channel?: string;
    error?: string;
    message?: Message;
    needed?: string;
    ok?: boolean;
    provided?: string;
    type?: string;
};

type ReactionsListArguments

type ReactionsListArguments = OptionalArgument<
    ReactionsFull &
        TokenOverridable &
        TraditionalPagingEnabled &
        CursorPaginationEnabled &
        OptionalTeamAssignable & {
            /** @description Show reactions made by this user. Defaults to the authed user. */
            user?: string;
        }
>;

type ReactionsListResponse

type ReactionsListResponse = WebAPICallResult & {
    error?: string;
    items?: Item[];
    needed?: string;
    ok?: boolean;
    paging?: Paging;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type ReactionsRemoveArguments

type ReactionsRemoveArguments = TokenOverridable &
    ReactionName &
    (MessageArgument | FileArgument | FileCommentArgument);

type ReactionsRemoveResponse

type ReactionsRemoveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type RemindersAddResponse

type RemindersAddResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    reminder?: Reminder;
    response_metadata?: ResponseMetadata;
};

type RemindersCompleteResponse

type RemindersCompleteResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type RemindersDeleteResponse

type RemindersDeleteResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type RemindersInfoResponse

type RemindersInfoResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    reminder?: Reminder;
};

type RemindersListArguments

type RemindersListArguments = OptionalArgument<
    TokenOverridable & OptionalTeamAssignable
>;

type RemindersListResponse

type RemindersListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    reminders?: Reminder[];
};

type RTMConnectArguments

type RTMConnectArguments = OptionalArgument<
    TokenOverridable & {
        /**
         * @description Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events.
         * @see {@link https://api.slack.com/docs/presence-and-status#batching batch presence}.
         */
        batch_presence_aware?: boolean;
        /**
         * @description Only deliver presence events when requested by subscription.
         * @see {@link Only deliver presence events when requested by subscription. presence subscriptions}.
         */
        presence_sub?: boolean;
    }
>;

type RtmConnectResponse

type RtmConnectResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    self?: Self;
    team?: Team;
    url?: string;
};

type RTMStartArguments

type RTMStartArguments = OptionalArgument<
    RTMConnectArguments &
        LocaleAware & {
            /** @description Returns MPIMs to the client in the API response. */
            mpim_aware?: boolean;
            /**
             * @description Exclude latest timestamps for channels, groups, mpims, and ims.
             * Automatically sets `no_unreads` to `true`.
             */
            no_latest?: boolean;
            /** @description Skip unread counts for each channel (improves performance). */
            no_unreads?: boolean;
            /** @description Return timestamp only for latest message object of each channel (improves performance). */
            simple_latest?: boolean;
        }
>;

type RtmStartResponse

type RtmStartResponse = WebAPICallResult & {
    accept_tos_url?: string;
    bots?: Bot[];
    cache_ts?: number;
    cache_ts_version?: string;
    cache_version?: string;
    can_manage_shared_channels?: boolean;
    channels?: Channel[];
    dnd?: Dnd;
    error?: string;
    groups?: Group[];
    ims?: Im[];
    is_europe?: boolean;
    latest_event_ts?: string;
    links?: Links;
    mobile_app_requires_upgrade?: boolean;
    needed?: string;
    non_threadable_channels?: string[];
    ok?: boolean;
    provided?: string;
    read_only_channels?: string[];
    response_metadata?: ResponseMetadata;
    self?: Self;
    subteams?: Subteams;
    team?: Team;
    thread_only_channels?: string[];
    url?: string;
    users?: User[];
};

type SearchAllResponse

type SearchAllResponse = WebAPICallResult & {
    error?: string;
    files?: Files;
    messages?: Messages;
    needed?: string;
    ok?: boolean;
    posts?: Posts;
    provided?: string;
    query?: string;
};

type SearchFilesResponse

type SearchFilesResponse = WebAPICallResult & {
    error?: string;
    files?: Files;
    needed?: string;
    ok?: boolean;
    provided?: string;
    query?: string;
};

type SearchMessagesResponse

type SearchMessagesResponse = WebAPICallResult & {
    error?: string;
    messages?: Messages;
    needed?: string;
    ok?: boolean;
    provided?: string;
    query?: string;
};

type StarsAddRemoveArguments

type StarsAddRemoveArguments = TokenOverridable &
    (StarsChannelDestination | MessageArgument | FileArgument | FileCommentArgument);

type StarsAddResponse

type StarsAddResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type StarsListResponse

type StarsListResponse = WebAPICallResult & {
    error?: string;
    items?: Item[];
    needed?: string;
    ok?: boolean;
    paging?: Paging;
    provided?: string;
};

type StarsRemoveResponse

type StarsRemoveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type TeamAccessLogsArguments

type TeamAccessLogsArguments = OptionalArgument<
    TokenOverridable &
        CursorPaginationEnabled &
        TraditionalPagingEnabled &
        OptionalTeamAssignable & {
            /**
             * @description End of time range of logs to include in results (inclusive) as a UNIX timestamp in seconds.
             * Default to now.
             */
            before?: number;
        }
>;

type TeamAccessLogsResponse

type TeamAccessLogsResponse = WebAPICallResult & {
    error?: string;
    logins?: Login[];
    needed?: string;
    ok?: boolean;
    paging?: Paging;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type TeamBillableInfoArguments

type TeamBillableInfoArguments = OptionalArgument<
    TokenOverridable &
        CursorPaginationEnabled &
        OptionalTeamAssignable & {
            /** @description A user to retrieve the billable information for. Defaults to all users. */
            user?: string;
        }
>;

type TeamBillableInfoResponse

type TeamBillableInfoResponse = WebAPICallResult & {
    billable_info?: {
        [key: string]: BillableInfo;
    };
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type TeamBillingInfoArguments

type TeamBillingInfoArguments = OptionalArgument<TokenOverridable>;

type TeamBillingInfoResponse

type TeamBillingInfoResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    plan?: string;
    provided?: string;
};

type TeamExternalTeamsDisconnectArguments

type TeamExternalTeamsDisconnectArguments = TokenOverridable & Required<TargetTeam>;

type TeamExternalTeamsDisconnectResponse

type TeamExternalTeamsDisconnectResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type TeamExternalTeamsListArguments

type TeamExternalTeamsListArguments = OptionalArgument<
    TokenOverridable &
        CursorPaginationEnabled & {
            /** @description Status of the connected team. */
            connection_status_filter?:
                | 'CONNECTED'
                | 'DISCONNECTED'
                | 'BLOCKED'
                | 'IN_REVIEW';
            /** @description Filters connected orgs by Slack Connect pref override(s) */
            slack_connect_pref_filter?:
                | 'approved_orgs_only'
                | 'allow_sc_file_uploads'
                | 'profile_visibility'
                | 'away_team_sc_invite_permissions'
                | 'accept_sc_invites'
                | 'sc_mpdm_to_private'
                | 'require_sc_channel_for_sc_dm'
                | 'external_awareness_context_bar';
            /** @description Direction to sort in asc or desc. */
            sort_direction?: SortDir['sort_dir'];
            /** @description Name of the parameter that we are sorting by. Defaults to `team_name`. */
            sort_field?: 'team_name' | 'last_active_timestamp' | 'connection_status';
            /** @description Shows connected orgs which are connected on a specified encoded workspace ID. */
            workspace_filter?: string[];
        }
>;

type TeamExternalTeamsListResponse

type TeamExternalTeamsListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    organizations?: Organization[];
    provided?: string;
    response_metadata?: ResponseMetadata;
    total_count?: number;
};

type TeamInfoArguments

type TeamInfoArguments = OptionalArgument<
    TokenOverridable & {
        /**
         * @description Query by domain instead of team (only when `team` is null). This only works for domains in the same
         * enterprise as the querying team token.
         * This also expects the domain to belong to a team and not the enterprise itself.
         */
        domain?: string;
        /** @description Team to get info about; if omitted, will return information about the current team. */
        team?: string;
    }
>;

type TeamInfoResponse

type TeamInfoResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    team?: Team;
};

type TeamIntegrationLogsArguments

type TeamIntegrationLogsArguments = OptionalArgument<
    Partial<AppID> &
        TokenOverridable &
        OptionalTeamAssignable &
        TraditionalPagingEnabled & {
            /** @description Filter logs with this change type. Defaults to all logs. */
            change_type?: 'added' | 'removed' | 'enabled' | 'disabled' | 'updated';
            /** @description Filter logs to this service. Defaults to all logs. */
            service_id?: string;
            /** @description Filter logs generated by this user’s actions. Defaults to all logs. */
            user?: string;
        }
>;

type TeamIntegrationLogsResponse

type TeamIntegrationLogsResponse = WebAPICallResult & {
    error?: string;
    logs?: Log[];
    needed?: string;
    ok?: boolean;
    paging?: Paging;
    provided?: string;
};

type TeamPreferencesListArguments

type TeamPreferencesListArguments = OptionalArgument<TokenOverridable>;

type TeamPreferencesListResponse

type TeamPreferencesListResponse = WebAPICallResult & {
    allow_message_deletion?: boolean;
    disable_file_uploads?: string;
    display_real_names?: boolean;
    error?: string;
    msg_edit_window_mins?: number;
    needed?: string;
    ok?: boolean;
    provided?: string;
    who_can_post_general?: string;
};

type TeamProfileGetArguments

type TeamProfileGetArguments = OptionalArgument<
    TokenOverridable & {
        /** @description Filter by visibility. */
        visibility?: 'all' | 'visible' | 'hidden';
    }
>;

type TeamProfileGetResponse

type TeamProfileGetResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    profile?: Profile;
    provided?: string;
};

type TLSOptions

type TLSOptions = Pick<
    SecureContextOptions,
    'pfx' | 'key' | 'passphrase' | 'cert' | 'ca'
>;

type ToolingTokensRotateResponse

type ToolingTokensRotateResponse = WebAPICallResult & {
    error?: string;
    exp?: number;
    iat?: number;
    needed?: string;
    ok?: boolean;
    provided?: string;
    refresh_token?: string;
    response_metadata?: ResponseMetadata;
    team_id?: string;
    token?: string;
    user_id?: string;
};

type UsergroupsCreateResponse

type UsergroupsCreateResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    usergroup?: Usergroup;
};

type UsergroupsDisableResponse

type UsergroupsDisableResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    usergroup?: Usergroup;
};

type UsergroupsEnableResponse

type UsergroupsEnableResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    usergroup?: Usergroup;
};

type UsergroupsListArguments

type UsergroupsListArguments = OptionalArgument<
    TokenOverridable &
        OptionalTeamAssignable &
        UsergroupsIncludeCount & {
            /** @description Include disabled User Groups. */
            include_disabled?: boolean;
            /** @description Include the list of users for each User Group. */
            include_users?: boolean;
        }
>;

type UsergroupsListResponse

type UsergroupsListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    usergroups?: Usergroup[];
};

type UsergroupsUpdateResponse

type UsergroupsUpdateResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    usergroup?: Usergroup;
};

type UsergroupsUsersListResponse

type UsergroupsUsersListResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    users?: string[];
};

type UsergroupsUsersUpdateResponse

type UsergroupsUsersUpdateResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    usergroup?: Usergroup;
};

type UsersConversationsResponse

type UsersConversationsResponse = WebAPICallResult & {
    channels?: Channel[];
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type UsersDeletePhotoResponse

type UsersDeletePhotoResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type UsersDiscoverableContactsLookupResponse

type UsersDiscoverableContactsLookupResponse = WebAPICallResult & {
    error?: string;
    is_discoverable?: boolean;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type UsersGetPresenceResponse

type UsersGetPresenceResponse = WebAPICallResult & {
    auto_away?: boolean;
    connection_count?: number;
    error?: string;
    last_activity?: number;
    manual_away?: boolean;
    needed?: string;
    ok?: boolean;
    online?: boolean;
    presence?: string;
    provided?: string;
    warning?: string;
};

type UsersIdentityResponse

type UsersIdentityResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    team?: Team;
    user?: User;
    warning?: string;
};

type UsersInfoResponse

type UsersInfoResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    user?: User;
};

type UsersListResponse

type UsersListResponse = WebAPICallResult & {
    arg?: string;
    cache_ts?: number;
    error?: string;
    members?: Member[];
    needed?: string;
    offset?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
};

type UsersLookupByEmailResponse

type UsersLookupByEmailResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    user?: User;
};

type UsersProfileGetResponse

type UsersProfileGetResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    profile?: Profile;
    provided?: string;
};

type UsersProfileSetResponse

type UsersProfileSetResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    profile?: Profile;
    provided?: string;
    username?: string;
};

type UsersSetActiveResponse

type UsersSetActiveResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type UsersSetPhotoResponse

type UsersSetPhotoResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    profile?: Profile;
    provided?: string;
};

type UsersSetPresenceResponse

type UsersSetPresenceResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type ViewsOpenArguments

type ViewsOpenArguments = BaseViewsArguments &
    TokenOverridable &
    (ViewTriggerId | ViewInteractivityPointer);

type ViewsOpenResponse

type ViewsOpenResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    view?: View;
    warning?: string;
};

type ViewsPublishResponse

type ViewsPublishResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    view?: View;
    warning?: string;
};

type ViewsPushArguments

type ViewsPushArguments = BaseViewsArguments &
    TokenOverridable &
    (ViewTriggerId | ViewInteractivityPointer);

type ViewsPushResponse

type ViewsPushResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    view?: View;
    warning?: string;
};

type ViewsUpdateArguments

type ViewsUpdateArguments = BaseViewsArguments &
    TokenOverridable &
    (ViewExternalId | ViewViewId) &
    ViewHash;

type ViewsUpdateResponse

type ViewsUpdateResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
    response_metadata?: ResponseMetadata;
    view?: View;
    warning?: string;
};

type WebAPICallError

type WebAPICallError =
    | WebAPIPlatformError
    | WebAPIRequestError
    | WebAPIHTTPError
    | WebAPIRateLimitedError;

type WorkflowsStepCompletedResponse

type WorkflowsStepCompletedResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type WorkflowsStepFailedResponse

type WorkflowsStepFailedResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

type WorkflowsUpdateStepResponse

type WorkflowsUpdateStepResponse = WebAPICallResult & {
    error?: string;
    needed?: string;
    ok?: boolean;
    provided?: string;
};

Package Files (357)

Dependencies (12)

Dev Dependencies (17)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@slack/web-api.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@slack/web-api)

HTML

<a href="https://www.jsdocs.io/package/@slack/web-api"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 25 days ago.
Package analyzed in 12431 ms.
Missing or incorrect documentation? Open an issue for this package.

@slack/web-api

Install

Overview

Index

Variables

Functions

Classes

Interfaces

Enums

Type Aliases

Variables

variable retryPolicies

Functions

function addAppMetadata

Parameter

Parameter

Classes

class Methods

constructor

property admin

property api

property apps

property assistant

property auth

property bookmarks

property bots

property calls

property canvases

property chat

property conversations

property dialog

property dnd

property emoji

property files

property functions

property migration

property oauth

property openid

property pins

property reactions

property reminders

property rtm

property search

property stars

property team

property tooling

property usergroups

property users

property views

property workflows

method apiCall

method filesUploadV2

class WebClient

constructor

Parameter token

Parameter webClientOptions

Parameter

Parameter

property slackApiUrl

property token

method apiCall

Parameter method

Parameter options

method filesUploadV2

Parameter options

method paginate

Parameter method

Parameter options

Parameter shouldStop

Parameter reduce

Interfaces

interface AdminAnalyticsMemberDetails

property channel_messages_posted_count

property date

property date_claimed

property email_address

property enterprise_id

property files_added_count

property is_active

property is_active_android