@slack/web-api

  • Version 7.0.2
  • Published
  • 2.31 MB
  • 11 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

Functions

Classes

Interfaces

Enums

Type Aliases

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

        property api

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

          property apps

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

            property auth

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

              property bookmarks

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

                property bots

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

                  property calls

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

                    property chat

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

                      property conversations

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

                        property dialog

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

                          property dnd

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

                            property emoji

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

                              property files

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

                                property functions

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

                                  property migration

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

                                    property oauth

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

                                      property openid

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

                                        property pins

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

                                          property reactions

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

                                            property reminders

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

                                              property rtm

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

                                                property search

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

                                                  property stars

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

                                                    property team

                                                    readonly team: {
                                                    accessLogs: Method<TeamAccessLogsArguments, TeamAccessLogsResponse>;
                                                    billableInfo: Method<TeamBillableInfoArguments, TeamBillableInfoResponse>;
                                                    billing: { info: Method<TeamBillingInfoArguments, TeamBillingInfoResponse> };
                                                    info: Method<TeamInfoArguments, TeamInfoResponse>;
                                                    integrationLogs: Method<
                                                    TeamIntegrationLogsArguments,
                                                    TeamIntegrationLogsResponse
                                                    >;
                                                    preferences: {
                                                    list: Method<TeamPreferencesListArguments, TeamPreferencesListResponse>;
                                                    };
                                                    profile: { get: Method<TeamProfileGetArguments, TeamProfileGetResponse> };
                                                    };

                                                      property tooling

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

                                                        property usergroups

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

                                                          property users

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

                                                            property views

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

                                                              property workflows

                                                              readonly workflows: {
                                                              stepCompleted: Method<
                                                              WorkflowsStepCompletedArguments,
                                                              WorkflowsStepCompletedResponse
                                                              >;
                                                              stepFailed: Method<
                                                              WorkflowsStepFailedArguments,
                                                              WorkflowsStepFailedResponse
                                                              >;
                                                              updateStep: Method<
                                                              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,
                                                                    }?: WebClientOptions
                                                                    );
                                                                    • Parameter token

                                                                      An API token to authenticate/authorize with Slack (usually start with xoxp, xoxb)

                                                                    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>;

                                                                    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 AdminAppsActivitiesListArguments

                                                                                                                                                                        interface AdminAppsActivitiesListArguments
                                                                                                                                                                        extends Partial<AppID>,
                                                                                                                                                                        Partial<TeamID>,
                                                                                                                                                                        TokenOverridable,
                                                                                                                                                                        CursorPaginationEnabled {}

                                                                                                                                                                          property component_id

                                                                                                                                                                          component_id?: string;
                                                                                                                                                                          • The component ID of log events to be returned. Will be FnXXXXXX for functions, and WfXXXXXX for worflows.

                                                                                                                                                                          property component_type

                                                                                                                                                                          component_type?: 'events_api' | 'workflows' | 'functions' | 'tables';
                                                                                                                                                                          • The component type of log events to be returned.

                                                                                                                                                                          property log_event_type

                                                                                                                                                                          log_event_type?: string;
                                                                                                                                                                          • The event type of log events to be returned.

                                                                                                                                                                          property max_date_created

                                                                                                                                                                          max_date_created?: number;
                                                                                                                                                                          • The latest timestamp of the log to retrieve (epoch microseconds).

                                                                                                                                                                          property min_date_created

                                                                                                                                                                          min_date_created?: number;
                                                                                                                                                                          • The earliest timestamp of the log to retrieve (epoch microseconds).

                                                                                                                                                                          property min_log_level

                                                                                                                                                                          min_log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';
                                                                                                                                                                          • The minimum log level of the log events to be returned. Defaults to info.

                                                                                                                                                                          property sort_direction

                                                                                                                                                                          sort_direction?: 'asc' | 'desc';
                                                                                                                                                                          • The direction you want the data sorted by (always by timestamp).

                                                                                                                                                                          property source

                                                                                                                                                                          source?: 'slack' | 'developer';
                                                                                                                                                                          • The source of log events to be returned.

                                                                                                                                                                          property trace_id

                                                                                                                                                                          trace_id?: string;
                                                                                                                                                                          • The trace ID of log events to be returned.

                                                                                                                                                                          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 AdminBarriersListArguments

                                                                                                                                                                                        interface AdminBarriersListArguments
                                                                                                                                                                                        extends TokenOverridable,
                                                                                                                                                                                        CursorPaginationEnabled {}

                                                                                                                                                                                          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 AdminConversationsEKMListOriginalConnectedChannelInfoArguments

                                                                                                                                                                                                            interface AdminConversationsEKMListOriginalConnectedChannelInfoArguments
                                                                                                                                                                                                            extends Partial<TeamIDs>,
                                                                                                                                                                                                            TokenOverridable,
                                                                                                                                                                                                            CursorPaginationEnabled {}

                                                                                                                                                                                                              property channel_ids

                                                                                                                                                                                                              channel_ids?: string[];
                                                                                                                                                                                                              • A comma-separated list of channels to filter to.

                                                                                                                                                                                                              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 AdminConversationsSearchArguments

                                                                                                                                                                                                                                  interface AdminConversationsSearchArguments
                                                                                                                                                                                                                                  extends SortDir,
                                                                                                                                                                                                                                  Partial<TeamIDs>,
                                                                                                                                                                                                                                  TokenOverridable,
                                                                                                                                                                                                                                  CursorPaginationEnabled {}

                                                                                                                                                                                                                                    property connected_team_ids

                                                                                                                                                                                                                                    connected_team_ids?: string[];
                                                                                                                                                                                                                                    • Array of encoded team IDs, signifying the external orgs to search through.

                                                                                                                                                                                                                                    property query

                                                                                                                                                                                                                                    query?: string;
                                                                                                                                                                                                                                    • Name of the channel to query by.

                                                                                                                                                                                                                                    property search_channel_types

                                                                                                                                                                                                                                    search_channel_types?: ChannelType[];
                                                                                                                                                                                                                                    • 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 Also

                                                                                                                                                                                                                                      • .

                                                                                                                                                                                                                                    property sort

                                                                                                                                                                                                                                    sort?: 'relevant' | 'name' | 'member_count' | 'created';
                                                                                                                                                                                                                                    • 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.

                                                                                                                                                                                                                                    property total_count_only

                                                                                                                                                                                                                                    total_count_only?: boolean;
                                                                                                                                                                                                                                    • Only return the total count of channels. Omits channel data and allows access for admins without channel manager permissions. Defaults to false.

                                                                                                                                                                                                                                    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 AdminEmojiListArguments

                                                                                                                                                                                                                                                interface AdminEmojiListArguments
                                                                                                                                                                                                                                                extends TokenOverridable,
                                                                                                                                                                                                                                                CursorPaginationEnabled {}

                                                                                                                                                                                                                                                  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 {}

                                                                                                                                                                                                                                                            property function_id

                                                                                                                                                                                                                                                            function_id: string;
                                                                                                                                                                                                                                                            • The function ID to set permissions for.

                                                                                                                                                                                                                                                            property user_ids

                                                                                                                                                                                                                                                            user_ids?: string[];
                                                                                                                                                                                                                                                            • List of user IDs to allow for named_entities visibility.

                                                                                                                                                                                                                                                            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 AdminRolesListAssignmentsArguments

                                                                                                                                                                                                                                                                        interface AdminRolesListAssignmentsArguments
                                                                                                                                                                                                                                                                        extends Partial<EntityIDs>,
                                                                                                                                                                                                                                                                        TokenOverridable,
                                                                                                                                                                                                                                                                        CursorPaginationEnabled,
                                                                                                                                                                                                                                                                        SortDir {}

                                                                                                                                                                                                                                                                          property role_ids

                                                                                                                                                                                                                                                                          role_ids?: string[];
                                                                                                                                                                                                                                                                          • Collection of role ids to scope results by.

                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                            • .

                                                                                                                                                                                                                                                                          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 AdminTeamsListArguments

                                                                                                                                                                                                                                                                                interface AdminTeamsListArguments
                                                                                                                                                                                                                                                                                extends TokenOverridable,
                                                                                                                                                                                                                                                                                CursorPaginationEnabled {}

                                                                                                                                                                                                                                                                                  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 AdminWorkflowsSearchArguments

                                                                                                                                                                                                                                                                                                                                          interface AdminWorkflowsSearchArguments
                                                                                                                                                                                                                                                                                                                                          extends Partial<AppID>,
                                                                                                                                                                                                                                                                                                                                          Partial<CollaboratorIDs>,
                                                                                                                                                                                                                                                                                                                                          SortDir,
                                                                                                                                                                                                                                                                                                                                          TokenOverridable,
                                                                                                                                                                                                                                                                                                                                          CursorPaginationEnabled {}

                                                                                                                                                                                                                                                                                                                                            property no_collaborators

                                                                                                                                                                                                                                                                                                                                            no_collaborators?: boolean;
                                                                                                                                                                                                                                                                                                                                            • Only include workflows with no collaborators in the result; default is false.

                                                                                                                                                                                                                                                                                                                                            property num_trigger_ids

                                                                                                                                                                                                                                                                                                                                            num_trigger_ids?: number;
                                                                                                                                                                                                                                                                                                                                            • Number of trigger IDs to fetch for each workflow; default is 0.

                                                                                                                                                                                                                                                                                                                                            property query

                                                                                                                                                                                                                                                                                                                                            query?: string;
                                                                                                                                                                                                                                                                                                                                            • A search query to filter for workflow name or description.

                                                                                                                                                                                                                                                                                                                                            property sort

                                                                                                                                                                                                                                                                                                                                            sort?: 'premium_runs';
                                                                                                                                                                                                                                                                                                                                            • The field used to sort the returned workflows. Currently only premium_runs is supported.

                                                                                                                                                                                                                                                                                                                                            property source

                                                                                                                                                                                                                                                                                                                                            source?: 'code' | 'workflow_builder';
                                                                                                                                                                                                                                                                                                                                            • Source of workflow creation, either from code or workflow_builder.

                                                                                                                                                                                                                                                                                                                                            interface AdminWorkflowsUnpublishArguments

                                                                                                                                                                                                                                                                                                                                            interface AdminWorkflowsUnpublishArguments extends WorkflowIDs, TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                              interface APITestArguments

                                                                                                                                                                                                                                                                                                                                              interface APITestArguments {}

                                                                                                                                                                                                                                                                                                                                                property error

                                                                                                                                                                                                                                                                                                                                                error?: string;
                                                                                                                                                                                                                                                                                                                                                • Error response to return.

                                                                                                                                                                                                                                                                                                                                                interface AppsConnectionsOpenArguments

                                                                                                                                                                                                                                                                                                                                                interface AppsConnectionsOpenArguments {}

                                                                                                                                                                                                                                                                                                                                                  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'> {}

                                                                                                                                                                                                                                                                                                                                                                        interface AuthRevokeArguments

                                                                                                                                                                                                                                                                                                                                                                        interface AuthRevokeArguments extends TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                          property test

                                                                                                                                                                                                                                                                                                                                                                          test?: boolean;
                                                                                                                                                                                                                                                                                                                                                                          • Setting this parameter to true triggers a testing mode where the specified token will not actually be revoked.

                                                                                                                                                                                                                                                                                                                                                                          interface AuthTeamsListArguments

                                                                                                                                                                                                                                                                                                                                                                          interface AuthTeamsListArguments extends TokenOverridable, CursorPaginationEnabled {}

                                                                                                                                                                                                                                                                                                                                                                            property include_icon

                                                                                                                                                                                                                                                                                                                                                                            include_icon?: boolean;
                                                                                                                                                                                                                                                                                                                                                                            • Whether to return icon paths for each workspace. An icon path represents a URI pointing to the image signifying the workspace. Defaults to false.

                                                                                                                                                                                                                                                                                                                                                                            interface AuthTestArguments

                                                                                                                                                                                                                                                                                                                                                                            interface AuthTestArguments extends TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                              interface BookmarksAddArguments

                                                                                                                                                                                                                                                                                                                                                                              interface BookmarksAddArguments extends Channel, 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 Channel,
                                                                                                                                                                                                                                                                                                                                                                                ID,
                                                                                                                                                                                                                                                                                                                                                                                Partial<BookmarkFields>,
                                                                                                                                                                                                                                                                                                                                                                                TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                                  interface BookmarksListArguments

                                                                                                                                                                                                                                                                                                                                                                                  interface BookmarksListArguments extends Channel, TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                                    interface BookmarksRemoveArguments

                                                                                                                                                                                                                                                                                                                                                                                    interface BookmarksRemoveArguments extends Channel, ID, TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                                      interface BotsInfoArguments

                                                                                                                                                                                                                                                                                                                                                                                      interface BotsInfoArguments extends TokenOverridable, OptionalTeamAssignable {}

                                                                                                                                                                                                                                                                                                                                                                                        property bot

                                                                                                                                                                                                                                                                                                                                                                                        bot?: string;
                                                                                                                                                                                                                                                                                                                                                                                        • Bot ID, which starts with 'B', to retrieve information about.

                                                                                                                                                                                                                                                                                                                                                                                        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 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 ChatScheduledMessagesListArguments

                                                                                                                                                                                                                                                                                                                                                                                                            interface ChatScheduledMessagesListArguments
                                                                                                                                                                                                                                                                                                                                                                                                            extends TokenOverridable,
                                                                                                                                                                                                                                                                                                                                                                                                            CursorPaginationEnabled,
                                                                                                                                                                                                                                                                                                                                                                                                            OptionalTeamAssignable,
                                                                                                                                                                                                                                                                                                                                                                                                            Pick<TimelinePaginationEnabled, 'latest' | 'oldest'>,
                                                                                                                                                                                                                                                                                                                                                                                                            Partial<Channel> {}

                                                                                                                                                                                                                                                                                                                                                                                                              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 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 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 ConversationsListArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ConversationsListArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                        extends TokenOverridable,
                                                                                                                                                                                                                                                                                                                                                                                                                                        CursorPaginationEnabled,
                                                                                                                                                                                                                                                                                                                                                                                                                                        OptionalTeamAssignable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                          property exclude_archived

                                                                                                                                                                                                                                                                                                                                                                                                                                          exclude_archived?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                          • Set to true to exclude archived channels from the list. Defaults to 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 or im. Defaults to public_channel.

                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ConversationsListConnectInvitesArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ConversationsListConnectInvitesArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                          extends TokenOverridable,
                                                                                                                                                                                                                                                                                                                                                                                                                                          OptionalTeamAssignable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                            property count

                                                                                                                                                                                                                                                                                                                                                                                                                                            count?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                            • Maximum number of invites to return. Defaults to 100.

                                                                                                                                                                                                                                                                                                                                                                                                                                            property cursor

                                                                                                                                                                                                                                                                                                                                                                                                                                            cursor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            • Set to next_cursor returned by previous call to list items in subsequent page.

                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ConversationsMarkArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ConversationsMarkArguments extends Message, 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 Message,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  IncludeAllMetadata,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  TokenOverridable,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  CursorPaginationEnabled,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  TimelinePaginationEnabled {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                    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 DndEndDndArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface DndEndDndArguments extends TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface DndEndSnoozeArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface DndEndSnoozeArguments extends TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface DndInfoArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface DndInfoArguments extends TokenOverridable, OptionalTeamAssignable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  property user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  user?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • User to fetch status for (defaults to authed 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 EmojiListArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface EmojiListArguments extends TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        property include_categories

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        include_categories?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Include a list of categories for Unicode emoji and the emoji in each category.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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 Method

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface Method<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  MethodArguments,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  MethodResult extends WebAPICallResult = WebAPICallResult
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  > {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Generic method definition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  call signature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (options: MethodArguments): Promise<MethodResult>;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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'> {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface OpenIDConnectTokenArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface OpenIDConnectTokenArguments extends OAuthCredentials, OAuthGrantRefresh {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface OpenIDConnectUserInfoArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface OpenIDConnectUserInfoArguments {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface PageReducer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface PageReducer<A = any> {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  call signature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (accumulator: A | undefined, page: WebAPICallResult, index: number): A;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface PaginatePredicate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface PaginatePredicate {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      call signature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      (page: WebAPICallResult): boolean | undefined | void;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        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 ReactionsListArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ReactionsListArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                extends ReactionsFull,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                TokenOverridable,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                TraditionalPagingEnabled,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                CursorPaginationEnabled,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OptionalTeamAssignable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  property user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  user?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Show reactions made by this user. Defaults to the authed user.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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 RemindersListArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface RemindersListArguments extends TokenOverridable, OptionalTeamAssignable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface RetryOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface RetryOptions extends OperationOptions {}
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Options to create retry policies. Extends from https://github.com/tim-kos/node-retry.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface RTMConnectArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface RTMConnectArguments extends TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              property batch_presence_aware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              batch_presence_aware?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Batch presence deliveries via subscription. Enabling changes the shape of presence_change events.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • .

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              property presence_sub

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              presence_sub?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Only deliver presence events when requested by subscription.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • .

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface RTMStartArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface RTMStartArguments extends RTMConnectArguments, LocaleAware {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                property mpim_aware

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                mpim_aware?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns MPIMs to the client in the API response.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                property no_latest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                no_latest?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                property no_unreads

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                no_unreads?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Skip unread counts for each channel (improves performance).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                property simple_latest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                simple_latest?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Return timestamp only for latest message object of each channel (improves performance).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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 TeamAccessLogsArguments

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          property before

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          before?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • End of time range of logs to include in results (inclusive) as a UNIX timestamp in seconds. Default to now.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface TeamBillableInfoArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface TeamBillableInfoArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          extends TokenOverridable,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          CursorPaginationEnabled,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OptionalTeamAssignable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            property user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            user?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • A user to retrieve the billable information for. Defaults to all users.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface TeamBillingInfoArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface TeamBillingInfoArguments extends TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface TeamInfoArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface TeamInfoArguments extends TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                property domain

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                domain?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • 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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                property team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                team?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Team to get info about; if omitted, will return information about the current team.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface TeamIntegrationLogsArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface TeamIntegrationLogsArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                extends Partial<AppID>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                TokenOverridable,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OptionalTeamAssignable,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                TraditionalPagingEnabled {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  property change_type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  change_type?: 'added' | 'removed' | 'enabled' | 'disabled' | 'updated';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Filter logs with this change type. Defaults to all logs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  property service_id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  service_id?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Filter logs to this service. Defaults to all logs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  property user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  user?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Filter logs generated by this user’s actions. Defaults to all logs.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface TeamPreferencesListArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface TeamPreferencesListArguments extends TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface TeamProfileGetArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface TeamProfileGetArguments extends TokenOverridable {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      property visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      visibility?: 'all' | 'visible' | 'hidden';
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Filter by visibility.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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 UsergroupsListArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface UsergroupsListArguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              extends TokenOverridable,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              OptionalTeamAssignable,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              UsergroupsIncludeCount {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                property include_disabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                include_disabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Include disabled User Groups.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                property include_users

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                include_users<