From 7959f01f713bc8c0f2e68020228d8046e1928113 Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Mon, 19 Aug 2024 16:10:57 -0700 Subject: [PATCH] docs - remove reference files in source --- docs/.gitignore | 3 +- .../cli-test/classes/SlackCLIProcess.md | 150 - docs/content/reference/cli-test/index.md | 12 - .../reference/cli-test/typedoc-sidebar.cjs | 4 - .../reference/cli-test/variables/SlackCLI.md | 690 --- .../cli-test/variables/SlackProduct.md | 47 - .../cli-test/variables/SlackTracerId.md | 253 - .../reference/cli-test/variables/shell.md | 151 - .../events-api/classes/SlackEventAdapter.md | 189 - .../events-api/enumerations/ErrorCode.md | 39 - .../functions/createEventAdapter.md | 21 - .../functions/verifyRequestSignature.md | 28 - docs/content/reference/events-api/index.md | 24 - .../events-api/interfaces/CodedError.md | 71 - .../interfaces/EventAdapterOptions.md | 40 - .../VerifyRequestSignatureParams.md | 59 - .../reference/events-api/typedoc-sidebar.cjs | 4 - .../events-api/variables/errorCodes.md | 29 - .../classes/SlackMessageAdapter.md | 382 -- .../enumerations/ErrorCode.md | 51 - .../enumerations/ResponseStatus.md | 27 - .../functions/createMessageAdapter.md | 21 - .../reference/interactive-messages/index.md | 36 - .../interfaces/ActionConstraints.md | 75 - .../interfaces/DispatchResult.md | 27 - .../interfaces/MessageAdapterOptions.md | 39 - .../interfaces/OptionsConstraints.md | 59 - .../interfaces/ShortcutConstraints.md | 31 - .../interfaces/ViewConstraints.md | 45 - .../type-aliases/ActionHandler.md | 39 - .../type-aliases/OptionsHandler.md | 28 - .../type-aliases/Respond.md | 23 - .../type-aliases/ShortcutHandler.md | 21 - .../type-aliases/ViewClosedHandler.md | 21 - .../type-aliases/ViewSubmissionHandler.md | 21 - .../interactive-messages/typedoc-sidebar.cjs | 4 - .../variables/errorCodes.md | 19 - .../reference/logger/classes/ConsoleLogger.md | 201 - .../reference/logger/enumerations/LogLevel.md | 51 - docs/content/reference/logger/index.md | 13 - .../reference/logger/interfaces/Logger.md | 167 - .../reference/logger/typedoc-sidebar.cjs | 4 - .../oauth/classes/AuthorizationError.md | 123 - .../oauth/classes/ClearStateStore.md | 93 - .../oauth/classes/FileInstallationStore.md | 103 - .../reference/oauth/classes/FileStateStore.md | 91 - .../oauth/classes/GenerateInstallUrlError.md | 109 - .../oauth/classes/InstallProvider.md | 169 - .../classes/InstallerInitializationError.md | 109 - .../oauth/classes/InvalidStateError.md | 109 - .../oauth/classes/MemoryInstallationStore.md | 107 - .../oauth/classes/MissingCodeError.md | 109 - .../oauth/classes/MissingStateError.md | 109 - .../reference/oauth/classes/UnknownError.md | 109 - .../reference/oauth/enumerations/ErrorCode.md | 87 - .../oauth/functions/defaultCallbackFailure.md | 27 - .../oauth/functions/defaultCallbackSuccess.md | 27 - .../defaultRenderHtmlForInstallPath.md | 17 - docs/content/reference/oauth/index.md | 58 - .../oauth/interfaces/AuthorizeResult.md | 121 - .../oauth/interfaces/CallbackOptions.md | 172 - .../reference/oauth/interfaces/CodedError.md | 65 - .../oauth/interfaces/FileStateStoreArgs.md | 37 - .../oauth/interfaces/InstallPathOptions.md | 38 - .../interfaces/InstallProviderOptions.md | 253 - .../oauth/interfaces/InstallURLOptions.md | 61 - .../oauth/interfaces/Installation.md | 283 - .../oauth/interfaces/InstallationQuery.md | 65 - .../oauth/interfaces/InstallationStore.md | 71 - .../oauth/interfaces/OAuthV2Response.md | 209 - .../interfaces/OAuthV2TokenRefreshResponse.md | 137 - .../reference/oauth/interfaces/StateObj.md | 43 - .../reference/oauth/interfaces/StateStore.md | 59 - .../oauth/type-aliases/OrgInstallation.md | 11 - .../type-aliases/OrgInstallationQuery.md | 9 - .../reference/oauth/typedoc-sidebar.cjs | 4 - .../reference/oauth/variables/Logger.md | 5 - .../reference/rtm-api/classes/RTMClient.md | 316 -- .../rtm-api/enumerations/ErrorCode.md | 99 - docs/content/reference/rtm-api/index.md | 35 - .../rtm-api/interfaces/CodedError.md | 27 - .../rtm-api/interfaces/RTMCallResult.md | 49 - .../rtm-api/interfaces/RTMClientOptions.md | 145 - .../interfaces/RTMNoReplyReceivedError.md | 23 - .../rtm-api/interfaces/RTMPlatformError.md | 35 - .../RTMSendWhileDisconnectedError.md | 23 - .../interfaces/RTMSendWhileNotReadyError.md | 23 - .../rtm-api/interfaces/RTMWebsocketError.md | 35 - .../rtm-api/type-aliases/RTMCallError.md | 14 - .../rtm-api/type-aliases/RTMStartOptions.md | 9 - .../reference/rtm-api/typedoc-sidebar.cjs | 4 - .../reference/rtm-api/variables/Logger.md | 5 - .../socket-mode/classes/SocketModeClient.md | 115 - .../socket-mode/enumerations/ErrorCode.md | 75 - .../UnrecoverableSocketModeStartError.md | 61 - docs/content/reference/socket-mode/index.md | 33 - .../interfaces/SMNoReplyReceivedError.md | 69 - .../socket-mode/interfaces/SMPlatformError.md | 81 - .../SMSendWhileDisconnectedError.md | 69 - .../interfaces/SMSendWhileNotReadyError.md | 69 - .../interfaces/SMWebsocketError.md | 81 - .../interfaces/SocketModeOptions.md | 123 - .../socket-mode/type-aliases/SMCallError.md | 14 - .../reference/socket-mode/typedoc-sidebar.cjs | 4 - .../reference/socket-mode/variables/Logger.md | 5 - docs/content/reference/types/index.md | 108 - .../reference/types/interfaces/Action.md | 37 - .../reference/types/interfaces/Actionable.md | 71 - .../types/interfaces/ActionsBlock.md | 74 - .../reference/types/interfaces/Block.md | 49 - .../reference/types/interfaces/Button.md | 165 - .../types/interfaces/CallUserExternal.md | 49 - .../types/interfaces/CallUserSlack.md | 18 - .../types/interfaces/ChannelsSelect.md | 158 - .../reference/types/interfaces/Checkboxes.md | 130 - .../reference/types/interfaces/Confirm.md | 104 - .../reference/types/interfaces/Confirmable.md | 39 - .../types/interfaces/Confirmation.md | 49 - .../types/interfaces/ConfirmationDialog.md | 119 - .../types/interfaces/ContextBlock.md | 74 - .../types/interfaces/ConversationsSelect.md | 210 - .../types/interfaces/DateTimepicker.md | 118 - .../reference/types/interfaces/Datepicker.md | 135 - .../reference/types/interfaces/Dialog.md | 79 - .../types/interfaces/DispatchActionConfig.md | 30 - .../types/interfaces/Dispatchable.md | 26 - .../types/interfaces/DividerBlock.md | 58 - .../reference/types/interfaces/EmailInput.md | 134 - .../types/interfaces/ExternalSelect.md | 153 - .../reference/types/interfaces/FileBlock.md | 92 - .../reference/types/interfaces/FileInput.md | 89 - .../reference/types/interfaces/Focusable.md | 42 - .../reference/types/interfaces/HeaderBlock.md | 75 - .../reference/types/interfaces/HomeView.md | 109 - .../reference/types/interfaces/InputBlock.md | 143 - .../reference/types/interfaces/LinkUnfurls.md | 5 - .../types/interfaces/MaxItemsSelectable.md | 25 - .../types/interfaces/MessageAttachment.md | 401 -- .../interfaces/MessageAttachmentField.md | 59 - .../types/interfaces/MessageMetadata.md | 52 - .../MessageMetadataEventPayloadObject.md | 5 - .../reference/types/interfaces/ModalView.md | 196 - .../types/interfaces/MrkdwnElement.md | 61 - .../types/interfaces/MrkdwnOption.md | 85 - .../types/interfaces/MultiChannelsSelect.md | 155 - .../interfaces/MultiConversationsSelect.md | 207 - .../types/interfaces/MultiExternalSelect.md | 172 - .../types/interfaces/MultiStaticSelect.md | 190 - .../types/interfaces/MultiUsersSelect.md | 155 - .../reference/types/interfaces/NumberInput.md | 184 - .../reference/types/interfaces/OptionGroup.md | 42 - .../reference/types/interfaces/Overflow.md | 95 - .../types/interfaces/Placeholdable.md | 38 - .../types/interfaces/PlainTextElement.md | 57 - .../types/interfaces/PlainTextInput.md | 185 - .../types/interfaces/PlainTextOption.md | 85 - .../types/interfaces/RadioButtons.md | 130 - .../types/interfaces/RichTextBlock.md | 74 - .../types/interfaces/RichTextBorderable.md | 26 - .../interfaces/RichTextBroadcastMention.md | 101 - .../interfaces/RichTextChannelMention.md | 101 - .../types/interfaces/RichTextColor.md | 101 - .../types/interfaces/RichTextDate.md | 169 - .../types/interfaces/RichTextEmoji.md | 133 - .../types/interfaces/RichTextInput.md | 135 - .../types/interfaces/RichTextLink.md | 133 - .../types/interfaces/RichTextList.md | 96 - .../types/interfaces/RichTextPreformatted.md | 62 - .../types/interfaces/RichTextQuote.md | 62 - .../types/interfaces/RichTextSection.md | 33 - .../types/interfaces/RichTextStyleable.md | 74 - .../types/interfaces/RichTextTeamMention.md | 101 - .../types/interfaces/RichTextText.md | 101 - .../types/interfaces/RichTextUserMention.md | 101 - .../interfaces/RichTextUsergroupMention.md | 101 - .../types/interfaces/SectionBlock.md | 112 - .../types/interfaces/SelectOption.md | 25 - .../types/interfaces/SlackFileImageObject.md | 21 - .../types/interfaces/StaticSelect.md | 170 - .../reference/types/interfaces/Timepicker.md | 155 - .../reference/types/interfaces/URLInput.md | 134 - .../types/interfaces/URLRespondable.md | 25 - .../types/interfaces/UrlImageObject.md | 21 - .../reference/types/interfaces/UsersSelect.md | 135 - .../reference/types/interfaces/VideoBlock.md | 206 - .../types/interfaces/WorkflowButton.md | 153 - .../types/interfaces/WorkflowStepView.md | 128 - .../types/type-aliases/ActionsBlockElement.md | 26 - .../reference/types/type-aliases/AnyBlock.md | 12 - .../reference/types/type-aliases/CallUser.md | 13 - .../types/type-aliases/ColorScheme.md | 12 - .../types/type-aliases/ContextBlockElement.md | 15 - .../types/type-aliases/ConversationFilter.md | 18 - .../types/type-aliases/ConversationType.md | 11 - .../types/type-aliases/ImageBlock.md | 51 - .../types/type-aliases/ImageElement.md | 40 - .../types/type-aliases/InputBlockElement.md | 28 - .../types/type-aliases/KnownBlock.md | 22 - .../types/type-aliases/MultiSelect.md | 28 - .../reference/types/type-aliases/Option.md | 18 - .../type-aliases/RichTextBlockElement.md | 15 - .../types/type-aliases/RichTextElement.md | 23 - .../type-aliases/SectionBlockAccessory.md | 25 - .../reference/types/type-aliases/Select.md | 27 - .../reference/types/type-aliases/SlackFile.md | 20 - .../types/type-aliases/TextObject.md | 18 - .../reference/types/type-aliases/View.md | 9 - .../reference/types/typedoc-sidebar.cjs | 4 - .../reference/web-api/classes/Methods.md | 4593 ---------------- .../reference/web-api/classes/WebClient.md | 4873 ----------------- .../web-api/enumerations/ErrorCode.md | 75 - .../web-api/enumerations/LogLevel.md | 51 - .../web-api/enumerations/WebClientEvent.md | 13 - .../web-api/functions/addAppMetadata.md | 23 - docs/content/reference/web-api/index.md | 683 --- .../reference/web-api/interfaces/Action.md | 37 - .../web-api/interfaces/Actionable.md | 71 - .../web-api/interfaces/ActionsBlock.md | 85 - .../interfaces/AdminAnalyticsMemberDetails.md | 277 - .../AdminAnalyticsPublicChannelDetails.md | 229 - ...inAnalyticsPublicChannelMetadataDetails.md | 61 - .../AdminAppsConfigLookupArguments.md | 41 - .../interfaces/AdminAppsConfigSetArguments.md | 97 - .../AdminAuthPolicyAssignEntitiesArguments.md | 85 - .../AdminAuthPolicyGetEntitiesArguments.md | 112 - .../AdminAuthPolicyRemoveEntitiesArguments.md | 85 - .../AdminBarriersCreateArguments.md | 78 - .../AdminBarriersDeleteArguments.md | 45 - .../AdminBarriersUpdateArguments.md | 106 - .../AdminConversationsArchiveArguments.md | 45 - .../AdminConversationsBulkArchiveArguments.md | 45 - .../AdminConversationsBulkDeleteArguments.md | 45 - .../AdminConversationsBulkMoveArguments.md | 61 - ...nConversationsConvertToPrivateArguments.md | 61 - ...inConversationsConvertToPublicArguments.md | 45 - .../AdminConversationsDeleteArguments.md | 45 - ...nConversationsDisconnectSharedArguments.md | 61 - ...versationsGetConversationPrefsArguments.md | 45 - ...onversationsGetCustomRetentionArguments.md | 45 - .../AdminConversationsGetTeamsArguments.md | 92 - .../AdminConversationsInviteArguments.md | 65 - .../AdminConversationsLookupArguments.md | 125 - ...ersationsRemoveCustomRetentionArguments.md | 45 - .../AdminConversationsRenameArguments.md | 61 - ...rsationsRestrictAccessAddGroupArguments.md | 86 - ...ationsRestrictAccessListGroupsArguments.md | 66 - ...tionsRestrictAccessRemoveGroupArguments.md | 86 - ...versationsSetConversationPrefsArguments.md | 61 - ...onversationsSetCustomRetentionArguments.md | 61 - .../AdminConversationsSetTeamsArguments.md | 95 - .../AdminConversationsUnarchiveArguments.md | 45 - .../interfaces/AdminEmojiAddAliasArguments.md | 63 - .../interfaces/AdminEmojiAddArguments.md | 63 - .../interfaces/AdminEmojiRemoveArguments.md | 46 - .../interfaces/AdminEmojiRenameArguments.md | 62 - .../interfaces/AdminFunctionsListArguments.md | 104 - ...dminFunctionsPermissionsLookupArguments.md | 41 - .../AdminFunctionsPermissionsSetArguments.md | 73 - .../AdminInviteRequestsApproveArguments.md | 65 - ...dminInviteRequestsApprovedListArguments.md | 92 - .../AdminInviteRequestsDeniedListArguments.md | 92 - .../AdminInviteRequestsDenyArguments.md | 65 - .../AdminInviteRequestsListArguments.md | 92 - .../AdminRolesAddAssignmentsArguments.md | 90 - .../AdminRolesRemoveAssignmentsArguments.md | 90 - .../AdminTeamsAdminsListArguments.md | 92 - .../interfaces/AdminTeamsCreateArguments.md | 89 - .../AdminTeamsOwnersListArguments.md | 92 - .../AdminTeamsSettingsInfoArguments.md | 45 - ...eamsSettingsSetDefaultChannelsArguments.md | 65 - ...minTeamsSettingsSetDescriptionArguments.md | 61 - ...eamsSettingsSetDiscoverabilityArguments.md | 61 - .../AdminTeamsSettingsSetIconArguments.md | 61 - .../AdminTeamsSettingsSetNameArguments.md | 61 - .../AdminUsergroupsAddChannelsArguments.md | 85 - .../AdminUsergroupsAddTeamsArguments.md | 79 - .../AdminUsergroupsListChannelsArguments.md | 81 - .../AdminUsergroupsRemoveChannelsArguments.md | 65 - .../interfaces/AdminUsersAssignArguments.md | 125 - .../interfaces/AdminUsersInviteArguments.md | 204 - .../interfaces/AdminUsersRemoveArguments.md | 65 - ...AdminUsersSessionClearSettingsArguments.md | 45 - .../AdminUsersSessionGetSettingsArguments.md | 45 - .../AdminUsersSessionInvalidateArguments.md | 61 - .../AdminUsersSessionResetArguments.md | 85 - .../AdminUsersSessionResetBulkArguments.md | 85 - .../AdminUsersSessionSetSettingsArguments.md | 78 - .../interfaces/AdminUsersSetAdminArguments.md | 65 - .../AdminUsersSetExpirationArguments.md | 81 - .../interfaces/AdminUsersSetOwnerArguments.md | 65 - .../AdminUsersSetRegularArguments.md | 65 - ...UsersUnsupportedVersionsExportArguments.md | 59 - ...AdminWorkflowsCollaboratorsAddArguments.md | 65 - ...inWorkflowsCollaboratorsRemoveArguments.md | 65 - ...dminWorkflowsPermissionsLookupArguments.md | 62 - .../AdminWorkflowsUnpublishArguments.md | 45 - .../AppsEventAuthorizationsListArguments.md | 84 - .../interfaces/AppsManifestCreateArguments.md | 37 - .../interfaces/AppsManifestDeleteArguments.md | 45 - .../interfaces/AppsManifestExportArguments.md | 45 - .../interfaces/AppsManifestUpdateArguments.md | 57 - .../AppsManifestValidateArguments.md | 57 - .../interfaces/AppsUninstallArguments.md | 45 - .../web-api/interfaces/AttachmentAction.md | 162 - .../reference/web-api/interfaces/Block.md | 45 - .../interfaces/BookmarksAddArguments.md | 153 - .../interfaces/BookmarksEditArguments.md | 121 - .../interfaces/BookmarksListArguments.md | 45 - .../interfaces/BookmarksRemoveArguments.md | 61 - .../reference/web-api/interfaces/Button.md | 165 - .../web-api/interfaces/CallUserExternal.md | 49 - .../web-api/interfaces/CallUserSlack.md | 18 - .../web-api/interfaces/CallsAddArguments.md | 176 - .../web-api/interfaces/CallsEndArguments.md | 61 - .../web-api/interfaces/CallsInfoArguments.md | 45 - .../CallsParticipantsAddArguments.md | 69 - .../CallsParticipantsRemoveArguments.md | 69 - .../interfaces/CallsUpdateArguments.md | 106 - .../CanvasesAccessDeleteArguments.md | 85 - .../interfaces/CanvasesAccessSetArguments.md | 101 - .../interfaces/CanvasesDeleteArguments.md | 45 - .../interfaces/CanvasesEditArguments.md | 61 - .../CanvasesSectionsLookupArguments.md | 61 - .../web-api/interfaces/ChannelsSelect.md | 154 - .../web-api/interfaces/ChatDeleteArguments.md | 87 - .../ChatDeleteScheduledMessageArguments.md | 83 - .../interfaces/ChatGetPermalinkArguments.md | 65 - .../interfaces/ChatMeMessageArguments.md | 66 - .../web-api/interfaces/Checkboxes.md | 130 - .../web-api/interfaces/CodedError.md | 126 - .../reference/web-api/interfaces/Confirm.md | 104 - .../web-api/interfaces/Confirmable.md | 39 - .../web-api/interfaces/Confirmation.md | 49 - .../web-api/interfaces/ConfirmationDialog.md | 119 - .../web-api/interfaces/ContextBlock.md | 74 - ...nversationsApproveSharedInviteArguments.md | 65 - .../ConversationsArchiveArguments.md | 45 - .../ConversationsCanvasesCreateArguments.md | 57 - .../interfaces/ConversationsCloseArguments.md | 45 - .../ConversationsCreateArguments.md | 81 - ...nversationsDeclineSharedInviteArguments.md | 65 - ...nsExternalInvitePermissionsSetArguments.md | 81 - .../ConversationsHistoryArguments.md | 173 - .../interfaces/ConversationsInfoArguments.md | 81 - .../ConversationsInviteArguments.md | 82 - .../interfaces/ConversationsJoinArguments.md | 45 - .../interfaces/ConversationsKickArguments.md | 57 - .../interfaces/ConversationsLeaveArguments.md | 45 - .../interfaces/ConversationsMarkArguments.md | 65 - .../ConversationsMembersArguments.md | 92 - .../ConversationsRenameArguments.md | 61 - .../ConversationsRepliesArguments.md | 193 - .../web-api/interfaces/ConversationsSelect.md | 206 - .../ConversationsSetPurposeArguments.md | 61 - .../ConversationsSetTopicArguments.md | 61 - .../ConversationsUnarchiveArguments.md | 45 - .../web-api/interfaces/DateTimepicker.md | 118 - .../web-api/interfaces/Datepicker.md | 135 - .../reference/web-api/interfaces/Dialog.md | 79 - .../web-api/interfaces/DialogOpenArguments.md | 57 - .../interfaces/DispatchActionConfig.md | 30 - .../web-api/interfaces/Dispatchable.md | 26 - .../web-api/interfaces/DividerBlock.md | 58 - .../interfaces/DndSetSnoozeArguments.md | 41 - .../interfaces/DndTeamInfoArguments.md | 61 - .../web-api/interfaces/EmailInput.md | 134 - .../web-api/interfaces/ExternalSelect.md | 153 - .../reference/web-api/interfaces/FileBlock.md | 92 - .../reference/web-api/interfaces/FileInput.md | 89 - .../FilesCommentsDeleteArguments.md | 61 - .../interfaces/FilesDeleteArguments.md | 45 - .../FilesGetUploadURLExternalArguments.md | 89 - .../web-api/interfaces/FilesInfoArguments.md | 132 - .../web-api/interfaces/FilesListArguments.md | 184 - .../interfaces/FilesRemoteAddArguments.md | 150 - .../interfaces/FilesRemoteListArguments.md | 120 - .../FilesRevokePublicURLArguments.md | 45 - .../FilesSharedPublicURLArguments.md | 45 - .../reference/web-api/interfaces/Focusable.md | 42 - .../FunctionsCompleteErrorArguments.md | 53 - .../FunctionsCompleteSuccessArguments.md | 53 - .../web-api/interfaces/HeaderBlock.md | 75 - .../reference/web-api/interfaces/HomeView.md | 61 - .../web-api/interfaces/InputBlock.md | 156 - .../web-api/interfaces/LinkUnfurls.md | 5 - .../reference/web-api/interfaces/Logger.md | 167 - .../web-api/interfaces/MessageAttachment.md | 401 -- .../interfaces/MessageAttachmentField.md | 59 - .../interfaces/MessageAttachmentPreview.md | 61 - .../web-api/interfaces/MessageMetadata.md | 52 - .../MessageMetadataEventPayloadObject.md | 5 - .../reference/web-api/interfaces/Method.md | 27 - .../interfaces/MigrationExchangeArguments.md | 77 - .../reference/web-api/interfaces/ModalView.md | 121 - .../web-api/interfaces/MrkdwnElement.md | 61 - .../web-api/interfaces/MrkdwnOption.md | 85 - .../web-api/interfaces/MultiChannelsSelect.md | 151 - .../interfaces/MultiConversationsSelect.md | 203 - .../web-api/interfaces/MultiExternalSelect.md | 168 - .../web-api/interfaces/MultiStaticSelect.md | 186 - .../web-api/interfaces/MultiUsersSelect.md | 151 - .../web-api/interfaces/NumberInput.md | 184 - .../interfaces/OAuthAccessArguments.md | 102 - .../interfaces/OAuthV2AccessArguments.md | 126 - .../interfaces/OAuthV2ExchangeArguments.md | 61 - .../interfaces/OpenIDConnectTokenArguments.md | 126 - .../web-api/interfaces/OptionField.md | 37 - .../web-api/interfaces/OptionGroup.md | 42 - .../reference/web-api/interfaces/Overflow.md | 95 - .../web-api/interfaces/PageReducer.md | 28 - .../web-api/interfaces/PaginatePredicate.md | 17 - .../web-api/interfaces/PinsAddArguments.md | 65 - .../web-api/interfaces/PinsListArguments.md | 41 - .../web-api/interfaces/PinsRemoveArguments.md | 65 - .../web-api/interfaces/Placeholdable.md | 38 - .../web-api/interfaces/PlainTextElement.md | 57 - .../web-api/interfaces/PlainTextInput.md | 185 - .../web-api/interfaces/PlainTextOption.md | 85 - .../web-api/interfaces/RadioButtons.md | 130 - .../interfaces/ReactionsAddArguments.md | 85 - .../interfaces/RemindersAddArguments.md | 119 - .../interfaces/RemindersCompleteArguments.md | 61 - .../interfaces/RemindersDeleteArguments.md | 61 - .../interfaces/RemindersInfoArguments.md | 61 - .../web-api/interfaces/RetryOptions.md | 199 - .../web-api/interfaces/RichTextBlock.md | 61 - .../interfaces/RichTextBroadcastMention.md | 101 - .../interfaces/RichTextChannelMention.md | 101 - .../web-api/interfaces/RichTextColor.md | 101 - .../web-api/interfaces/RichTextDate.md | 169 - .../web-api/interfaces/RichTextEmoji.md | 133 - .../web-api/interfaces/RichTextInput.md | 135 - .../web-api/interfaces/RichTextLink.md | 133 - .../web-api/interfaces/RichTextList.md | 88 - .../interfaces/RichTextPreformatted.md | 54 - .../web-api/interfaces/RichTextQuote.md | 54 - .../web-api/interfaces/RichTextSection.md | 33 - .../web-api/interfaces/RichTextStyleable.md | 74 - .../web-api/interfaces/RichTextTeamMention.md | 101 - .../web-api/interfaces/RichTextText.md | 101 - .../web-api/interfaces/RichTextUserMention.md | 101 - .../interfaces/RichTextUsergroupMention.md | 101 - .../web-api/interfaces/SearchAllArguments.md | 169 - .../interfaces/SearchFilesArguments.md | 169 - .../interfaces/SearchMessagesArguments.md | 169 - .../web-api/interfaces/SectionBlock.md | 122 - .../web-api/interfaces/SelectOption.md | 25 - .../interfaces/SlackFileImageObject.md | 21 - .../web-api/interfaces/StarsListArguments.md | 132 - .../web-api/interfaces/StaticSelect.md | 170 - .../web-api/interfaces/Timepicker.md | 155 - .../ToolingTokensRotateArguments.md | 17 - .../reference/web-api/interfaces/URLInput.md | 134 - .../web-api/interfaces/UrlImageObject.md | 21 - .../interfaces/UsergroupsCreateArguments.md | 129 - .../interfaces/UsergroupsDisableArguments.md | 81 - .../interfaces/UsergroupsEnableArguments.md | 81 - .../interfaces/UsergroupsUpdateArguments.md | 161 - .../UsergroupsUsersListArguments.md | 77 - .../UsergroupsUsersUpdateArguments.md | 98 - .../interfaces/UsersConversationsArguments.md | 142 - .../interfaces/UsersDeletePhotoArguments.md | 25 - ...sersDiscoverableContactsLookupArguments.md | 45 - .../interfaces/UsersGetPresenceArguments.md | 41 - .../interfaces/UsersIdentityArguments.md | 25 - .../web-api/interfaces/UsersInfoArguments.md | 61 - .../web-api/interfaces/UsersListArguments.md | 112 - .../interfaces/UsersLookupByEmailArguments.md | 45 - .../interfaces/UsersProfileGetArguments.md | 58 - .../interfaces/UsersProfileSetArguments.md | 103 - .../web-api/interfaces/UsersSelect.md | 135 - .../interfaces/UsersSetPhotoArguments.md | 89 - .../interfaces/UsersSetPresenceArguments.md | 41 - .../web-api/interfaces/VideoBlock.md | 206 - .../interfaces/ViewsPublishArguments.md | 85 - .../web-api/interfaces/WebAPICallResult.md | 73 - .../web-api/interfaces/WebAPIHTTPError.md | 167 - .../web-api/interfaces/WebAPIPlatformError.md | 139 - .../interfaces/WebAPIRateLimitedError.md | 131 - .../web-api/interfaces/WebAPIRequestError.md | 131 - .../web-api/interfaces/WebClientOptions.md | 154 - .../web-api/interfaces/WorkflowButton.md | 153 - .../web-api/interfaces/WorkflowStepView.md | 79 - .../WorkflowsStepCompletedArguments.md | 49 - .../WorkflowsStepFailedArguments.md | 55 - .../WorkflowsUpdateStepArguments.md | 89 - .../web-api/type-aliases/APITestArguments.md | 21 - .../AdminAnalyticsGetFileArguments.md | 9 - .../AdminAnalyticsGetFileResponse.md | 47 - .../AdminAppsActivitiesListArguments.md | 9 - .../AdminAppsActivitiesListResponse.md | 47 - .../type-aliases/AdminAppsApproveArguments.md | 9 - .../type-aliases/AdminAppsApproveResponse.md | 41 - .../AdminAppsApprovedListArguments.md | 9 - .../AdminAppsApprovedListResponse.md | 53 - .../AdminAppsClearResolutionArguments.md | 9 - .../AdminAppsClearResolutionResponse.md | 41 - .../AdminAppsConfigLookupResponse.md | 47 - .../AdminAppsConfigSetResponse.md | 35 - .../AdminAppsRequestsCancelArguments.md | 9 - .../AdminAppsRequestsCancelResponse.md | 41 - .../AdminAppsRequestsListArguments.md | 9 - .../AdminAppsRequestsListResponse.md | 53 - .../AdminAppsRestrictArguments.md | 9 - .../type-aliases/AdminAppsRestrictResponse.md | 41 - .../AdminAppsRestrictedListArguments.md | 9 - .../AdminAppsRestrictedListResponse.md | 53 - .../AdminAppsUninstallArguments.md | 9 - .../AdminAppsUninstallResponse.md | 41 - .../AdminAuthPolicyAssignEntitiesResponse.md | 41 - .../AdminAuthPolicyGetEntitiesResponse.md | 47 - .../AdminAuthPolicyRemoveEntitiesResponse.md | 41 - .../AdminBarriersCreateResponse.md | 47 - .../AdminBarriersDeleteResponse.md | 35 - .../AdminBarriersListArguments.md | 9 - .../type-aliases/AdminBarriersListResponse.md | 41 - .../AdminBarriersUpdateResponse.md | 41 - .../AdminConversationsArchiveResponse.md | 35 - .../AdminConversationsBulkArchiveResponse.md | 53 - .../AdminConversationsBulkDeleteResponse.md | 53 - .../AdminConversationsBulkMoveResponse.md | 53 - ...inConversationsConvertToPrivateResponse.md | 35 - ...minConversationsConvertToPublicResponse.md | 41 - .../AdminConversationsCreateArguments.md | 41 - .../AdminConversationsCreateResponse.md | 47 - .../AdminConversationsDeleteResponse.md | 35 - ...inConversationsDisconnectSharedResponse.md | 35 - ...stOriginalConnectedChannelInfoArguments.md | 9 - ...istOriginalConnectedChannelInfoResponse.md | 35 - ...nversationsGetConversationPrefsResponse.md | 41 - ...ConversationsGetCustomRetentionResponse.md | 47 - .../AdminConversationsGetTeamsResponse.md | 41 - .../AdminConversationsInviteResponse.md | 41 - .../AdminConversationsLookupResponse.md | 47 - ...versationsRemoveCustomRetentionResponse.md | 35 - .../AdminConversationsRenameResponse.md | 35 - ...ersationsRestrictAccessAddGroupResponse.md | 41 - ...sationsRestrictAccessListGroupsResponse.md | 47 - ...ationsRestrictAccessRemoveGroupResponse.md | 41 - .../AdminConversationsSearchArguments.md | 9 - .../AdminConversationsSearchResponse.md | 59 - ...nversationsSetConversationPrefsResponse.md | 35 - ...ConversationsSetCustomRetentionResponse.md | 35 - .../AdminConversationsSetTeamsResponse.md | 41 - .../AdminConversationsUnarchiveResponse.md | 35 - .../AdminConversationsWhitelistAddResponse.md | 47 - ...telistListGroupsLinkedToChannelResponse.md | 53 - ...minConversationsWhitelistRemoveResponse.md | 47 - .../AdminEmojiAddAliasResponse.md | 41 - .../type-aliases/AdminEmojiAddResponse.md | 41 - .../type-aliases/AdminEmojiListArguments.md | 9 - .../type-aliases/AdminEmojiListResponse.md | 51 - .../type-aliases/AdminEmojiRemoveResponse.md | 41 - .../type-aliases/AdminEmojiRenameResponse.md | 41 - .../AdminFunctionsListResponse.md | 47 - ...AdminFunctionsPermissionsLookupResponse.md | 57 - .../AdminFunctionsPermissionsSetResponse.md | 41 - .../AdminInviteRequestsApproveResponse.md | 35 - ...AdminInviteRequestsApprovedListResponse.md | 47 - .../AdminInviteRequestsDeniedListResponse.md | 47 - .../AdminInviteRequestsDenyResponse.md | 35 - .../AdminInviteRequestsListResponse.md | 47 - .../AdminRolesAddAssignmentsResponse.md | 41 - .../AdminRolesListAssignmentsArguments.md | 9 - .../AdminRolesListAssignmentsResponse.md | 47 - .../AdminRolesRemoveAssignmentsResponse.md | 35 - .../AdminTeamsAdminsListResponse.md | 47 - .../type-aliases/AdminTeamsCreateResponse.md | 47 - .../type-aliases/AdminTeamsListArguments.md | 9 - .../type-aliases/AdminTeamsListResponse.md | 47 - .../AdminTeamsOwnersListResponse.md | 47 - .../AdminTeamsSettingsInfoResponse.md | 41 - ...TeamsSettingsSetDefaultChannelsResponse.md | 41 - ...dminTeamsSettingsSetDescriptionResponse.md | 35 - ...TeamsSettingsSetDiscoverabilityResponse.md | 35 - .../AdminTeamsSettingsSetIconResponse.md | 41 - .../AdminTeamsSettingsSetNameResponse.md | 35 - .../AdminUsergroupsAddChannelsResponse.md | 35 - .../AdminUsergroupsAddTeamsResponse.md | 35 - .../AdminUsergroupsListChannelsResponse.md | 41 - .../AdminUsergroupsRemoveChannelsResponse.md | 35 - .../type-aliases/AdminUsersAssignResponse.md | 35 - .../type-aliases/AdminUsersInviteResponse.md | 41 - .../type-aliases/AdminUsersListArguments.md | 9 - .../type-aliases/AdminUsersListResponse.md | 47 - .../type-aliases/AdminUsersRemoveResponse.md | 35 - .../AdminUsersSessionClearSettingsResponse.md | 35 - .../AdminUsersSessionGetSettingsResponse.md | 47 - .../AdminUsersSessionInvalidateResponse.md | 41 - .../AdminUsersSessionListArguments.md | 9 - .../AdminUsersSessionListResponse.md | 47 - .../AdminUsersSessionResetBulkResponse.md | 35 - .../AdminUsersSessionResetResponse.md | 35 - .../AdminUsersSessionSetSettingsResponse.md | 35 - .../AdminUsersSetAdminResponse.md | 35 - .../AdminUsersSetExpirationResponse.md | 35 - .../AdminUsersSetOwnerResponse.md | 35 - .../AdminUsersSetRegularResponse.md | 35 - ...nUsersUnsupportedVersionsExportResponse.md | 35 - .../AdminWorkflowsCollaboratorsAddResponse.md | 47 - ...minWorkflowsCollaboratorsRemoveResponse.md | 41 - ...AdminWorkflowsPermissionsLookupResponse.md | 45 - .../AdminWorkflowsSearchArguments.md | 9 - .../AdminWorkflowsSearchResponse.md | 53 - .../AdminWorkflowsUnpublishResponse.md | 41 - .../web-api/type-aliases/ApiTestResponse.md | 41 - .../AppsConnectionsOpenArguments.md | 9 - .../AppsConnectionsOpenResponse.md | 41 - .../AppsEventAuthorizationsListResponse.md | 41 - .../AppsManifestCreateResponse.md | 65 - .../AppsManifestDeleteResponse.md | 35 - .../AppsManifestExportResponse.md | 41 - .../AppsManifestUpdateResponse.md | 47 - .../AppsManifestValidateResponse.md | 47 - .../AppsPermissionsInfoResponse.md | 35 - .../AppsPermissionsRequestResponse.md | 35 - .../AppsPermissionsResourcesListResponse.md | 35 - .../AppsPermissionsScopesListResponse.md | 35 - .../AppsPermissionsUsersListResponse.md | 35 - .../AppsPermissionsUsersRequestResponse.md | 35 - .../type-aliases/AppsUninstallResponse.md | 41 - .../type-aliases/AuthRevokeArguments.md | 9 - .../type-aliases/AuthRevokeResponse.md | 35 - .../type-aliases/AuthTeamsListArguments.md | 9 - .../type-aliases/AuthTeamsListResponse.md | 47 - .../web-api/type-aliases/AuthTestArguments.md | 9 - .../web-api/type-aliases/AuthTestResponse.md | 101 - .../type-aliases/BookmarksAddResponse.md | 47 - .../type-aliases/BookmarksEditResponse.md | 47 - .../type-aliases/BookmarksListResponse.md | 47 - .../type-aliases/BookmarksRemoveResponse.md | 41 - .../web-api/type-aliases/BotsInfoArguments.md | 9 - .../web-api/type-aliases/BotsInfoResponse.md | 41 - .../web-api/type-aliases/CallUser.md | 13 - .../web-api/type-aliases/CallsAddResponse.md | 47 - .../web-api/type-aliases/CallsEndResponse.md | 41 - .../web-api/type-aliases/CallsInfoResponse.md | 41 - .../CallsParticipantsAddResponse.md | 41 - .../CallsParticipantsRemoveResponse.md | 41 - .../type-aliases/CallsUpdateResponse.md | 41 - .../CanvasesAccessDeleteResponse.md | 53 - .../type-aliases/CanvasesAccessSetResponse.md | 53 - .../type-aliases/CanvasesCreateArguments.md | 9 - .../type-aliases/CanvasesCreateResponse.md | 53 - .../type-aliases/CanvasesDeleteResponse.md | 41 - .../type-aliases/CanvasesEditResponse.md | 47 - .../CanvasesSectionsLookupResponse.md | 47 - .../type-aliases/ChannelsArchiveResponse.md | 35 - .../type-aliases/ChannelsCreateResponse.md | 41 - .../type-aliases/ChannelsHistoryResponse.md | 77 - .../type-aliases/ChannelsInfoResponse.md | 41 - .../type-aliases/ChannelsInviteResponse.md | 41 - .../type-aliases/ChannelsJoinResponse.md | 41 - .../type-aliases/ChannelsKickResponse.md | 35 - .../type-aliases/ChannelsLeaveResponse.md | 35 - .../type-aliases/ChannelsListResponse.md | 53 - .../type-aliases/ChannelsMarkResponse.md | 35 - .../type-aliases/ChannelsRenameResponse.md | 41 - .../type-aliases/ChannelsRepliesResponse.md | 59 - .../ChannelsSetPurposeResponse.md | 41 - .../type-aliases/ChannelsSetTopicResponse.md | 41 - .../type-aliases/ChannelsUnarchiveResponse.md | 35 - .../type-aliases/ChatDeleteResponse.md | 47 - .../ChatDeleteScheduledMessageResponse.md | 35 - .../type-aliases/ChatGetPermalinkResponse.md | 47 - .../type-aliases/ChatMeMessageResponse.md | 47 - .../ChatPostEphemeralArguments.md | 22 - .../type-aliases/ChatPostEphemeralResponse.md | 41 - .../type-aliases/ChatPostMessageArguments.md | 21 - .../type-aliases/ChatPostMessageResponse.md | 71 - .../ChatScheduleMessageArguments.md | 21 - .../ChatScheduleMessageResponse.md | 65 - .../ChatScheduledMessagesListArguments.md | 9 - .../ChatScheduledMessagesListResponse.md | 47 - .../type-aliases/ChatUnfurlArguments.md | 68 - .../type-aliases/ChatUnfurlResponse.md | 35 - .../type-aliases/ChatUpdateArguments.md | 43 - .../type-aliases/ChatUpdateResponse.md | 65 - .../type-aliases/ConversationFilter.md | 18 - ...onversationsAcceptSharedInviteArguments.md | 32 - ...ConversationsAcceptSharedInviteResponse.md | 59 - ...onversationsApproveSharedInviteResponse.md | 35 - .../ConversationsArchiveResponse.md | 35 - .../ConversationsCanvasesCreateResponse.md | 53 - .../ConversationsCloseResponse.md | 47 - .../ConversationsCreateResponse.md | 47 - ...onversationsDeclineSharedInviteResponse.md | 35 - ...onsExternalInvitePermissionsSetResponse.md | 35 - .../ConversationsHistoryResponse.md | 77 - .../type-aliases/ConversationsInfoResponse.md | 41 - .../ConversationsInviteResponse.md | 47 - .../ConversationsInviteSharedArguments.md | 21 - .../ConversationsInviteSharedResponse.md | 59 - .../type-aliases/ConversationsJoinResponse.md | 53 - .../type-aliases/ConversationsKickResponse.md | 35 - .../ConversationsLeaveResponse.md | 35 - .../ConversationsListArguments.md | 9 - ...onversationsListConnectInvitesArguments.md | 9 - ...ConversationsListConnectInvitesResponse.md | 53 - .../type-aliases/ConversationsListResponse.md | 47 - .../type-aliases/ConversationsMarkResponse.md | 35 - .../ConversationsMembersResponse.md | 47 - .../ConversationsOpenArguments.md | 32 - .../type-aliases/ConversationsOpenResponse.md | 53 - .../ConversationsRenameResponse.md | 41 - .../ConversationsRepliesResponse.md | 53 - .../ConversationsSetPurposeResponse.md | 41 - .../ConversationsSetTopicResponse.md | 41 - .../ConversationsUnarchiveResponse.md | 35 - .../type-aliases/DialogOpenResponse.md | 47 - .../type-aliases/DndEndDndArguments.md | 9 - .../web-api/type-aliases/DndEndDndResponse.md | 35 - .../type-aliases/DndEndSnoozeArguments.md | 9 - .../type-aliases/DndEndSnoozeResponse.md | 59 - .../web-api/type-aliases/DndInfoArguments.md | 9 - .../web-api/type-aliases/DndInfoResponse.md | 53 - .../type-aliases/DndSetSnoozeResponse.md | 59 - .../type-aliases/DndTeamInfoResponse.md | 45 - .../type-aliases/EmojiListArguments.md | 9 - .../web-api/type-aliases/EmojiListResponse.md | 63 - .../type-aliases/FilesCommentsAddResponse.md | 41 - .../FilesCommentsDeleteResponse.md | 35 - .../type-aliases/FilesCommentsEditResponse.md | 41 - .../FilesCompleteUploadExternalArguments.md | 31 - .../FilesCompleteUploadExternalResponse.md | 47 - .../type-aliases/FilesDeleteResponse.md | 35 - .../FilesGetUploadURLExternalResponse.md | 53 - .../web-api/type-aliases/FilesInfoResponse.md | 83 - .../web-api/type-aliases/FilesListResponse.md | 47 - .../type-aliases/FilesRemoteAddResponse.md | 41 - .../type-aliases/FilesRemoteInfoArguments.md | 9 - .../type-aliases/FilesRemoteInfoResponse.md | 41 - .../type-aliases/FilesRemoteListResponse.md | 47 - .../FilesRemoteRemoveArguments.md | 9 - .../type-aliases/FilesRemoteRemoveResponse.md | 35 - .../type-aliases/FilesRemoteShareArguments.md | 9 - .../type-aliases/FilesRemoteShareResponse.md | 41 - .../FilesRemoteUpdateArguments.md | 9 - .../type-aliases/FilesRemoteUpdateResponse.md | 41 - .../FilesRevokePublicURLResponse.md | 41 - .../FilesSharedPublicURLResponse.md | 41 - .../type-aliases/FilesUploadArguments.md | 9 - .../type-aliases/FilesUploadResponse.md | 41 - .../type-aliases/FilesUploadV2Arguments.md | 9 - .../FunctionsCompleteErrorResponse.md | 35 - .../FunctionsCompleteSuccessResponse.md | 35 - .../type-aliases/GroupsArchiveResponse.md | 47 - .../type-aliases/GroupsCloseResponse.md | 35 - .../type-aliases/GroupsCreateChildResponse.md | 53 - .../type-aliases/GroupsCreateResponse.md | 53 - .../type-aliases/GroupsHistoryResponse.md | 65 - .../type-aliases/GroupsInfoResponse.md | 53 - .../type-aliases/GroupsInviteResponse.md | 53 - .../type-aliases/GroupsKickResponse.md | 47 - .../type-aliases/GroupsLeaveResponse.md | 47 - .../type-aliases/GroupsListResponse.md | 53 - .../type-aliases/GroupsMarkResponse.md | 47 - .../type-aliases/GroupsOpenResponse.md | 59 - .../type-aliases/GroupsRenameResponse.md | 53 - .../type-aliases/GroupsRepliesResponse.md | 59 - .../type-aliases/GroupsSetPurposeResponse.md | 53 - .../type-aliases/GroupsSetTopicResponse.md | 53 - .../type-aliases/GroupsUnarchiveResponse.md | 47 - .../web-api/type-aliases/ImCloseResponse.md | 47 - .../web-api/type-aliases/ImHistoryResponse.md | 65 - .../web-api/type-aliases/ImListResponse.md | 53 - .../web-api/type-aliases/ImMarkResponse.md | 47 - .../web-api/type-aliases/ImOpenResponse.md | 65 - .../web-api/type-aliases/ImRepliesResponse.md | 59 - .../web-api/type-aliases/ImageBlock.md | 51 - .../web-api/type-aliases/ImageElement.md | 40 - .../web-api/type-aliases/KnownBlock.md | 19 - .../type-aliases/MigrationExchangeResponse.md | 69 - .../web-api/type-aliases/MpimCloseResponse.md | 47 - .../type-aliases/MpimHistoryResponse.md | 65 - .../web-api/type-aliases/MpimListResponse.md | 53 - .../web-api/type-aliases/MpimMarkResponse.md | 47 - .../web-api/type-aliases/MpimOpenResponse.md | 53 - .../type-aliases/MpimRepliesResponse.md | 59 - .../web-api/type-aliases/MultiSelect.md | 28 - .../type-aliases/OauthAccessResponse.md | 113 - .../type-aliases/OauthTokenResponse.md | 41 - .../type-aliases/OauthV2AccessResponse.md | 113 - .../type-aliases/OauthV2ExchangeResponse.md | 119 - .../OpenIDConnectTokenResponse.md | 71 - .../OpenIDConnectUserInfoArguments.md | 9 - .../OpenIDConnectUserInfoResponse.md | 221 - .../reference/web-api/type-aliases/Option.md | 18 - .../web-api/type-aliases/PageAccumulator.md | 13 - .../web-api/type-aliases/PinsAddResponse.md | 35 - .../web-api/type-aliases/PinsListResponse.md | 41 - .../type-aliases/PinsRemoveResponse.md | 35 - .../type-aliases/RTMConnectArguments.md | 9 - .../web-api/type-aliases/RTMStartArguments.md | 9 - .../type-aliases/ReactionsAddResponse.md | 35 - .../type-aliases/ReactionsGetArguments.md | 9 - .../type-aliases/ReactionsGetResponse.md | 53 - .../type-aliases/ReactionsListArguments.md | 9 - .../type-aliases/ReactionsListResponse.md | 53 - .../type-aliases/ReactionsRemoveArguments.md | 9 - .../type-aliases/ReactionsRemoveResponse.md | 35 - .../type-aliases/RemindersAddResponse.md | 47 - .../type-aliases/RemindersCompleteResponse.md | 35 - .../type-aliases/RemindersDeleteResponse.md | 35 - .../type-aliases/RemindersInfoResponse.md | 41 - .../type-aliases/RemindersListArguments.md | 9 - .../type-aliases/RemindersListResponse.md | 41 - .../web-api/type-aliases/RichTextElement.md | 23 - .../type-aliases/RtmConnectResponse.md | 53 - .../web-api/type-aliases/RtmStartResponse.md | 173 - .../web-api/type-aliases/SearchAllResponse.md | 59 - .../type-aliases/SearchFilesResponse.md | 47 - .../type-aliases/SearchMessagesResponse.md | 47 - .../reference/web-api/type-aliases/Select.md | 27 - .../web-api/type-aliases/SlackFile.md | 20 - .../type-aliases/StarsAddRemoveArguments.md | 9 - .../web-api/type-aliases/StarsAddResponse.md | 35 - .../web-api/type-aliases/StarsListResponse.md | 47 - .../type-aliases/StarsRemoveResponse.md | 35 - .../web-api/type-aliases/TLSOptions.md | 14 - .../type-aliases/TeamAccessLogsArguments.md | 9 - .../type-aliases/TeamAccessLogsResponse.md | 53 - .../type-aliases/TeamBillableInfoArguments.md | 9 - .../type-aliases/TeamBillableInfoResponse.md | 51 - .../type-aliases/TeamBillingInfoArguments.md | 9 - .../type-aliases/TeamBillingInfoResponse.md | 41 - .../TeamExternalTeamsDisconnectArguments.md | 9 - .../TeamExternalTeamsDisconnectResponse.md | 41 - .../TeamExternalTeamsListArguments.md | 9 - .../TeamExternalTeamsListResponse.md | 53 - .../web-api/type-aliases/TeamInfoArguments.md | 9 - .../web-api/type-aliases/TeamInfoResponse.md | 41 - .../TeamIntegrationLogsArguments.md | 9 - .../TeamIntegrationLogsResponse.md | 47 - .../TeamPreferencesListArguments.md | 9 - .../TeamPreferencesListResponse.md | 65 - .../type-aliases/TeamProfileGetArguments.md | 9 - .../type-aliases/TeamProfileGetResponse.md | 41 - .../ToolingTokensRotateResponse.md | 77 - .../type-aliases/UsergroupsCreateResponse.md | 41 - .../type-aliases/UsergroupsDisableResponse.md | 41 - .../type-aliases/UsergroupsEnableResponse.md | 41 - .../type-aliases/UsergroupsListArguments.md | 9 - .../type-aliases/UsergroupsListResponse.md | 41 - .../type-aliases/UsergroupsUpdateResponse.md | 41 - .../UsergroupsUsersListResponse.md | 41 - .../UsergroupsUsersUpdateResponse.md | 41 - .../UsersConversationsResponse.md | 47 - .../type-aliases/UsersDeletePhotoResponse.md | 35 - ...UsersDiscoverableContactsLookupResponse.md | 47 - .../type-aliases/UsersGetPresenceResponse.md | 77 - .../type-aliases/UsersIdentityResponse.md | 53 - .../web-api/type-aliases/UsersInfoResponse.md | 41 - .../web-api/type-aliases/UsersListResponse.md | 65 - .../UsersLookupByEmailResponse.md | 47 - .../type-aliases/UsersProfileGetResponse.md | 41 - .../type-aliases/UsersProfileSetResponse.md | 47 - .../type-aliases/UsersSetActiveResponse.md | 35 - .../type-aliases/UsersSetPhotoResponse.md | 41 - .../type-aliases/UsersSetPresenceResponse.md | 35 - .../reference/web-api/type-aliases/View.md | 9 - .../type-aliases/ViewsOpenArguments.md | 9 - .../web-api/type-aliases/ViewsOpenResponse.md | 53 - .../type-aliases/ViewsPublishResponse.md | 53 - .../type-aliases/ViewsPushArguments.md | 9 - .../web-api/type-aliases/ViewsPushResponse.md | 53 - .../type-aliases/ViewsUpdateArguments.md | 9 - .../type-aliases/ViewsUpdateResponse.md | 53 - .../web-api/type-aliases/WebAPICallError.md | 9 - .../WorkflowsStepCompletedResponse.md | 35 - .../WorkflowsStepFailedResponse.md | 35 - .../WorkflowsUpdateStepResponse.md | 35 - .../reference/web-api/typedoc-sidebar.cjs | 4 - .../web-api/variables/retryPolicies.md | 29 - .../webhook/classes/IncomingWebhook.md | 49 - .../webhook/enumerations/ErrorCode.md | 27 - docs/content/reference/webhook/index.md | 22 - .../webhook/interfaces/CodedError.md | 24 - .../IncomingWebhookDefaultArguments.md | 101 - .../interfaces/IncomingWebhookHTTPError.md | 35 - .../interfaces/IncomingWebhookRequestError.md | 35 - .../interfaces/IncomingWebhookResult.md | 13 - .../IncomingWebhookSendArguments.md | 205 - .../type-aliases/IncomingWebhookSendError.md | 9 - .../reference/webhook/typedoc-sidebar.cjs | 4 - 885 files changed, 2 insertions(+), 66438 deletions(-) delete mode 100644 docs/content/reference/cli-test/classes/SlackCLIProcess.md delete mode 100644 docs/content/reference/cli-test/index.md delete mode 100644 docs/content/reference/cli-test/typedoc-sidebar.cjs delete mode 100644 docs/content/reference/cli-test/variables/SlackCLI.md delete mode 100644 docs/content/reference/cli-test/variables/SlackProduct.md delete mode 100644 docs/content/reference/cli-test/variables/SlackTracerId.md delete mode 100644 docs/content/reference/cli-test/variables/shell.md delete mode 100644 docs/content/reference/events-api/classes/SlackEventAdapter.md delete mode 100644 docs/content/reference/events-api/enumerations/ErrorCode.md delete mode 100644 docs/content/reference/events-api/functions/createEventAdapter.md delete mode 100644 docs/content/reference/events-api/functions/verifyRequestSignature.md delete mode 100644 docs/content/reference/events-api/index.md delete mode 100644 docs/content/reference/events-api/interfaces/CodedError.md delete mode 100644 docs/content/reference/events-api/interfaces/EventAdapterOptions.md delete mode 100644 docs/content/reference/events-api/interfaces/VerifyRequestSignatureParams.md delete mode 100644 docs/content/reference/events-api/typedoc-sidebar.cjs delete mode 100644 docs/content/reference/events-api/variables/errorCodes.md delete mode 100644 docs/content/reference/interactive-messages/classes/SlackMessageAdapter.md delete mode 100644 docs/content/reference/interactive-messages/enumerations/ErrorCode.md delete mode 100644 docs/content/reference/interactive-messages/enumerations/ResponseStatus.md delete mode 100644 docs/content/reference/interactive-messages/functions/createMessageAdapter.md delete mode 100644 docs/content/reference/interactive-messages/index.md delete mode 100644 docs/content/reference/interactive-messages/interfaces/ActionConstraints.md delete mode 100644 docs/content/reference/interactive-messages/interfaces/DispatchResult.md delete mode 100644 docs/content/reference/interactive-messages/interfaces/MessageAdapterOptions.md delete mode 100644 docs/content/reference/interactive-messages/interfaces/OptionsConstraints.md delete mode 100644 docs/content/reference/interactive-messages/interfaces/ShortcutConstraints.md delete mode 100644 docs/content/reference/interactive-messages/interfaces/ViewConstraints.md delete mode 100644 docs/content/reference/interactive-messages/type-aliases/ActionHandler.md delete mode 100644 docs/content/reference/interactive-messages/type-aliases/OptionsHandler.md delete mode 100644 docs/content/reference/interactive-messages/type-aliases/Respond.md delete mode 100644 docs/content/reference/interactive-messages/type-aliases/ShortcutHandler.md delete mode 100644 docs/content/reference/interactive-messages/type-aliases/ViewClosedHandler.md delete mode 100644 docs/content/reference/interactive-messages/type-aliases/ViewSubmissionHandler.md delete mode 100644 docs/content/reference/interactive-messages/typedoc-sidebar.cjs delete mode 100644 docs/content/reference/interactive-messages/variables/errorCodes.md delete mode 100644 docs/content/reference/logger/classes/ConsoleLogger.md delete mode 100644 docs/content/reference/logger/enumerations/LogLevel.md delete mode 100644 docs/content/reference/logger/index.md delete mode 100644 docs/content/reference/logger/interfaces/Logger.md delete mode 100644 docs/content/reference/logger/typedoc-sidebar.cjs delete mode 100644 docs/content/reference/oauth/classes/AuthorizationError.md delete mode 100644 docs/content/reference/oauth/classes/ClearStateStore.md delete mode 100644 docs/content/reference/oauth/classes/FileInstallationStore.md delete mode 100644 docs/content/reference/oauth/classes/FileStateStore.md delete mode 100644 docs/content/reference/oauth/classes/GenerateInstallUrlError.md delete mode 100644 docs/content/reference/oauth/classes/InstallProvider.md delete mode 100644 docs/content/reference/oauth/classes/InstallerInitializationError.md delete mode 100644 docs/content/reference/oauth/classes/InvalidStateError.md delete mode 100644 docs/content/reference/oauth/classes/MemoryInstallationStore.md delete mode 100644 docs/content/reference/oauth/classes/MissingCodeError.md delete mode 100644 docs/content/reference/oauth/classes/MissingStateError.md delete mode 100644 docs/content/reference/oauth/classes/UnknownError.md delete mode 100644 docs/content/reference/oauth/enumerations/ErrorCode.md delete mode 100644 docs/content/reference/oauth/functions/defaultCallbackFailure.md delete mode 100644 docs/content/reference/oauth/functions/defaultCallbackSuccess.md delete mode 100644 docs/content/reference/oauth/functions/defaultRenderHtmlForInstallPath.md delete mode 100644 docs/content/reference/oauth/index.md delete mode 100644 docs/content/reference/oauth/interfaces/AuthorizeResult.md delete mode 100644 docs/content/reference/oauth/interfaces/CallbackOptions.md delete mode 100644 docs/content/reference/oauth/interfaces/CodedError.md delete mode 100644 docs/content/reference/oauth/interfaces/FileStateStoreArgs.md delete mode 100644 docs/content/reference/oauth/interfaces/InstallPathOptions.md delete mode 100644 docs/content/reference/oauth/interfaces/InstallProviderOptions.md delete mode 100644 docs/content/reference/oauth/interfaces/InstallURLOptions.md delete mode 100644 docs/content/reference/oauth/interfaces/Installation.md delete mode 100644 docs/content/reference/oauth/interfaces/InstallationQuery.md delete mode 100644 docs/content/reference/oauth/interfaces/InstallationStore.md delete mode 100644 docs/content/reference/oauth/interfaces/OAuthV2Response.md delete mode 100644 docs/content/reference/oauth/interfaces/OAuthV2TokenRefreshResponse.md delete mode 100644 docs/content/reference/oauth/interfaces/StateObj.md delete mode 100644 docs/content/reference/oauth/interfaces/StateStore.md delete mode 100644 docs/content/reference/oauth/type-aliases/OrgInstallation.md delete mode 100644 docs/content/reference/oauth/type-aliases/OrgInstallationQuery.md delete mode 100644 docs/content/reference/oauth/typedoc-sidebar.cjs delete mode 100644 docs/content/reference/oauth/variables/Logger.md delete mode 100644 docs/content/reference/rtm-api/classes/RTMClient.md delete mode 100644 docs/content/reference/rtm-api/enumerations/ErrorCode.md delete mode 100644 docs/content/reference/rtm-api/index.md delete mode 100644 docs/content/reference/rtm-api/interfaces/CodedError.md delete mode 100644 docs/content/reference/rtm-api/interfaces/RTMCallResult.md delete mode 100644 docs/content/reference/rtm-api/interfaces/RTMClientOptions.md delete mode 100644 docs/content/reference/rtm-api/interfaces/RTMNoReplyReceivedError.md delete mode 100644 docs/content/reference/rtm-api/interfaces/RTMPlatformError.md delete mode 100644 docs/content/reference/rtm-api/interfaces/RTMSendWhileDisconnectedError.md delete mode 100644 docs/content/reference/rtm-api/interfaces/RTMSendWhileNotReadyError.md delete mode 100644 docs/content/reference/rtm-api/interfaces/RTMWebsocketError.md delete mode 100644 docs/content/reference/rtm-api/type-aliases/RTMCallError.md delete mode 100644 docs/content/reference/rtm-api/type-aliases/RTMStartOptions.md delete mode 100644 docs/content/reference/rtm-api/typedoc-sidebar.cjs delete mode 100644 docs/content/reference/rtm-api/variables/Logger.md delete mode 100644 docs/content/reference/socket-mode/classes/SocketModeClient.md delete mode 100644 docs/content/reference/socket-mode/enumerations/ErrorCode.md delete mode 100644 docs/content/reference/socket-mode/enumerations/UnrecoverableSocketModeStartError.md delete mode 100644 docs/content/reference/socket-mode/index.md delete mode 100644 docs/content/reference/socket-mode/interfaces/SMNoReplyReceivedError.md delete mode 100644 docs/content/reference/socket-mode/interfaces/SMPlatformError.md delete mode 100644 docs/content/reference/socket-mode/interfaces/SMSendWhileDisconnectedError.md delete mode 100644 docs/content/reference/socket-mode/interfaces/SMSendWhileNotReadyError.md delete mode 100644 docs/content/reference/socket-mode/interfaces/SMWebsocketError.md delete mode 100644 docs/content/reference/socket-mode/interfaces/SocketModeOptions.md delete mode 100644 docs/content/reference/socket-mode/type-aliases/SMCallError.md delete mode 100644 docs/content/reference/socket-mode/typedoc-sidebar.cjs delete mode 100644 docs/content/reference/socket-mode/variables/Logger.md delete mode 100644 docs/content/reference/types/index.md delete mode 100644 docs/content/reference/types/interfaces/Action.md delete mode 100644 docs/content/reference/types/interfaces/Actionable.md delete mode 100644 docs/content/reference/types/interfaces/ActionsBlock.md delete mode 100644 docs/content/reference/types/interfaces/Block.md delete mode 100644 docs/content/reference/types/interfaces/Button.md delete mode 100644 docs/content/reference/types/interfaces/CallUserExternal.md delete mode 100644 docs/content/reference/types/interfaces/CallUserSlack.md delete mode 100644 docs/content/reference/types/interfaces/ChannelsSelect.md delete mode 100644 docs/content/reference/types/interfaces/Checkboxes.md delete mode 100644 docs/content/reference/types/interfaces/Confirm.md delete mode 100644 docs/content/reference/types/interfaces/Confirmable.md delete mode 100644 docs/content/reference/types/interfaces/Confirmation.md delete mode 100644 docs/content/reference/types/interfaces/ConfirmationDialog.md delete mode 100644 docs/content/reference/types/interfaces/ContextBlock.md delete mode 100644 docs/content/reference/types/interfaces/ConversationsSelect.md delete mode 100644 docs/content/reference/types/interfaces/DateTimepicker.md delete mode 100644 docs/content/reference/types/interfaces/Datepicker.md delete mode 100644 docs/content/reference/types/interfaces/Dialog.md delete mode 100644 docs/content/reference/types/interfaces/DispatchActionConfig.md delete mode 100644 docs/content/reference/types/interfaces/Dispatchable.md delete mode 100644 docs/content/reference/types/interfaces/DividerBlock.md delete mode 100644 docs/content/reference/types/interfaces/EmailInput.md delete mode 100644 docs/content/reference/types/interfaces/ExternalSelect.md delete mode 100644 docs/content/reference/types/interfaces/FileBlock.md delete mode 100644 docs/content/reference/types/interfaces/FileInput.md delete mode 100644 docs/content/reference/types/interfaces/Focusable.md delete mode 100644 docs/content/reference/types/interfaces/HeaderBlock.md delete mode 100644 docs/content/reference/types/interfaces/HomeView.md delete mode 100644 docs/content/reference/types/interfaces/InputBlock.md delete mode 100644 docs/content/reference/types/interfaces/LinkUnfurls.md delete mode 100644 docs/content/reference/types/interfaces/MaxItemsSelectable.md delete mode 100644 docs/content/reference/types/interfaces/MessageAttachment.md delete mode 100644 docs/content/reference/types/interfaces/MessageAttachmentField.md delete mode 100644 docs/content/reference/types/interfaces/MessageMetadata.md delete mode 100644 docs/content/reference/types/interfaces/MessageMetadataEventPayloadObject.md delete mode 100644 docs/content/reference/types/interfaces/ModalView.md delete mode 100644 docs/content/reference/types/interfaces/MrkdwnElement.md delete mode 100644 docs/content/reference/types/interfaces/MrkdwnOption.md delete mode 100644 docs/content/reference/types/interfaces/MultiChannelsSelect.md delete mode 100644 docs/content/reference/types/interfaces/MultiConversationsSelect.md delete mode 100644 docs/content/reference/types/interfaces/MultiExternalSelect.md delete mode 100644 docs/content/reference/types/interfaces/MultiStaticSelect.md delete mode 100644 docs/content/reference/types/interfaces/MultiUsersSelect.md delete mode 100644 docs/content/reference/types/interfaces/NumberInput.md delete mode 100644 docs/content/reference/types/interfaces/OptionGroup.md delete mode 100644 docs/content/reference/types/interfaces/Overflow.md delete mode 100644 docs/content/reference/types/interfaces/Placeholdable.md delete mode 100644 docs/content/reference/types/interfaces/PlainTextElement.md delete mode 100644 docs/content/reference/types/interfaces/PlainTextInput.md delete mode 100644 docs/content/reference/types/interfaces/PlainTextOption.md delete mode 100644 docs/content/reference/types/interfaces/RadioButtons.md delete mode 100644 docs/content/reference/types/interfaces/RichTextBlock.md delete mode 100644 docs/content/reference/types/interfaces/RichTextBorderable.md delete mode 100644 docs/content/reference/types/interfaces/RichTextBroadcastMention.md delete mode 100644 docs/content/reference/types/interfaces/RichTextChannelMention.md delete mode 100644 docs/content/reference/types/interfaces/RichTextColor.md delete mode 100644 docs/content/reference/types/interfaces/RichTextDate.md delete mode 100644 docs/content/reference/types/interfaces/RichTextEmoji.md delete mode 100644 docs/content/reference/types/interfaces/RichTextInput.md delete mode 100644 docs/content/reference/types/interfaces/RichTextLink.md delete mode 100644 docs/content/reference/types/interfaces/RichTextList.md delete mode 100644 docs/content/reference/types/interfaces/RichTextPreformatted.md delete mode 100644 docs/content/reference/types/interfaces/RichTextQuote.md delete mode 100644 docs/content/reference/types/interfaces/RichTextSection.md delete mode 100644 docs/content/reference/types/interfaces/RichTextStyleable.md delete mode 100644 docs/content/reference/types/interfaces/RichTextTeamMention.md delete mode 100644 docs/content/reference/types/interfaces/RichTextText.md delete mode 100644 docs/content/reference/types/interfaces/RichTextUserMention.md delete mode 100644 docs/content/reference/types/interfaces/RichTextUsergroupMention.md delete mode 100644 docs/content/reference/types/interfaces/SectionBlock.md delete mode 100644 docs/content/reference/types/interfaces/SelectOption.md delete mode 100644 docs/content/reference/types/interfaces/SlackFileImageObject.md delete mode 100644 docs/content/reference/types/interfaces/StaticSelect.md delete mode 100644 docs/content/reference/types/interfaces/Timepicker.md delete mode 100644 docs/content/reference/types/interfaces/URLInput.md delete mode 100644 docs/content/reference/types/interfaces/URLRespondable.md delete mode 100644 docs/content/reference/types/interfaces/UrlImageObject.md delete mode 100644 docs/content/reference/types/interfaces/UsersSelect.md delete mode 100644 docs/content/reference/types/interfaces/VideoBlock.md delete mode 100644 docs/content/reference/types/interfaces/WorkflowButton.md delete mode 100644 docs/content/reference/types/interfaces/WorkflowStepView.md delete mode 100644 docs/content/reference/types/type-aliases/ActionsBlockElement.md delete mode 100644 docs/content/reference/types/type-aliases/AnyBlock.md delete mode 100644 docs/content/reference/types/type-aliases/CallUser.md delete mode 100644 docs/content/reference/types/type-aliases/ColorScheme.md delete mode 100644 docs/content/reference/types/type-aliases/ContextBlockElement.md delete mode 100644 docs/content/reference/types/type-aliases/ConversationFilter.md delete mode 100644 docs/content/reference/types/type-aliases/ConversationType.md delete mode 100644 docs/content/reference/types/type-aliases/ImageBlock.md delete mode 100644 docs/content/reference/types/type-aliases/ImageElement.md delete mode 100644 docs/content/reference/types/type-aliases/InputBlockElement.md delete mode 100644 docs/content/reference/types/type-aliases/KnownBlock.md delete mode 100644 docs/content/reference/types/type-aliases/MultiSelect.md delete mode 100644 docs/content/reference/types/type-aliases/Option.md delete mode 100644 docs/content/reference/types/type-aliases/RichTextBlockElement.md delete mode 100644 docs/content/reference/types/type-aliases/RichTextElement.md delete mode 100644 docs/content/reference/types/type-aliases/SectionBlockAccessory.md delete mode 100644 docs/content/reference/types/type-aliases/Select.md delete mode 100644 docs/content/reference/types/type-aliases/SlackFile.md delete mode 100644 docs/content/reference/types/type-aliases/TextObject.md delete mode 100644 docs/content/reference/types/type-aliases/View.md delete mode 100644 docs/content/reference/types/typedoc-sidebar.cjs delete mode 100644 docs/content/reference/web-api/classes/Methods.md delete mode 100644 docs/content/reference/web-api/classes/WebClient.md delete mode 100644 docs/content/reference/web-api/enumerations/ErrorCode.md delete mode 100644 docs/content/reference/web-api/enumerations/LogLevel.md delete mode 100644 docs/content/reference/web-api/enumerations/WebClientEvent.md delete mode 100644 docs/content/reference/web-api/functions/addAppMetadata.md delete mode 100644 docs/content/reference/web-api/index.md delete mode 100644 docs/content/reference/web-api/interfaces/Action.md delete mode 100644 docs/content/reference/web-api/interfaces/Actionable.md delete mode 100644 docs/content/reference/web-api/interfaces/ActionsBlock.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminAnalyticsMemberDetails.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelDetails.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelMetadataDetails.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminAppsConfigLookupArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminAppsConfigSetArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminAuthPolicyAssignEntitiesArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminAuthPolicyGetEntitiesArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminAuthPolicyRemoveEntitiesArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminBarriersCreateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminBarriersDeleteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminBarriersUpdateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsArchiveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsBulkArchiveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsBulkDeleteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsBulkMoveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsConvertToPrivateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsConvertToPublicArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsDeleteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsDisconnectSharedArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsGetConversationPrefsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsGetCustomRetentionArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsGetTeamsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsInviteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsLookupArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsRemoveCustomRetentionArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsRenameArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessAddGroupArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessListGroupsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessRemoveGroupArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsSetConversationPrefsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsSetCustomRetentionArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsSetTeamsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminConversationsUnarchiveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminEmojiAddAliasArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminEmojiAddArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminEmojiRemoveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminEmojiRenameArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminFunctionsListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsLookupArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsSetArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminInviteRequestsApproveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminInviteRequestsApprovedListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminInviteRequestsDeniedListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminInviteRequestsDenyArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminInviteRequestsListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminRolesAddAssignmentsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminRolesRemoveAssignmentsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminTeamsAdminsListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminTeamsCreateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminTeamsOwnersListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminTeamsSettingsInfoArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDefaultChannelsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDescriptionArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDiscoverabilityArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetIconArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetNameArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsergroupsAddChannelsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsergroupsAddTeamsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsergroupsListChannelsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsergroupsRemoveChannelsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersAssignArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersInviteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersRemoveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersSessionClearSettingsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersSessionGetSettingsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersSessionInvalidateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersSessionResetArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersSessionResetBulkArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersSessionSetSettingsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersSetAdminArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersSetExpirationArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersSetOwnerArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersSetRegularArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminUsersUnsupportedVersionsExportArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsAddArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsRemoveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminWorkflowsPermissionsLookupArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AdminWorkflowsUnpublishArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AppsEventAuthorizationsListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AppsManifestCreateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AppsManifestDeleteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AppsManifestExportArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AppsManifestUpdateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AppsManifestValidateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AppsUninstallArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/AttachmentAction.md delete mode 100644 docs/content/reference/web-api/interfaces/Block.md delete mode 100644 docs/content/reference/web-api/interfaces/BookmarksAddArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/BookmarksEditArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/BookmarksListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/BookmarksRemoveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/Button.md delete mode 100644 docs/content/reference/web-api/interfaces/CallUserExternal.md delete mode 100644 docs/content/reference/web-api/interfaces/CallUserSlack.md delete mode 100644 docs/content/reference/web-api/interfaces/CallsAddArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/CallsEndArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/CallsInfoArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/CallsParticipantsAddArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/CallsParticipantsRemoveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/CallsUpdateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/CanvasesAccessDeleteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/CanvasesAccessSetArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/CanvasesDeleteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/CanvasesEditArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/CanvasesSectionsLookupArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ChannelsSelect.md delete mode 100644 docs/content/reference/web-api/interfaces/ChatDeleteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ChatDeleteScheduledMessageArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ChatGetPermalinkArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ChatMeMessageArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/Checkboxes.md delete mode 100644 docs/content/reference/web-api/interfaces/CodedError.md delete mode 100644 docs/content/reference/web-api/interfaces/Confirm.md delete mode 100644 docs/content/reference/web-api/interfaces/Confirmable.md delete mode 100644 docs/content/reference/web-api/interfaces/Confirmation.md delete mode 100644 docs/content/reference/web-api/interfaces/ConfirmationDialog.md delete mode 100644 docs/content/reference/web-api/interfaces/ContextBlock.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsApproveSharedInviteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsArchiveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsCloseArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsCreateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsDeclineSharedInviteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsExternalInvitePermissionsSetArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsHistoryArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsInfoArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsInviteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsJoinArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsKickArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsLeaveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsMarkArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsMembersArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsRenameArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsRepliesArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsSelect.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsSetPurposeArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsSetTopicArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ConversationsUnarchiveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/DateTimepicker.md delete mode 100644 docs/content/reference/web-api/interfaces/Datepicker.md delete mode 100644 docs/content/reference/web-api/interfaces/Dialog.md delete mode 100644 docs/content/reference/web-api/interfaces/DialogOpenArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/DispatchActionConfig.md delete mode 100644 docs/content/reference/web-api/interfaces/Dispatchable.md delete mode 100644 docs/content/reference/web-api/interfaces/DividerBlock.md delete mode 100644 docs/content/reference/web-api/interfaces/DndSetSnoozeArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/DndTeamInfoArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/EmailInput.md delete mode 100644 docs/content/reference/web-api/interfaces/ExternalSelect.md delete mode 100644 docs/content/reference/web-api/interfaces/FileBlock.md delete mode 100644 docs/content/reference/web-api/interfaces/FileInput.md delete mode 100644 docs/content/reference/web-api/interfaces/FilesCommentsDeleteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/FilesDeleteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/FilesGetUploadURLExternalArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/FilesInfoArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/FilesListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/FilesRemoteAddArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/FilesRemoteListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/FilesRevokePublicURLArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/FilesSharedPublicURLArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/Focusable.md delete mode 100644 docs/content/reference/web-api/interfaces/FunctionsCompleteErrorArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/FunctionsCompleteSuccessArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/HeaderBlock.md delete mode 100644 docs/content/reference/web-api/interfaces/HomeView.md delete mode 100644 docs/content/reference/web-api/interfaces/InputBlock.md delete mode 100644 docs/content/reference/web-api/interfaces/LinkUnfurls.md delete mode 100644 docs/content/reference/web-api/interfaces/Logger.md delete mode 100644 docs/content/reference/web-api/interfaces/MessageAttachment.md delete mode 100644 docs/content/reference/web-api/interfaces/MessageAttachmentField.md delete mode 100644 docs/content/reference/web-api/interfaces/MessageAttachmentPreview.md delete mode 100644 docs/content/reference/web-api/interfaces/MessageMetadata.md delete mode 100644 docs/content/reference/web-api/interfaces/MessageMetadataEventPayloadObject.md delete mode 100644 docs/content/reference/web-api/interfaces/Method.md delete mode 100644 docs/content/reference/web-api/interfaces/MigrationExchangeArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/ModalView.md delete mode 100644 docs/content/reference/web-api/interfaces/MrkdwnElement.md delete mode 100644 docs/content/reference/web-api/interfaces/MrkdwnOption.md delete mode 100644 docs/content/reference/web-api/interfaces/MultiChannelsSelect.md delete mode 100644 docs/content/reference/web-api/interfaces/MultiConversationsSelect.md delete mode 100644 docs/content/reference/web-api/interfaces/MultiExternalSelect.md delete mode 100644 docs/content/reference/web-api/interfaces/MultiStaticSelect.md delete mode 100644 docs/content/reference/web-api/interfaces/MultiUsersSelect.md delete mode 100644 docs/content/reference/web-api/interfaces/NumberInput.md delete mode 100644 docs/content/reference/web-api/interfaces/OAuthAccessArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/OAuthV2AccessArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/OAuthV2ExchangeArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/OpenIDConnectTokenArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/OptionField.md delete mode 100644 docs/content/reference/web-api/interfaces/OptionGroup.md delete mode 100644 docs/content/reference/web-api/interfaces/Overflow.md delete mode 100644 docs/content/reference/web-api/interfaces/PageReducer.md delete mode 100644 docs/content/reference/web-api/interfaces/PaginatePredicate.md delete mode 100644 docs/content/reference/web-api/interfaces/PinsAddArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/PinsListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/PinsRemoveArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/Placeholdable.md delete mode 100644 docs/content/reference/web-api/interfaces/PlainTextElement.md delete mode 100644 docs/content/reference/web-api/interfaces/PlainTextInput.md delete mode 100644 docs/content/reference/web-api/interfaces/PlainTextOption.md delete mode 100644 docs/content/reference/web-api/interfaces/RadioButtons.md delete mode 100644 docs/content/reference/web-api/interfaces/ReactionsAddArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/RemindersAddArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/RemindersCompleteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/RemindersDeleteArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/RemindersInfoArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/RetryOptions.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextBlock.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextBroadcastMention.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextChannelMention.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextColor.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextDate.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextEmoji.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextInput.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextLink.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextList.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextPreformatted.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextQuote.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextSection.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextStyleable.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextTeamMention.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextText.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextUserMention.md delete mode 100644 docs/content/reference/web-api/interfaces/RichTextUsergroupMention.md delete mode 100644 docs/content/reference/web-api/interfaces/SearchAllArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/SearchFilesArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/SearchMessagesArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/SectionBlock.md delete mode 100644 docs/content/reference/web-api/interfaces/SelectOption.md delete mode 100644 docs/content/reference/web-api/interfaces/SlackFileImageObject.md delete mode 100644 docs/content/reference/web-api/interfaces/StarsListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/StaticSelect.md delete mode 100644 docs/content/reference/web-api/interfaces/Timepicker.md delete mode 100644 docs/content/reference/web-api/interfaces/ToolingTokensRotateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/URLInput.md delete mode 100644 docs/content/reference/web-api/interfaces/UrlImageObject.md delete mode 100644 docs/content/reference/web-api/interfaces/UsergroupsCreateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsergroupsDisableArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsergroupsEnableArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsergroupsUpdateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsergroupsUsersListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsergroupsUsersUpdateArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersConversationsArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersDeletePhotoArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersDiscoverableContactsLookupArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersGetPresenceArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersIdentityArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersInfoArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersListArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersLookupByEmailArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersProfileGetArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersProfileSetArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersSelect.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersSetPhotoArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/UsersSetPresenceArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/VideoBlock.md delete mode 100644 docs/content/reference/web-api/interfaces/ViewsPublishArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/WebAPICallResult.md delete mode 100644 docs/content/reference/web-api/interfaces/WebAPIHTTPError.md delete mode 100644 docs/content/reference/web-api/interfaces/WebAPIPlatformError.md delete mode 100644 docs/content/reference/web-api/interfaces/WebAPIRateLimitedError.md delete mode 100644 docs/content/reference/web-api/interfaces/WebAPIRequestError.md delete mode 100644 docs/content/reference/web-api/interfaces/WebClientOptions.md delete mode 100644 docs/content/reference/web-api/interfaces/WorkflowButton.md delete mode 100644 docs/content/reference/web-api/interfaces/WorkflowStepView.md delete mode 100644 docs/content/reference/web-api/interfaces/WorkflowsStepCompletedArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/WorkflowsStepFailedArguments.md delete mode 100644 docs/content/reference/web-api/interfaces/WorkflowsUpdateStepArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/APITestArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsApproveArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsApproveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsApprovedListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsApprovedListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsConfigLookupResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsConfigSetResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsRequestsListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsRequestsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsRestrictArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsRestrictResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsUninstallArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAppsUninstallResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAuthPolicyAssignEntitiesResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAuthPolicyGetEntitiesResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminAuthPolicyRemoveEntitiesResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminBarriersCreateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminBarriersDeleteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminBarriersListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminBarriersListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminBarriersUpdateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsArchiveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsBulkArchiveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsBulkDeleteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsBulkMoveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPrivateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPublicResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsCreateArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsCreateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsDeleteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsDisconnectSharedResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsEKMListOriginalConnectedChannelInfoArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsGetConversationPrefsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsGetCustomRetentionResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsGetTeamsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsInviteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsLookupResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsRemoveCustomRetentionResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsRenameResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessAddGroupResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessListGroupsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessRemoveGroupResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsSearchArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsSearchResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsSetConversationPrefsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsSetCustomRetentionResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsSetTeamsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsUnarchiveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistRemoveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminEmojiAddAliasResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminEmojiAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminEmojiListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminEmojiListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminEmojiRemoveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminEmojiRenameResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminFunctionsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsLookupResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsSetResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminInviteRequestsApproveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminInviteRequestsApprovedListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminInviteRequestsDeniedListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminInviteRequestsDenyResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminInviteRequestsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminRolesAddAssignmentsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminRolesRemoveAssignmentsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminTeamsAdminsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminTeamsCreateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminTeamsListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminTeamsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminTeamsOwnersListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminTeamsSettingsInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDefaultChannelsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDescriptionResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDiscoverabilityResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetIconResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetNameResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsergroupsAddChannelsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsergroupsAddTeamsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsergroupsListChannelsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsergroupsRemoveChannelsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersAssignResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersInviteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersRemoveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSessionClearSettingsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSessionGetSettingsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSessionInvalidateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSessionListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSessionListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSessionResetBulkResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSessionResetResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSessionSetSettingsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSetAdminResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSetExpirationResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSetOwnerResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersSetRegularResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminUsersUnsupportedVersionsExportResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsRemoveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminWorkflowsPermissionsLookupResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AdminWorkflowsUnpublishResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ApiTestResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsConnectionsOpenArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsConnectionsOpenResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsEventAuthorizationsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsManifestCreateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsManifestDeleteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsManifestExportResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsManifestUpdateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsManifestValidateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsPermissionsInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsPermissionsRequestResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsPermissionsResourcesListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsPermissionsScopesListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsPermissionsUsersListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsPermissionsUsersRequestResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AppsUninstallResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AuthRevokeArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AuthRevokeResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AuthTeamsListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AuthTeamsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/AuthTestArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/AuthTestResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/BookmarksAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/BookmarksEditResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/BookmarksListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/BookmarksRemoveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/BotsInfoArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/BotsInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CallUser.md delete mode 100644 docs/content/reference/web-api/type-aliases/CallsAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CallsEndResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CallsInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CallsParticipantsAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CallsParticipantsRemoveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CallsUpdateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CanvasesAccessDeleteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CanvasesAccessSetResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CanvasesCreateArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/CanvasesCreateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CanvasesDeleteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CanvasesEditResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/CanvasesSectionsLookupResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsArchiveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsCreateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsHistoryResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsInviteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsJoinResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsKickResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsLeaveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsMarkResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsRenameResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsRepliesResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsSetPurposeResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsSetTopicResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChannelsUnarchiveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatDeleteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatDeleteScheduledMessageResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatGetPermalinkResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatMeMessageResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatPostEphemeralArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatPostEphemeralResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatPostMessageArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatPostMessageResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatScheduleMessageArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatScheduleMessageResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatUnfurlArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatUnfurlResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatUpdateArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ChatUpdateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationFilter.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsApproveSharedInviteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsArchiveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsCanvasesCreateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsCloseResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsCreateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsDeclineSharedInviteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsExternalInvitePermissionsSetResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsHistoryResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsInviteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsInviteSharedArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsInviteSharedResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsJoinResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsKickResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsLeaveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsMarkResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsMembersResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsOpenArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsOpenResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsRenameResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsRepliesResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsSetPurposeResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsSetTopicResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ConversationsUnarchiveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/DialogOpenResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/DndEndDndArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/DndEndDndResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/DndEndSnoozeArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/DndEndSnoozeResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/DndInfoArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/DndInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/DndSetSnoozeResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/DndTeamInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/EmojiListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/EmojiListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesCommentsAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesCommentsDeleteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesCommentsEditResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesDeleteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesGetUploadURLExternalResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesRemoteAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesRemoteInfoArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesRemoteInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesRemoteListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesRemoteRemoveArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesRemoteRemoveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesRemoteShareArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesRemoteShareResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesRemoteUpdateArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesRemoteUpdateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesRevokePublicURLResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesSharedPublicURLResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesUploadArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesUploadResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FilesUploadV2Arguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/FunctionsCompleteErrorResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/FunctionsCompleteSuccessResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsArchiveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsCloseResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsCreateChildResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsCreateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsHistoryResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsInviteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsKickResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsLeaveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsMarkResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsOpenResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsRenameResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsRepliesResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsSetPurposeResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsSetTopicResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/GroupsUnarchiveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ImCloseResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ImHistoryResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ImListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ImMarkResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ImOpenResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ImRepliesResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ImageBlock.md delete mode 100644 docs/content/reference/web-api/type-aliases/ImageElement.md delete mode 100644 docs/content/reference/web-api/type-aliases/KnownBlock.md delete mode 100644 docs/content/reference/web-api/type-aliases/MigrationExchangeResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/MpimCloseResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/MpimHistoryResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/MpimListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/MpimMarkResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/MpimOpenResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/MpimRepliesResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/MultiSelect.md delete mode 100644 docs/content/reference/web-api/type-aliases/OauthAccessResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/OauthTokenResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/OauthV2AccessResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/OauthV2ExchangeResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/OpenIDConnectTokenResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/Option.md delete mode 100644 docs/content/reference/web-api/type-aliases/PageAccumulator.md delete mode 100644 docs/content/reference/web-api/type-aliases/PinsAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/PinsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/PinsRemoveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/RTMConnectArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/RTMStartArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ReactionsAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ReactionsGetArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ReactionsGetResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ReactionsListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ReactionsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ReactionsRemoveArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ReactionsRemoveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/RemindersAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/RemindersCompleteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/RemindersDeleteResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/RemindersInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/RemindersListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/RemindersListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/RichTextElement.md delete mode 100644 docs/content/reference/web-api/type-aliases/RtmConnectResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/RtmStartResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/SearchAllResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/SearchFilesResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/SearchMessagesResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/Select.md delete mode 100644 docs/content/reference/web-api/type-aliases/SlackFile.md delete mode 100644 docs/content/reference/web-api/type-aliases/StarsAddRemoveArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/StarsAddResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/StarsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/StarsRemoveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/TLSOptions.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamAccessLogsArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamAccessLogsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamBillableInfoArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamBillableInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamBillingInfoArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamBillingInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamExternalTeamsListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamExternalTeamsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamInfoArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamIntegrationLogsArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamIntegrationLogsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamPreferencesListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamPreferencesListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamProfileGetArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/TeamProfileGetResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ToolingTokensRotateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsergroupsCreateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsergroupsDisableResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsergroupsEnableResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsergroupsListArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsergroupsListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsergroupsUpdateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsergroupsUsersListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsergroupsUsersUpdateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersConversationsResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersDeletePhotoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersDiscoverableContactsLookupResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersGetPresenceResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersIdentityResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersInfoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersListResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersLookupByEmailResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersProfileGetResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersProfileSetResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersSetActiveResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersSetPhotoResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/UsersSetPresenceResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/View.md delete mode 100644 docs/content/reference/web-api/type-aliases/ViewsOpenArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ViewsOpenResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ViewsPublishResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ViewsPushArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ViewsPushResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/ViewsUpdateArguments.md delete mode 100644 docs/content/reference/web-api/type-aliases/ViewsUpdateResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/WebAPICallError.md delete mode 100644 docs/content/reference/web-api/type-aliases/WorkflowsStepCompletedResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/WorkflowsStepFailedResponse.md delete mode 100644 docs/content/reference/web-api/type-aliases/WorkflowsUpdateStepResponse.md delete mode 100644 docs/content/reference/web-api/typedoc-sidebar.cjs delete mode 100644 docs/content/reference/web-api/variables/retryPolicies.md delete mode 100644 docs/content/reference/webhook/classes/IncomingWebhook.md delete mode 100644 docs/content/reference/webhook/enumerations/ErrorCode.md delete mode 100644 docs/content/reference/webhook/index.md delete mode 100644 docs/content/reference/webhook/interfaces/CodedError.md delete mode 100644 docs/content/reference/webhook/interfaces/IncomingWebhookDefaultArguments.md delete mode 100644 docs/content/reference/webhook/interfaces/IncomingWebhookHTTPError.md delete mode 100644 docs/content/reference/webhook/interfaces/IncomingWebhookRequestError.md delete mode 100644 docs/content/reference/webhook/interfaces/IncomingWebhookResult.md delete mode 100644 docs/content/reference/webhook/interfaces/IncomingWebhookSendArguments.md delete mode 100644 docs/content/reference/webhook/type-aliases/IncomingWebhookSendError.md delete mode 100644 docs/content/reference/webhook/typedoc-sidebar.cjs diff --git a/docs/.gitignore b/docs/.gitignore index 49ba8fa7c..a5a32bc26 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -2,4 +2,5 @@ node_modules/ .docusaurus .DS_Store build/ -.stylelintrc.json \ No newline at end of file +.stylelintrc.json +content/reference \ No newline at end of file diff --git a/docs/content/reference/cli-test/classes/SlackCLIProcess.md b/docs/content/reference/cli-test/classes/SlackCLIProcess.md deleted file mode 100644 index dcc7360a2..000000000 --- a/docs/content/reference/cli-test/classes/SlackCLIProcess.md +++ /dev/null @@ -1,150 +0,0 @@ -# Class: SlackCLIProcess - -## Constructors - -### new SlackCLIProcess() - -```ts -new SlackCLIProcess( - command, - globalOptions?, - commandOptions?): SlackCLIProcess -``` - -#### Parameters - -• **command**: `string` - -• **globalOptions?**: `SlackCLIGlobalOptions` - -• **commandOptions?**: `SlackCLICommandOptions` - -#### Returns - -[`SlackCLIProcess`](SlackCLIProcess.md) - -#### Defined in - -[cli/cli-process.ts:64](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L64) - -## Properties - -### command - -```ts -command: string; -``` - -#### Description - -The CLI command to invoke - -#### Defined in - -[cli/cli-process.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L52) - -*** - -### commandOptions - -```ts -commandOptions: undefined | SlackCLICommandOptions; -``` - -#### Description - -The CLI command-specific options to pass to the command - -#### Defined in - -[cli/cli-process.ts:62](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L62) - -*** - -### globalOptions - -```ts -globalOptions: undefined | SlackCLIGlobalOptions; -``` - -#### Description - -The global CLI options to pass to the command - -#### Defined in - -[cli/cli-process.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L57) - -## Methods - -### execAsync() - -```ts -execAsync(shellOpts?): Promise -``` - -#### Parameters - -• **shellOpts?**: `Partial`\<`SpawnOptionsWithoutStdio`\> - -#### Returns - -`Promise`\<`ShellProcess`\> - -#### Description - -Executes the command asynchronously, returning the process details once the process finishes executing - -#### Defined in - -[cli/cli-process.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L76) - -*** - -### execAsyncUntilOutputPresent() - -```ts -execAsyncUntilOutputPresent(output, shellOpts?): Promise -``` - -#### Parameters - -• **output**: `string` - -• **shellOpts?**: `Partial`\<`SpawnOptionsWithoutStdio`\> - -#### Returns - -`Promise`\<`ShellProcess`\> - -#### Description - -Executes the command asynchronously, returning the process details once the process finishes executing - -#### Defined in - -[cli/cli-process.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L86) - -*** - -### execSync() - -```ts -execSync(shellOpts?): string -``` - -#### Parameters - -• **shellOpts?**: `Partial`\<`SpawnOptionsWithoutStdio`\> - -#### Returns - -`string` - -#### Description - -Executes the command synchronously, returning the process standard output - -#### Defined in - -[cli/cli-process.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L99) diff --git a/docs/content/reference/cli-test/index.md b/docs/content/reference/cli-test/index.md deleted file mode 100644 index 71487f118..000000000 --- a/docs/content/reference/cli-test/index.md +++ /dev/null @@ -1,12 +0,0 @@ -# @slack/cli-test - -## Classes - -- [SlackCLIProcess](classes/SlackCLIProcess.md) - -## Variables - -- [SlackCLI](variables/SlackCLI.md) -- [SlackProduct](variables/SlackProduct.md) -- [SlackTracerId](variables/SlackTracerId.md) -- [shell](variables/shell.md) diff --git a/docs/content/reference/cli-test/typedoc-sidebar.cjs b/docs/content/reference/cli-test/typedoc-sidebar.cjs deleted file mode 100644 index 348b1706d..000000000 --- a/docs/content/reference/cli-test/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/cli-test/classes/SlackCLIProcess","label":"SlackCLIProcess"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/cli-test/variables/SlackCLI","label":"SlackCLI"},{"type":"doc","id":"reference/cli-test/variables/SlackProduct","label":"SlackProduct"},{"type":"doc","id":"reference/cli-test/variables/SlackTracerId","label":"SlackTracerId"},{"type":"doc","id":"reference/cli-test/variables/shell","label":"shell"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/cli-test/variables/SlackCLI.md b/docs/content/reference/cli-test/variables/SlackCLI.md deleted file mode 100644 index 252176f80..000000000 --- a/docs/content/reference/cli-test/variables/SlackCLI.md +++ /dev/null @@ -1,690 +0,0 @@ -# Variable: SlackCLI - -```ts -const SlackCLI: object; -``` - -Set of functions to spawn and interact with Slack Platform CLI processes and commands - -## Type declaration - -### app - -```ts -app: object; -``` - -### app.delete() - -```ts -delete: (args) => Promise = del; -``` - -`slack app delete` - -#### Parameters - -• **args**: `ProjectCommandArguments` - -#### Returns - -`Promise`\<`string`\> - -command output - -### app.install() - -```ts -install: (args) => Promise; -``` - -`slack app install` - -#### Parameters - -• **args**: `ProjectCommandArguments` - -#### Returns - -`Promise`\<`string`\> - -command output - -### app.list() - -```ts -list: (args) => Promise; -``` - -`slack app list` - -#### Parameters - -• **args**: `ProjectCommandArguments` - -#### Returns - -`Promise`\<`string`\> - -command output - -### auth - -```ts -auth: object; -``` - -### auth.loginChallengeExchange() - -```ts -loginChallengeExchange: (args) => Promise; -``` - -#### Parameters - -• **args**: `SlackCLIHostTargetOptions` & `object` - -#### Returns - -`Promise`\<`string`\> - -### auth.loginNoPrompt() - -```ts -loginNoPrompt: (args?) => Promise; -``` - -`slack login --no-prompt`; initiates a CLI login flow. The `authTicketSlashCommand` returned should be entered - into the Slack client, and the challenge code retrieved and fed into the `loginChallengeExchange` method to - complete the CLI login flow. - -#### Parameters - -• **args?**: `SlackCLIHostTargetOptions` - -#### Returns - -`Promise`\<`object`\> - -##### authTicket - -```ts -authTicket: string; -``` - -An auth ticket is a A UUID sequence granted by Slack to a CLI auth requestor. -That ticket must then be submitted via slash command by a user logged in to Slack and permissions accepted to be -granted a token for use. This `authTicket` is included in the `authTicketSlashCommand`. - -##### authTicketSlashCommand - -```ts -authTicketSlashCommand: string; -``` - -###### Description - -Slash command that a Slack client user must enter into the message composer in order to initiate -login flow. - -###### Example - -```ts -`/slackauthticket MTMxNjgxMDUtYTYwOC00NzRhLWE3M2YtMjVmZTQyMjc1MDg4` -``` - -##### output - -```ts -output: string; -``` - -###### Description - -Command output - -### auth.logout() - -```ts -logout: (args?) => Promise; -``` - -#### Parameters - -• **args?**: Omit\ & (Pick\ \| \{ all?: boolean \| undefined; \}) - -#### Returns - -`Promise`\<`string`\> - -command output - -### collaborator - -```ts -collaborator: object; -``` - -### collaborator.add() - -```ts -add: (args) => Promise; -``` - -`slack collaborators add` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `CollaboratorEmail` - -#### Returns - -`Promise`\<`string`\> - -command output - -### collaborator.list() - -```ts -list: (args) => Promise; -``` - -`slack collaborators list` - -#### Parameters - -• **args**: `ProjectCommandArguments` - -#### Returns - -`Promise`\<`string`\> - -command output - -### collaborator.remove() - -```ts -remove: (args) => Promise; -``` - -`slack collaborators remove` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `CollaboratorEmail` - -#### Returns - -`Promise`\<`string`\> - -command output - -### create() - -```ts -create: (args) => Promise; -``` - -`slack create` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `object` - -#### Returns - -`Promise`\<`string`\> - -command output - -### env - -```ts -env: object; -``` - -### env.add() - -```ts -add: (args) => Promise; -``` - -`slack env add` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `EnvCommandArguments` - -#### Returns - -`Promise`\<`string`\> - -command output - -### env.list() - -```ts -list: (args) => Promise; -``` - -`slack env list` - -#### Parameters - -• **args**: `ProjectCommandArguments` - -#### Returns - -`Promise`\<`string`\> - -command output - -### env.remove() - -```ts -remove: (args) => Promise; -``` - -`slack env remove` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `Pick`\<`EnvCommandArguments`, `"secretKey"`\> - -#### Returns - -`Promise`\<`string`\> - -command output - -### externalAuth - -```ts -externalAuth: object; -``` - -### externalAuth.add() - -```ts -add: (args) => Promise; -``` - -`slack external-auth add` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `Pick`\<`ExternalAuthCommandArguments`, `"provider"`\> - -#### Returns - -`Promise`\<`string`\> - -command output - -### externalAuth.addSecret() - -```ts -addSecret: (args) => Promise; -``` - -`slack external-auth add-secret` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `Omit`\<`ExternalAuthCommandArguments`, `"all"`\> - -#### Returns - -`Promise`\<`string`\> - -command output - -### externalAuth.remove() - -```ts -remove: (args) => Promise; -``` - -`slack external-auth remove` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `Omit`\<`ExternalAuthCommandArguments`, `"secret"`\> - -#### Returns - -`Promise`\<`string`\> - -command output - -### externalAuth.selectAuth() - -```ts -selectAuth: (args) => Promise; -``` - -`slack external-auth select-auth` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `Pick`\<`ExternalAuthCommandArguments`, `"provider"`\> & `object` - -#### Returns - -`Promise`\<`string`\> - -command output - -### function - -```ts -function: object = func; -``` - -### function.access() - -```ts -access: (args) => Promise; -``` - -`slack function access` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `FunctionAccessArguments` - -#### Returns - -`Promise`\<`string`\> - -command output - -### manifest - -```ts -manifest: object; -``` - -### manifest.info() - -```ts -info: (args) => Promise; -``` - -`slack manifest info` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `object` - -#### Returns - -`Promise`\<`string`\> - -command output - -### manifest.validate() - -```ts -validate: (args) => Promise; -``` - -`slack manifest validate` - -#### Parameters - -• **args**: `ProjectCommandArguments` - -#### Returns - -`Promise`\<`string`\> - -command output - -### platform - -```ts -platform: object; -``` - -### platform.activity() - -```ts -activity: (args) => Promise; -``` - -`slack platform activity` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `object` - -#### Returns - -`Promise`\<`string`\> - -command output - -### platform.activityTailStart() - -```ts -activityTailStart: (args) => Promise; -``` - -`slack platform activity` but waits for a specified sequence then returns the shell -At the specific point where the sequence is found to continue with test - -#### Parameters - -• **args**: `ProjectCommandArguments` & `StringWaitArgument` - -#### Returns - -`Promise`\<`ShellProcess`\> - -command output - -### platform.activityTailStop() - -```ts -activityTailStop: (args) => Promise; -``` - -Waits for a specified string in the provided `activityTailStart` process output, -kills the process then returns the output - -#### Parameters - -• **args**: `StringWaitArgument` & `ProcessArgument` - -#### Returns - -`Promise`\<`string`\> - -command output - -### platform.deploy() - -```ts -deploy: (args) => Promise; -``` - -`slack deploy` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `Omit`\<`RunDeployArguments`, `"cleanup"`\> - -#### Returns - -`Promise`\<`string`\> - -command output - -### platform.runStart() - -```ts -runStart: (args) => Promise; -``` - -start `slack run`. `runStop` must be used to stop the `run` process returned by this method. - -#### Parameters - -• **args**: `ProjectCommandArguments` & `RunDeployArguments` - -#### Returns - -`Promise`\<`ShellProcess`\> - -shell object to kill it explicitly in the test case via `runStop` - -### platform.runStop() - -```ts -runStop: (args) => Promise; -``` - -stop `slack run` - -#### Parameters - -• **args**: `ProcessArgument` & `object` - -#### Returns - -`Promise`\<`void`\> - -### stopSession() - -```ts -stopSession: (args) => Promise; -``` - -Delete app and Log out of current team session - -#### Parameters - -• **args**: `Partial`\<`ProjectCommandArguments`\> & `object` - -#### Returns - -`Promise`\<`void`\> - -### trigger - -```ts -trigger: object; -``` - -### trigger.access() - -```ts -access: (args) => Promise; -``` - -`slack trigger access` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `TriggerAccessArguments` - -#### Returns - -`Promise`\<`string`\> - -command output - -### trigger.create() - -```ts -create: (args) => Promise; -``` - -`slack trigger create` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `CreateArguments` - -#### Returns - -`Promise`\<`string`\> - -command output - -### trigger.delete() - -```ts -delete: (args) => Promise = del; -``` - -`slack trigger delete` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `TriggerIdArgument` - -#### Returns - -`Promise`\<`string`\> - -command output - -### trigger.info() - -```ts -info: (args) => Promise; -``` - -`slack trigger info` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `TriggerIdArgument` - -#### Returns - -`Promise`\<`string`\> - -command output - -### trigger.list() - -```ts -list: (args) => Promise; -``` - -`slack trigger list` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `object` - -#### Returns - -`Promise`\<`string`\> - -command output - -### trigger.update() - -```ts -update: (args) => Promise; -``` - -`slack trigger update` - -#### Parameters - -• **args**: `ProjectCommandArguments` & `TriggerIdArgument` & `CreateFromFile` \| `Partial`\<`CreateFromArguments`\> - -#### Returns - -`Promise`\<`string`\> - -command output - -## Defined in - -[cli/index.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/index.ts#L20) diff --git a/docs/content/reference/cli-test/variables/SlackProduct.md b/docs/content/reference/cli-test/variables/SlackProduct.md deleted file mode 100644 index 5db1c79a5..000000000 --- a/docs/content/reference/cli-test/variables/SlackProduct.md +++ /dev/null @@ -1,47 +0,0 @@ -# Variable: SlackProduct - -```ts -const SlackProduct: object; -``` - -## Type declaration - -### BUSINESS\_PLUS - -```ts -BUSINESS_PLUS: string = 'PLUS'; -``` - -### ENTERPRISE - -```ts -ENTERPRISE: string = 'ENTERPRISE'; -``` - -### ENTERPRISE\_SANDBOX - -```ts -ENTERPRISE_SANDBOX: string = 'ENTERPRISE_SANDBOX'; -``` - -### ENTERPRISE\_SELECT - -```ts -ENTERPRISE_SELECT: string = 'ENTERPRISE_SELECT'; -``` - -### FREE - -```ts -FREE: string = 'FREE'; -``` - -### PRO - -```ts -PRO: string = 'PRO'; -``` - -## Defined in - -[utils/constants.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/utils/constants.ts#L48) diff --git a/docs/content/reference/cli-test/variables/SlackTracerId.md b/docs/content/reference/cli-test/variables/SlackTracerId.md deleted file mode 100644 index e52bb3693..000000000 --- a/docs/content/reference/cli-test/variables/SlackTracerId.md +++ /dev/null @@ -1,253 +0,0 @@ -# Variable: SlackTracerId - -```ts -const SlackTracerId: object; -``` - -This file should be kept up to date with the source of truth in the Slack CLI repo - -## Type declaration - -### SLACK\_TRACE\_ADMIN\_APPROVAL\_REQUEST\_PENDING - -```ts -SLACK_TRACE_ADMIN_APPROVAL_REQUEST_PENDING: string = 'SLACK_TRACE_ADMIN_APPROVAL_REQUEST_PENDING'; -``` - -### SLACK\_TRACE\_ADMIN\_APPROVAL\_REQUEST\_REASON\_SUBMITTED - -```ts -SLACK_TRACE_ADMIN_APPROVAL_REQUEST_REASON_SUBMITTED: string = 'SLACK_TRACE_ADMIN_APPROVAL_REQUEST_REASON_SUBMITTED'; -``` - -### SLACK\_TRACE\_ADMIN\_APPROVAL\_REQUEST\_SEND\_ERROR - -```ts -SLACK_TRACE_ADMIN_APPROVAL_REQUEST_SEND_ERROR: string = 'SLACK_TRACE_ADMIN_APPROVAL_REQUEST_SEND_ERROR'; -``` - -### SLACK\_TRACE\_ADMIN\_APPROVAL\_REQUEST\_SHOULD\_SEND - -```ts -SLACK_TRACE_ADMIN_APPROVAL_REQUEST_SHOULD_SEND: string = 'SLACK_TRACE_ADMIN_APPROVAL_REQUEST_SHOULD_SEND'; -``` - -### SLACK\_TRACE\_ADMIN\_APPROVAL\_REQUIRED - -```ts -SLACK_TRACE_ADMIN_APPROVAL_REQUIRED: string = 'SLACK_TRACE_ADMIN_APPROVAL_REQUIRED'; -``` - -### SLACK\_TRACE\_AUTH\_LIST\_COUNT - -```ts -SLACK_TRACE_AUTH_LIST_COUNT: string = 'SLACK_TRACE_AUTH_LIST_COUNT'; -``` - -### SLACK\_TRACE\_AUTH\_LIST\_INFO - -```ts -SLACK_TRACE_AUTH_LIST_INFO: string = 'SLACK_TRACE_AUTH_LIST_INFO'; -``` - -### SLACK\_TRACE\_AUTH\_LIST\_SUCCESS - -```ts -SLACK_TRACE_AUTH_LIST_SUCCESS: string = 'SLACK_TRACE_AUTH_LIST_SUCCESS'; -``` - -### SLACK\_TRACE\_AUTH\_LOGIN\_START - -```ts -SLACK_TRACE_AUTH_LOGIN_START: string = 'SLACK_TRACE_AUTH_LOGIN_START'; -``` - -### SLACK\_TRACE\_AUTH\_LOGIN\_SUCCESS - -```ts -SLACK_TRACE_AUTH_LOGIN_SUCCESS: string = 'SLACK_TRACE_AUTH_LOGIN_SUCCESS'; -``` - -### SLACK\_TRACE\_AUTH\_LOGOUT\_START - -```ts -SLACK_TRACE_AUTH_LOGOUT_START: string = 'SLACK_TRACE_AUTH_LOGOUT_START'; -``` - -### SLACK\_TRACE\_AUTH\_LOGOUT\_SUCCESS - -```ts -SLACK_TRACE_AUTH_LOGOUT_SUCCESS: string = 'SLACK_TRACE_AUTH_LOGOUT_SUCCESS'; -``` - -### SLACK\_TRACE\_AUTH\_REVOKE\_START - -```ts -SLACK_TRACE_AUTH_REVOKE_START: string = 'SLACK_TRACE_AUTH_REVOKE_START'; -``` - -### SLACK\_TRACE\_AUTH\_REVOKE\_SUCCESS - -```ts -SLACK_TRACE_AUTH_REVOKE_SUCCESS: string = 'SLACK_TRACE_AUTH_REVOKE_SUCCESS'; -``` - -### SLACK\_TRACE\_COLLABORATOR\_ADD\_COLLABORATOR - -```ts -SLACK_TRACE_COLLABORATOR_ADD_COLLABORATOR: string = 'SLACK_TRACE_COLLABORATOR_ADD_COLLABORATOR'; -``` - -### SLACK\_TRACE\_COLLABORATOR\_ADD\_SUCCESS - -```ts -SLACK_TRACE_COLLABORATOR_ADD_SUCCESS: string = 'SLACK_TRACE_COLLABORATOR_ADD_SUCCESS'; -``` - -### SLACK\_TRACE\_COLLABORATOR\_LIST\_COLLABORATOR - -```ts -SLACK_TRACE_COLLABORATOR_LIST_COLLABORATOR: string = 'SLACK_TRACE_COLLABORATOR_LIST_COLLABORATOR'; -``` - -### SLACK\_TRACE\_COLLABORATOR\_LIST\_COUNT - -```ts -SLACK_TRACE_COLLABORATOR_LIST_COUNT: string = 'SLACK_TRACE_COLLABORATOR_LIST_COUNT'; -``` - -### SLACK\_TRACE\_COLLABORATOR\_LIST\_SUCCESS - -```ts -SLACK_TRACE_COLLABORATOR_LIST_SUCCESS: string = 'SLACK_TRACE_COLLABORATOR_LIST_SUCCESS'; -``` - -### SLACK\_TRACE\_COLLABORATOR\_REMOVE\_COLLABORATOR - -```ts -SLACK_TRACE_COLLABORATOR_REMOVE_COLLABORATOR: string = 'SLACK_TRACE_COLLABORATOR_REMOVE_COLLABORATOR'; -``` - -### SLACK\_TRACE\_COLLABORATOR\_REMOVE\_SUCCESS - -```ts -SLACK_TRACE_COLLABORATOR_REMOVE_SUCCESS: string = 'SLACK_TRACE_COLLABORATOR_REMOVE_SUCCESS'; -``` - -### SLACK\_TRACE\_CREATE\_DEPENDENCIES\_SUCCESS - -```ts -SLACK_TRACE_CREATE_DEPENDENCIES_SUCCESS: string = 'SLACK_TRACE_CREATE_DEPENDENCIES_SUCCESS'; -``` - -### SLACK\_TRACE\_CREATE\_ERROR - -```ts -SLACK_TRACE_CREATE_ERROR: string = 'SLACK_TRACE_CREATE_ERROR'; -``` - -### SLACK\_TRACE\_CREATE\_PROJECT\_PATH - -```ts -SLACK_TRACE_CREATE_PROJECT_PATH: string = 'SLACK_TRACE_CREATE_PROJECT_PATH'; -``` - -### SLACK\_TRACE\_CREATE\_START - -```ts -SLACK_TRACE_CREATE_START: string = 'SLACK_TRACE_CREATE_START'; -``` - -### SLACK\_TRACE\_CREATE\_SUCCESS - -```ts -SLACK_TRACE_CREATE_SUCCESS: string = 'SLACK_TRACE_CREATE_SUCCESS'; -``` - -### SLACK\_TRACE\_CREATE\_TEMPLATE\_OPTIONS - -```ts -SLACK_TRACE_CREATE_TEMPLATE_OPTIONS: string = 'SLACK_TRACE_CREATE_TEMPLATE_OPTIONS'; -``` - -### SLACK\_TRACE\_DATASTORE\_COUNT\_DATASTORE - -```ts -SLACK_TRACE_DATASTORE_COUNT_DATASTORE: string = 'SLACK_TRACE_DATASTORE_COUNT_DATASTORE'; -``` - -### SLACK\_TRACE\_DATASTORE\_COUNT\_SUCCESS - -```ts -SLACK_TRACE_DATASTORE_COUNT_SUCCESS: string = 'SLACK_TRACE_DATASTORE_COUNT_SUCCESS'; -``` - -### SLACK\_TRACE\_DATASTORE\_COUNT\_TOTAL - -```ts -SLACK_TRACE_DATASTORE_COUNT_TOTAL: string = 'SLACK_TRACE_DATASTORE_COUNT_TOTAL'; -``` - -### SLACK\_TRACE\_FEEDBACK\_MESSAGE - -```ts -SLACK_TRACE_FEEDBACK_MESSAGE: string = 'SLACK_TRACE_FEEDBACK_MESSAGE'; -``` - -### SLACK\_TRACE\_MANIFEST\_VALIDATE\_SUCCESS - -```ts -SLACK_TRACE_MANIFEST_VALIDATE_SUCCESS: string = 'SLACK_TRACE_MANIFEST_VALIDATE_SUCCESS'; -``` - -### SLACK\_TRACE\_PLATFORM\_DEPLOY\_SUCCESS - -```ts -SLACK_TRACE_PLATFORM_DEPLOY_SUCCESS: string = 'SLACK_TRACE_PLATFORM_DEPLOY_SUCCESS'; -``` - -### SLACK\_TRACE\_PLATFORM\_RUN\_READY - -```ts -SLACK_TRACE_PLATFORM_RUN_READY: string = 'SLACK_TRACE_PLATFORM_RUN_READY'; -``` - -### SLACK\_TRACE\_PLATFORM\_RUN\_START - -```ts -SLACK_TRACE_PLATFORM_RUN_START: string = 'SLACK_TRACE_PLATFORM_RUN_START'; -``` - -### SLACK\_TRACE\_PLATFORM\_RUN\_STOP - -```ts -SLACK_TRACE_PLATFORM_RUN_STOP: string = 'SLACK_TRACE_PLATFORM_RUN_STOP'; -``` - -### SLACK\_TRACE\_TRIGGERS\_ACCESS\_ERROR - -```ts -SLACK_TRACE_TRIGGERS_ACCESS_ERROR: string = 'SLACK_TRACE_TRIGGERS_ACCESS_ERROR'; -``` - -### SLACK\_TRACE\_TRIGGERS\_ACCESS\_SUCCESS - -```ts -SLACK_TRACE_TRIGGERS_ACCESS_SUCCESS: string = 'SLACK_TRACE_TRIGGERS_ACCESS_SUCCESS'; -``` - -### SLACK\_TRACE\_TRIGGERS\_CREATE\_SUCCESS - -```ts -SLACK_TRACE_TRIGGERS_CREATE_SUCCESS: string = 'SLACK_TRACE_TRIGGERS_CREATE_SUCCESS'; -``` - -### SLACK\_TRACE\_TRIGGERS\_CREATE\_URL - -```ts -SLACK_TRACE_TRIGGERS_CREATE_URL: string = 'SLACK_TRACE_TRIGGERS_CREATE_URL'; -``` - -## Defined in - -[utils/constants.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/utils/constants.ts#L5) diff --git a/docs/content/reference/cli-test/variables/shell.md b/docs/content/reference/cli-test/variables/shell.md deleted file mode 100644 index 0bf0fde4e..000000000 --- a/docs/content/reference/cli-test/variables/shell.md +++ /dev/null @@ -1,151 +0,0 @@ -# Variable: shell - -```ts -const shell: object; -``` - -## Type declaration - -### assembleShellEnv() - -```ts -assembleShellEnv: () => Record; -``` - -#### Returns - -`Record`\<`string`, `undefined` \| `string`\> - -### checkIfFinished() - -```ts -checkIfFinished: (proc) => Promise; -``` - -Logic to wait for child process to finish executing -- Check if the close event was emitted, else wait for 1 sec -- Error out if > 30 sec - -#### Parameters - -• **proc**: `ShellProcess` - -#### Returns - -`Promise`\<`void`\> - -### kill() - -```ts -kill: (proc) => Promise; -``` - -#### Parameters - -• **proc**: `ShellProcess` - -#### Returns - -`Promise`\<`boolean`\> - -### removeANSIcolors() - -```ts -removeANSIcolors: (text) => string; -``` - -Remove all the ANSI color and style encoding - -#### Parameters - -• **text**: `string` - -string - -#### Returns - -`string` - -### runCommandSync() - -```ts -runCommandSync: (command, shellOpts?) => string; -``` - -#### Parameters - -• **command**: `string` - -cli command - -• **shellOpts?**: `Partial`\<`SpawnOptionsWithoutStdio`\> - -various shell spawning options available to customize - -#### Returns - -`string` - -command stdout - -### sleep() - -```ts -sleep: (timeout) => Promise; -``` - -Sleep function used to wait for cli to finish executing - -#### Parameters - -• **timeout**: `number` = `1000` - -#### Returns - -`Promise`\<`void`\> - -### spawnProcess() - -```ts -spawnProcess: (command, shellOpts?) => ShellProcess; -``` - -#### Parameters - -• **command**: `string` - -The command to run, e.g. `echo "hi"` - -• **shellOpts?**: `Partial`\<`SpawnOptionsWithoutStdio`\> - -Options to customize shell execution - -#### Returns - -`ShellProcess` - -command output - -### waitForOutput() - -```ts -waitForOutput: (expString, proc) => Promise; -``` - -Wait for output - -#### Parameters - -• **expString**: `string` - -expected string - -• **proc**: `ShellProcess` - -#### Returns - -`Promise`\<`void`\> - -## Defined in - -[cli/shell.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/shell.ts#L10) diff --git a/docs/content/reference/events-api/classes/SlackEventAdapter.md b/docs/content/reference/events-api/classes/SlackEventAdapter.md deleted file mode 100644 index 875f04cf0..000000000 --- a/docs/content/reference/events-api/classes/SlackEventAdapter.md +++ /dev/null @@ -1,189 +0,0 @@ -# Class: SlackEventAdapter - -An adapter for Slack's Events API. - -## Extends - -- `unknown` - -## Constructors - -### new SlackEventAdapter() - -```ts -new SlackEventAdapter(signingSecret, __namedParameters): SlackEventAdapter -``` - -#### Parameters - -• **signingSecret**: `string` - -The token used to authenticate signed requests from Slack's Events API. - -• **\_\_namedParameters**: [`EventAdapterOptions`](../interfaces/EventAdapterOptions.md) = `{}` - -#### Returns - -[`SlackEventAdapter`](SlackEventAdapter.md) - -#### Overrides - -`EventEmitter.constructor` - -#### Defined in - -[packages/events-api/src/adapter.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L47) - -## Properties - -### includeBody - -```ts -includeBody: boolean; -``` - -Whether to include the API event bodies in adapter event listeners. - -#### Defined in - -[packages/events-api/src/adapter.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L23) - -*** - -### includeHeaders - -```ts -includeHeaders: boolean; -``` - -Whether to include request headers in adapter event listeners. - -#### Defined in - -[packages/events-api/src/adapter.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L28) - -*** - -### signingSecret - -```ts -readonly signingSecret: string; -``` - -The token used to authenticate signed requests from Slack's Events API. - -#### Defined in - -[packages/events-api/src/adapter.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L18) - -*** - -### waitForResponse - -```ts -waitForResponse: boolean; -``` - -When `true` prevents the adapter from responding by itself and leaves that up to listeners. - -#### Defined in - -[packages/events-api/src/adapter.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L33) - -## Methods - -### createServer() - -```ts -createServer(): Promise -``` - -Creates an HTTP server to listen for event payloads. - -#### Returns - -`Promise`\<`Server`\> - -#### Defined in - -[packages/events-api/src/adapter.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L76) - -*** - -### expressMiddleware() - -```ts -expressMiddleware(): RequestHandler -``` - -Returns a middleware-compatible adapter. - -#### Returns - -`RequestHandler` - -#### Defined in - -[packages/events-api/src/adapter.ts:120](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L120) - -*** - -### requestListener() - -```ts -requestListener(): RequestListener -``` - -Creates a request listener. - -#### Returns - -`RequestListener` - -#### Defined in - -[packages/events-api/src/adapter.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L130) - -*** - -### start() - -```ts -start(port): Promise -``` - -Starts a server on the specified port. - -#### Parameters - -• **port**: `number` - -The port number to listen on. - -#### Returns - -`Promise`\<`Server`\> - -The server from the built-in `http` module. - -#### Defined in - -[packages/events-api/src/adapter.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L87) - -*** - -### stop() - -```ts -stop(): Promise -``` - -Stops the server started by [SlackEventAdapter.start](SlackEventAdapter.md#start). - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/events-api/src/adapter.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L100) diff --git a/docs/content/reference/events-api/enumerations/ErrorCode.md b/docs/content/reference/events-api/enumerations/ErrorCode.md deleted file mode 100644 index 13bedc298..000000000 --- a/docs/content/reference/events-api/enumerations/ErrorCode.md +++ /dev/null @@ -1,39 +0,0 @@ -# Enumeration: ErrorCode - -A dictionary of codes for errors produced by this package. - -## Enumeration Members - -### BodyParserNotPermitted - -```ts -BodyParserNotPermitted: "SLACKADAPTER_BODY_PARSER_NOT_PERMITTED_FAILURE"; -``` - -#### Defined in - -[packages/events-api/src/http-handler.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L17) - -*** - -### RequestTimeFailure - -```ts -RequestTimeFailure: "SLACKHTTPHANDLER_REQUEST_TIMELIMIT_FAILURE"; -``` - -#### Defined in - -[packages/events-api/src/http-handler.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L16) - -*** - -### SignatureVerificationFailure - -```ts -SignatureVerificationFailure: "SLACKHTTPHANDLER_REQUEST_SIGNATURE_VERIFICATION_FAILURE"; -``` - -#### Defined in - -[packages/events-api/src/http-handler.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L15) diff --git a/docs/content/reference/events-api/functions/createEventAdapter.md b/docs/content/reference/events-api/functions/createEventAdapter.md deleted file mode 100644 index 1bc9c4629..000000000 --- a/docs/content/reference/events-api/functions/createEventAdapter.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: createEventAdapter() - -```ts -function createEventAdapter(signingSecret, options?): SlackEventAdapter -``` - -Creates a new [SlackEventAdapter](../classes/SlackEventAdapter.md). - -## Parameters - -• **signingSecret**: `string` - -• **options?**: [`EventAdapterOptions`](../interfaces/EventAdapterOptions.md) - -## Returns - -[`SlackEventAdapter`](../classes/SlackEventAdapter.md) - -## Defined in - -[packages/events-api/src/index.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/index.ts#L15) diff --git a/docs/content/reference/events-api/functions/verifyRequestSignature.md b/docs/content/reference/events-api/functions/verifyRequestSignature.md deleted file mode 100644 index 019ef6eb0..000000000 --- a/docs/content/reference/events-api/functions/verifyRequestSignature.md +++ /dev/null @@ -1,28 +0,0 @@ -# Function: verifyRequestSignature() - -```ts -function verifyRequestSignature(params): true -``` - -Verifies the signature of a request. Throws a [CodedError](../interfaces/CodedError.md) if the signature is invalid. - -## Parameters - -• **params**: [`VerifyRequestSignatureParams`](../interfaces/VerifyRequestSignatureParams.md) - -See [VerifyRequestSignatureParams](../interfaces/VerifyRequestSignatureParams.md). - -## Returns - -`true` - -`true` when the signature is valid. - -## Remarks - -See [Verifying requests from Slack](https://api.slack.com/docs/verifying-requests-from-slack#sdk_support) for more -information. - -## Defined in - -[packages/events-api/src/http-handler.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L38) diff --git a/docs/content/reference/events-api/index.md b/docs/content/reference/events-api/index.md deleted file mode 100644 index fb3adeb77..000000000 --- a/docs/content/reference/events-api/index.md +++ /dev/null @@ -1,24 +0,0 @@ -# @slack/events-api - -## Enumerations - -- [ErrorCode](enumerations/ErrorCode.md) - -## Classes - -- [SlackEventAdapter](classes/SlackEventAdapter.md) - -## Interfaces - -- [CodedError](interfaces/CodedError.md) -- [EventAdapterOptions](interfaces/EventAdapterOptions.md) -- [VerifyRequestSignatureParams](interfaces/VerifyRequestSignatureParams.md) - -## Variables - -- [errorCodes](variables/errorCodes.md) - -## Functions - -- [createEventAdapter](functions/createEventAdapter.md) -- [verifyRequestSignature](functions/verifyRequestSignature.md) diff --git a/docs/content/reference/events-api/interfaces/CodedError.md b/docs/content/reference/events-api/interfaces/CodedError.md deleted file mode 100644 index 66c8bea0c..000000000 --- a/docs/content/reference/events-api/interfaces/CodedError.md +++ /dev/null @@ -1,71 +0,0 @@ -# Interface: CodedError - -All errors produced by this package are regular -[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) objects with -an extra [`error`](CodedError.md#code) field. - -## Extends - -- `Error` - -## Properties - -### code - -```ts -code: ErrorCode; -``` - -What kind of error occurred. - -#### Defined in - -[packages/events-api/src/http-handler.ts:292](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L292) - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -`Error.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -`Error.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -`Error.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/events-api/interfaces/EventAdapterOptions.md b/docs/content/reference/events-api/interfaces/EventAdapterOptions.md deleted file mode 100644 index 778106f8f..000000000 --- a/docs/content/reference/events-api/interfaces/EventAdapterOptions.md +++ /dev/null @@ -1,40 +0,0 @@ -# Interface: EventAdapterOptions - -Options when constructing [SlackEventAdapter](../classes/SlackEventAdapter.md). See [SlackEventAdapter](../classes/SlackEventAdapter.md)'s fields for more information on -what each option does. - -## Properties - -### includeBody? - -```ts -optional includeBody: boolean; -``` - -#### Defined in - -[packages/events-api/src/adapter.ts:140](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L140) - -*** - -### includeHeaders? - -```ts -optional includeHeaders: boolean; -``` - -#### Defined in - -[packages/events-api/src/adapter.ts:141](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L141) - -*** - -### waitForResponse? - -```ts -optional waitForResponse: boolean; -``` - -#### Defined in - -[packages/events-api/src/adapter.ts:142](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/adapter.ts#L142) diff --git a/docs/content/reference/events-api/interfaces/VerifyRequestSignatureParams.md b/docs/content/reference/events-api/interfaces/VerifyRequestSignatureParams.md deleted file mode 100644 index 486802b43..000000000 --- a/docs/content/reference/events-api/interfaces/VerifyRequestSignatureParams.md +++ /dev/null @@ -1,59 +0,0 @@ -# Interface: VerifyRequestSignatureParams - -Parameters for calling [verifyRequestSignature](../functions/verifyRequestSignature.md). - -## Properties - -### body - -```ts -body: string; -``` - -Full, raw body string. - -#### Defined in - -[packages/events-api/src/http-handler.ts:280](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L280) - -*** - -### requestSignature - -```ts -requestSignature: string; -``` - -Signature from the `X-Slack-Signature` header. - -#### Defined in - -[packages/events-api/src/http-handler.ts:270](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L270) - -*** - -### requestTimestamp - -```ts -requestTimestamp: number; -``` - -Timestamp from the `X-Slack-Request-Timestamp` header. - -#### Defined in - -[packages/events-api/src/http-handler.ts:275](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L275) - -*** - -### signingSecret - -```ts -signingSecret: string; -``` - -The signing secret used to verify request signature. - -#### Defined in - -[packages/events-api/src/http-handler.ts:265](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L265) diff --git a/docs/content/reference/events-api/typedoc-sidebar.cjs b/docs/content/reference/events-api/typedoc-sidebar.cjs deleted file mode 100644 index e72347534..000000000 --- a/docs/content/reference/events-api/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/events-api/enumerations/ErrorCode","label":"ErrorCode"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/events-api/classes/SlackEventAdapter","label":"SlackEventAdapter"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/events-api/interfaces/CodedError","label":"CodedError"},{"type":"doc","id":"reference/events-api/interfaces/EventAdapterOptions","label":"EventAdapterOptions"},{"type":"doc","id":"reference/events-api/interfaces/VerifyRequestSignatureParams","label":"VerifyRequestSignatureParams"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/events-api/variables/errorCodes","label":"errorCodes"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"reference/events-api/functions/createEventAdapter","label":"createEventAdapter"},{"type":"doc","id":"reference/events-api/functions/verifyRequestSignature","label":"verifyRequestSignature"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/events-api/variables/errorCodes.md b/docs/content/reference/events-api/variables/errorCodes.md deleted file mode 100644 index 9bbd7a477..000000000 --- a/docs/content/reference/events-api/variables/errorCodes.md +++ /dev/null @@ -1,29 +0,0 @@ -# Variable: errorCodes - -```ts -const errorCodes: object; -``` - -## Type declaration - -### BODY\_PARSER\_NOT\_PERMITTED - -```ts -BODY_PARSER_NOT_PERMITTED: ErrorCode = ErrorCode.BodyParserNotPermitted; -``` - -### REQUEST\_TIME\_FAILURE - -```ts -REQUEST_TIME_FAILURE: ErrorCode = ErrorCode.RequestTimeFailure; -``` - -### SIGNATURE\_VERIFICATION\_FAILURE - -```ts -SIGNATURE_VERIFICATION_FAILURE: ErrorCode = ErrorCode.SignatureVerificationFailure; -``` - -## Defined in - -[packages/events-api/src/http-handler.ts:305](https://github.com/slackapi/node-slack-sdk/blob/main/packages/events-api/src/http-handler.ts#L305) diff --git a/docs/content/reference/interactive-messages/classes/SlackMessageAdapter.md b/docs/content/reference/interactive-messages/classes/SlackMessageAdapter.md deleted file mode 100644 index 774e5f43c..000000000 --- a/docs/content/reference/interactive-messages/classes/SlackMessageAdapter.md +++ /dev/null @@ -1,382 +0,0 @@ -# Class: SlackMessageAdapter - -An adapter for Slack's interactive message components such as buttons, menus, and dialogs. - -## Constructors - -### new SlackMessageAdapter() - -```ts -new SlackMessageAdapter(signingSecret, __namedParameters): SlackMessageAdapter -``` - -Create a message adapter. - -#### Parameters - -• **signingSecret**: `string` - -Slack app signing secret used to authenticate request - -• **\_\_namedParameters**: [`MessageAdapterOptions`](../interfaces/MessageAdapterOptions.md) = `{}` - -#### Returns - -[`SlackMessageAdapter`](SlackMessageAdapter.md) - -#### Defined in - -[adapter.ts:154](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L154) - -## Properties - -### lateResponseFallbackEnabled - -```ts -lateResponseFallbackEnabled: boolean; -``` - -Whether or not promises that resolve after the syncResponseTimeout can fallback to a request for the response_url. -This only works in cases where the semantic meaning of the response and the response_url are the same. - -#### Defined in - -[adapter.ts:136](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L136) - -*** - -### signingSecret - -```ts -signingSecret: string; -``` - -Slack app signing secret used to authenticate request - -#### Defined in - -[adapter.ts:124](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L124) - -*** - -### syncResponseTimeout - -```ts -syncResponseTimeout: number; -``` - -The number of milliseconds to wait before flushing a synchronous response to an incoming request and falling back -to an asynchronous response. - -#### Defined in - -[adapter.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L130) - -## Methods - -### action() - -```ts -action(matchingConstraints, callback): this -``` - -Add a handler for an interactive message action. - -Usually there's no need to be concerned with _how_ a message is sent to Slack, but the following table describes it -fully. - -**Action**|**Return `object`**|**Return `Promise`**|**Return `undefined`**|**Call `respond(message)`**|**Notes** -:-----:|:-----:|:-----:|:-----:|:-----:|:-----: -**Button Press**| Message in response | When resolved before `syncResponseTimeout` or `lateResponseFallbackEnabled: false`, message in response
When resolved after `syncResponseTimeout` and `lateResponseFallbackEnabled: true`, message in request to `response_url` | Empty response | Message in request to `response_url` | Create a new message instead of replacing using `replace_original: false` -**Menu Selection**| Message in response | When resolved before `syncResponseTimeout` or `lateResponseFallbackEnabled: false`, message in response
When resolved after `syncResponseTimeout` and `lateResponseFallbackEnabled: true`, message in request to `response_url` | Empty response | Message in request to `response_url` | Create a new message instead of replacing using `replace_original: false` -**Message Action** | Message in response | When resolved before `syncResponseTimeout` or `lateResponseFallbackEnabled: false`, message in response
When resolved after `syncResponseTimeout` and `lateResponseFallbackEnabled: true`, message in request to `response_url` | Empty response | Message in request to `response_url` | -**Dialog Submission**| Error list in response | Error list in response | Empty response | Message in request to `response_url` | Returning a Promise that takes longer than 3 seconds to resolve can result in the user seeing an error. Warning logged if a promise isn't completed before `syncResponseTimeout`. - -#### Parameters - -• **matchingConstraints**: `string` \| `RegExp` \| [`ActionConstraints`](../interfaces/ActionConstraints.md) - -the callback ID (as a string or RegExp) or an object describing the constraints to - match actions for the handler. - -• **callback**: [`ActionHandler`](../type-aliases/ActionHandler.md) - -the function to run when an action is matched - -#### Returns - -`this` - -this instance (for chaining) - -#### Defined in - -[adapter.ts:284](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L284) - -*** - -### createServer() - -```ts -createServer(): Promise -``` - -Create a server that dispatches Slack's interactive message actions and menu requests to this message adapter -instance. Use this method if your application will handle starting the server. - -#### Returns - -`Promise`\<`Server`\> - -A promise that resolves to an instance of http.Server and will dispatch interactive message actions and - options requests to this message adapter instance. See - https://nodejs.org/dist/latest/docs/api/http.html#http_class_http_server - -#### Defined in - -[adapter.ts:197](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L197) - -*** - -### dispatch() - -```ts -dispatch(payload): undefined | Promise -``` - -**`Internal`** - -Dispatches the contents of an HTTP request to the registered handlers. - -#### Parameters - -• **payload**: `any` - -#### Returns - -`undefined` \| `Promise`\<[`DispatchResult`](../interfaces/DispatchResult.md)\> - -A promise of the response information (an object with status and content that is a JSON serializable - object or a string or undefined) for the request. An undefined return value indicates that the request was not - matched. - -#### Remarks - -This is an internal API not meant to be used by code depending on this package. - -#### Defined in - -[adapter.ts:424](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L424) - -*** - -### expressMiddleware() - -```ts -expressMiddleware(): RequestHandler -``` - -Create a middleware function that can be used to integrate with the `express` web framework in order for incoming -requests to be dispatched to this message adapter instance. - -#### Returns - -`RequestHandler` - -A middleware function (see http://expressjs.com/en/guide/using-middleware.html) - -#### Defined in - -[adapter.ts:248](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L248) - -*** - -### options() - -```ts -options(matchingConstraints, callback): this -``` - -Add a handler for an options request - -Usually there's no need to be concerned with _how_ a message is sent to Slack, but the -following table describes it fully - - |**Return `options`**|**Return `Promise`**|**Return `undefined`**|**Notes** -:-----:|:-----:|:-----:|:-----:|:-----: -**Options Request**| Options in response | Options in response | Empty response | Returning a Promise that takes longer than 3 seconds to resolve can result in the user seeing an error. If the request is from within a dialog, the `text` field is called `label`. - -#### Parameters - -• **matchingConstraints**: `string` \| `RegExp` \| [`OptionsConstraints`](../interfaces/OptionsConstraints.md) - -the callback ID (as a string or RegExp) or an object describing the constraints to - select options requests for the handler. - -• **callback**: [`OptionsHandler`](../type-aliases/OptionsHandler.md) - -the function to run when an options request is matched - -#### Returns - -`this` - -this instance (for chaining) - -#### Defined in - -[adapter.ts:342](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L342) - -*** - -### requestListener() - -```ts -requestListener(): RequestListener -``` - -Create a request listener function that handles HTTP requests, verifies requests and dispatches responses - -#### Returns - -`RequestListener` - -#### Defined in - -[adapter.ts:258](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L258) - -*** - -### shortcut() - -```ts -shortcut(matchingConstraints, callback): this -``` - -#### Parameters - -• **matchingConstraints**: `string` \| `RegExp` \| [`ShortcutConstraints`](../interfaces/ShortcutConstraints.md) - -• **callback**: [`ShortcutHandler`](../type-aliases/ShortcutHandler.md) - -#### Returns - -`this` - -#### Defined in - -[adapter.ts:308](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L308) - -*** - -### start() - -```ts -start(port): Promise -``` - -Start a built-in server that dispatches Slack's interactive message actions and menu requests to this message -adapter interface. - -#### Parameters - -• **port**: `number` - -#### Returns - -`Promise`\<`Server`\> - -A promise that resolves once the server is ready - -#### Defined in - -[adapter.ts:208](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L208) - -*** - -### stop() - -```ts -stop(): Promise -``` - -Stop the previously started built-in server. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves once the server is cleaned up. - -#### Defined in - -[adapter.ts:223](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L223) - -*** - -### viewClosed() - -```ts -viewClosed(matchingConstraints, callback): this -``` - -Add a handler for view closed interaction. The handler should not return a value. - -#### Parameters - -• **matchingConstraints**: `string` \| `RegExp` \| [`ViewConstraints`](../interfaces/ViewConstraints.md) - -the callback ID (as a string or RegExp) or an object describing the constraints to - match view closed interactions for the handler. - -• **callback**: [`ViewClosedHandler`](../type-aliases/ViewClosedHandler.md) - -the function to run when an view closed interaction is matched - -#### Returns - -`this` - -this instance (for chaining) - -#### Defined in - -[adapter.ts:397](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L397) - -*** - -### viewSubmission() - -```ts -viewSubmission(matchingConstraints, callback): this -``` - -Add a handler for view submission. - -The value returned from the `callback` determines the response sent back to Slack. The handler can return a plain -object with a `response_action` property to dismiss the modal, push a view into the modal, display validation -errors, or update the view. Alternatively, the handler can return a Promise for this kind of object, which resolves -before `syncResponseTimeout` or `lateResponseFallbackEnabled: false`, to perform the same response actions. If the -Promise resolves afterwards or `lateResponseFallbackEnabled: true` then the modal will be dismissed. If the handler -returns `undefined` the modal will be dismissed. - -#### Parameters - -• **matchingConstraints**: `string` \| `RegExp` \| [`ViewConstraints`](../interfaces/ViewConstraints.md) - -the callback ID (as a string or RegExp) or an object describing the constraints to - match view submissions for the handler. - -• **callback**: [`ViewSubmissionHandler`](../type-aliases/ViewSubmissionHandler.md) - -the function to run when an view submission is matched - -#### Returns - -`this` - -this instance (for chaining) - -#### Defined in - -[adapter.ts:375](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L375) diff --git a/docs/content/reference/interactive-messages/enumerations/ErrorCode.md b/docs/content/reference/interactive-messages/enumerations/ErrorCode.md deleted file mode 100644 index 07423d486..000000000 --- a/docs/content/reference/interactive-messages/enumerations/ErrorCode.md +++ /dev/null @@ -1,51 +0,0 @@ -# Enumeration: ErrorCode - -A dictionary of codes for errors produced by this package. - -## Enumeration Members - -### BodyParserNotPermitted - -```ts -BodyParserNotPermitted: "SLACKADAPTER_BODY_PARSER_NOT_PERMITTED_FAILURE"; -``` - -#### Defined in - -[errors.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/errors.ts#L8) - -*** - -### PromiseTimeout - -```ts -PromiseTimeout: "SLACKMESSAGEUTIL_PROMISE_TIMEOUT"; -``` - -#### Defined in - -[errors.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/errors.ts#L5) - -*** - -### RequestTimeFailure - -```ts -RequestTimeFailure: "SLACKHTTPHANDLER_REQUEST_TIMELIMIT_FAILURE"; -``` - -#### Defined in - -[errors.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/errors.ts#L7) - -*** - -### SignatureVerificationFailure - -```ts -SignatureVerificationFailure: "SLACKHTTPHANDLER_REQUEST_SIGNATURE_VERIFICATION_FAILURE"; -``` - -#### Defined in - -[errors.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/errors.ts#L6) diff --git a/docs/content/reference/interactive-messages/enumerations/ResponseStatus.md b/docs/content/reference/interactive-messages/enumerations/ResponseStatus.md deleted file mode 100644 index 3eb8a4e74..000000000 --- a/docs/content/reference/interactive-messages/enumerations/ResponseStatus.md +++ /dev/null @@ -1,27 +0,0 @@ -# Enumeration: ResponseStatus - -Some HTTP response statuses. - -## Enumeration Members - -### Failure - -```ts -Failure: 500; -``` - -#### Defined in - -[adapter.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L30) - -*** - -### Ok - -```ts -Ok: 200; -``` - -#### Defined in - -[adapter.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L29) diff --git a/docs/content/reference/interactive-messages/functions/createMessageAdapter.md b/docs/content/reference/interactive-messages/functions/createMessageAdapter.md deleted file mode 100644 index 3ad3a72f9..000000000 --- a/docs/content/reference/interactive-messages/functions/createMessageAdapter.md +++ /dev/null @@ -1,21 +0,0 @@ -# Function: createMessageAdapter() - -```ts -function createMessageAdapter(signingSecret, options?): SlackMessageAdapter -``` - -Factory method to create an instance of [SlackMessageAdapter](../classes/SlackMessageAdapter.md) - -## Parameters - -• **signingSecret**: `string` - -• **options?**: [`MessageAdapterOptions`](../interfaces/MessageAdapterOptions.md) - -## Returns - -[`SlackMessageAdapter`](../classes/SlackMessageAdapter.md) - -## Defined in - -[index.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/index.ts#L34) diff --git a/docs/content/reference/interactive-messages/index.md b/docs/content/reference/interactive-messages/index.md deleted file mode 100644 index dae9dc091..000000000 --- a/docs/content/reference/interactive-messages/index.md +++ /dev/null @@ -1,36 +0,0 @@ -# @slack/interactive-messages - -## Enumerations - -- [ErrorCode](enumerations/ErrorCode.md) -- [ResponseStatus](enumerations/ResponseStatus.md) - -## Classes - -- [SlackMessageAdapter](classes/SlackMessageAdapter.md) - -## Interfaces - -- [ActionConstraints](interfaces/ActionConstraints.md) -- [DispatchResult](interfaces/DispatchResult.md) -- [MessageAdapterOptions](interfaces/MessageAdapterOptions.md) -- [OptionsConstraints](interfaces/OptionsConstraints.md) -- [ShortcutConstraints](interfaces/ShortcutConstraints.md) -- [ViewConstraints](interfaces/ViewConstraints.md) - -## Type Aliases - -- [ActionHandler](type-aliases/ActionHandler.md) -- [OptionsHandler](type-aliases/OptionsHandler.md) -- [Respond](type-aliases/Respond.md) -- [ShortcutHandler](type-aliases/ShortcutHandler.md) -- [ViewClosedHandler](type-aliases/ViewClosedHandler.md) -- [ViewSubmissionHandler](type-aliases/ViewSubmissionHandler.md) - -## Variables - -- [errorCodes](variables/errorCodes.md) - -## Functions - -- [createMessageAdapter](functions/createMessageAdapter.md) diff --git a/docs/content/reference/interactive-messages/interfaces/ActionConstraints.md b/docs/content/reference/interactive-messages/interfaces/ActionConstraints.md deleted file mode 100644 index 12fda911a..000000000 --- a/docs/content/reference/interactive-messages/interfaces/ActionConstraints.md +++ /dev/null @@ -1,75 +0,0 @@ -# Interface: ActionConstraints - -Constraints on when to call an action handler. - -## Properties - -### actionId? - -```ts -optional actionId: string | RegExp; -``` - -A string or RegExp to match against the `action_id` - -#### Defined in - -[adapter.ts:693](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L693) - -*** - -### blockId? - -```ts -optional blockId: string | RegExp; -``` - -A string or RegExp to match against the `block_id` - -#### Defined in - -[adapter.ts:688](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L688) - -*** - -### callbackId? - -```ts -optional callbackId: string | RegExp; -``` - -A string or RegExp to match against the `callback_id` - -#### Defined in - -[adapter.ts:683](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L683) - -*** - -### type? - -```ts -optional type: string; -``` - -Valid types include all -[actions block elements](https://api.slack.com/reference/messaging/interactive-components), -`select` only for menu selections, or `dialog_submission` only for dialog submissions - -#### Defined in - -[adapter.ts:700](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L700) - -*** - -### unfurl? - -```ts -optional unfurl: boolean; -``` - -When `true` only match actions from an unfurl - -#### Defined in - -[adapter.ts:705](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L705) diff --git a/docs/content/reference/interactive-messages/interfaces/DispatchResult.md b/docs/content/reference/interactive-messages/interfaces/DispatchResult.md deleted file mode 100644 index 448eddd3b..000000000 --- a/docs/content/reference/interactive-messages/interfaces/DispatchResult.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: DispatchResult - -The result of a call to [SlackMessageAdapter#dispatch](../classes/SlackMessageAdapter.md#dispatch). - -## Properties - -### content? - -```ts -optional content: any; -``` - -#### Defined in - -[adapter.ts:664](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L664) - -*** - -### status - -```ts -status: ResponseStatus; -``` - -#### Defined in - -[adapter.ts:663](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L663) diff --git a/docs/content/reference/interactive-messages/interfaces/MessageAdapterOptions.md b/docs/content/reference/interactive-messages/interfaces/MessageAdapterOptions.md deleted file mode 100644 index 653099511..000000000 --- a/docs/content/reference/interactive-messages/interfaces/MessageAdapterOptions.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: MessageAdapterOptions - -Options for constructing [SlackMessageAdapter](../classes/SlackMessageAdapter.md). - -## Properties - -### agent? - -```ts -optional agent: any; -``` - -#### Defined in - -[adapter.ts:673](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L673) - -*** - -### lateResponseFallbackEnabled? - -```ts -optional lateResponseFallbackEnabled: boolean; -``` - -#### Defined in - -[adapter.ts:672](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L672) - -*** - -### syncResponseTimeout? - -```ts -optional syncResponseTimeout: number; -``` - -#### Defined in - -[adapter.ts:671](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L671) diff --git a/docs/content/reference/interactive-messages/interfaces/OptionsConstraints.md b/docs/content/reference/interactive-messages/interfaces/OptionsConstraints.md deleted file mode 100644 index 72cbc73c1..000000000 --- a/docs/content/reference/interactive-messages/interfaces/OptionsConstraints.md +++ /dev/null @@ -1,59 +0,0 @@ -# Interface: OptionsConstraints - -Constraints on when to call an options handler. - -## Properties - -### actionId? - -```ts -optional actionId: string | RegExp; -``` - -A string or RegExp to match against the `action_id` - -#### Defined in - -[adapter.ts:740](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L740) - -*** - -### blockId? - -```ts -optional blockId: string | RegExp; -``` - -A string or RegExp to match against the `block_id` - -#### Defined in - -[adapter.ts:735](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L735) - -*** - -### callbackId? - -```ts -optional callbackId: string | RegExp; -``` - -A string or RegExp to match against the `callback_id` - -#### Defined in - -[adapter.ts:730](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L730) - -*** - -### within - -```ts -within: "block_actions" | "interactive_message" | "dialog"; -``` - -The source of options request. - -#### Defined in - -[adapter.ts:745](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L745) diff --git a/docs/content/reference/interactive-messages/interfaces/ShortcutConstraints.md b/docs/content/reference/interactive-messages/interfaces/ShortcutConstraints.md deleted file mode 100644 index c3350f8f9..000000000 --- a/docs/content/reference/interactive-messages/interfaces/ShortcutConstraints.md +++ /dev/null @@ -1,31 +0,0 @@ -# Interface: ShortcutConstraints - -Constraints on when to call an shortcut handler. - -## Properties - -### callbackId? - -```ts -optional callbackId: string | RegExp; -``` - -A string or RegExp to match against the `callback_id` - -#### Defined in - -[adapter.ts:715](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L715) - -*** - -### type? - -```ts -optional type: "shortcut"; -``` - -Valid type includes shortcut - -#### Defined in - -[adapter.ts:720](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L720) diff --git a/docs/content/reference/interactive-messages/interfaces/ViewConstraints.md b/docs/content/reference/interactive-messages/interfaces/ViewConstraints.md deleted file mode 100644 index d77d752cc..000000000 --- a/docs/content/reference/interactive-messages/interfaces/ViewConstraints.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: ViewConstraints - -Constraints on when to call a view submission or view closed handler. - -## Properties - -### callbackId? - -```ts -optional callbackId: string | RegExp; -``` - -A string or RegExp to match against the `callback_id` - -#### Defined in - -[adapter.ts:755](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L755) - -*** - -### externalId? - -```ts -optional externalId: string | RegExp; -``` - -A string to match against the `external_id` - -#### Defined in - -[adapter.ts:760](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L760) - -*** - -### viewId? - -```ts -optional viewId: string; -``` - -A string to match against the `view_id` - -#### Defined in - -[adapter.ts:765](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L765) diff --git a/docs/content/reference/interactive-messages/type-aliases/ActionHandler.md b/docs/content/reference/interactive-messages/type-aliases/ActionHandler.md deleted file mode 100644 index 734d733f1..000000000 --- a/docs/content/reference/interactive-messages/type-aliases/ActionHandler.md +++ /dev/null @@ -1,39 +0,0 @@ -# Type Alias: ActionHandler() - -```ts -type ActionHandler: (payload, respond) => any | Promise | undefined; -``` - -## Parameters - -• **payload**: `any` - -an object describing the - [block actions](https://api.slack.com/messaging/interactivity/enabling#understanding-payloads) - [button press](https://api.slack.com/docs/message-buttons#responding_to_message_actions), - [menu selection](https://api.slack.com/docs/message-menus#request_url_response), or - [dialog submission](https://api.slack.com/dialogs#evaluating_submission_responses). - -• **respond**: [`Respond`](Respond.md) - -When the action is a button press or menu selection, this function is used to update the message - where the action occurred or create new messages in the same conversation. When the action is a dialog submission, - this function is used to create new messages in the conversation where the dialog was triggered. - -## Returns - -`any` \| `Promise`\<`any`\> \| `undefined` - -When the action is a button press or a menu selection, this object is a replacement - [message](https://api.slack.com/docs/interactive-message-field-guide#top-level_message_fields) for the message in - which the action occurred. It may also be a Promise for a message, and if so and the Promise takes longer than the - `syncResponseTimeout` to complete, the message is sent over the `response_url`. The message may also be a new - message in the same conversation by setting `replace_original: false`. When the action is a dialog submission, - this object is a list of [validation errors](https://api.slack.com/dialogs#input_validation). It may also be a - Promise for a list of validation errors, and if so and the Promise takes longer than the `syncResponseTimeout` to - complete, Slack will display an error to the user. If there is no return value, then button presses and menu - selections do not update the message and dialog submissions will validate and dismiss. - -## Defined in - -[adapter.ts:813](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L813) diff --git a/docs/content/reference/interactive-messages/type-aliases/OptionsHandler.md b/docs/content/reference/interactive-messages/type-aliases/OptionsHandler.md deleted file mode 100644 index 8371a2553..000000000 --- a/docs/content/reference/interactive-messages/type-aliases/OptionsHandler.md +++ /dev/null @@ -1,28 +0,0 @@ -# Type Alias: OptionsHandler() - -```ts -type OptionsHandler: (payload) => any | Promise | undefined; -``` - -## Parameters - -• **payload**: `any` - -an object describing - [the state of the menu](https://api.slack.com/docs/message-menus#options_load_url) - -## Returns - -`any` \| `Promise`\<`any`\> \| `undefined` - -an [options list](https://api.slack.com/docs/interactive-message-field-guide#option_fields) or - [option groups list](https://api.slack.com/docs/interactive-message-field-guide#option_groups). When the menu is - within an interactive message, (`within: 'interactive_message'`) the option keys are `text` and `value`. When the - menu is within a dialog (`within: 'dialog'`) the option keys are `label` and `value`. When the menu is within a - dialog (`within: 'block_actions'`) the option keys are a text block and `value`. This function may also return a - Promise either of these values. If a Promise is returned and it does not complete within 3 seconds, Slack will - display an error to the user. If there is no return value, then the user is shown an empty list of options. - -## Defined in - -[adapter.ts:835](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L835) diff --git a/docs/content/reference/interactive-messages/type-aliases/Respond.md b/docs/content/reference/interactive-messages/type-aliases/Respond.md deleted file mode 100644 index 7714ed892..000000000 --- a/docs/content/reference/interactive-messages/type-aliases/Respond.md +++ /dev/null @@ -1,23 +0,0 @@ -# Type Alias: Respond() - -```ts -type Respond: (message) => Promise; -``` - -## Parameters - -• **message**: `any` - -a [message](https://api.slack.com/docs/interactive-message-field-guide#top-level_message_fields). - Dialog submissions do not allow `replace_original: false` on this message. - -## Returns - -`Promise`\<`unknown`\> - -there's no contract or interface for the resolution value, but this Promise will resolve when the HTTP - response from the `response_url` request is complete and reject when there is an error. - -## Defined in - -[adapter.ts:789](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L789) diff --git a/docs/content/reference/interactive-messages/type-aliases/ShortcutHandler.md b/docs/content/reference/interactive-messages/type-aliases/ShortcutHandler.md deleted file mode 100644 index 30d633ee4..000000000 --- a/docs/content/reference/interactive-messages/type-aliases/ShortcutHandler.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ShortcutHandler() - -```ts -type ShortcutHandler: (payload) => any | Promise | undefined; -``` - -A handler function for global shortcuts. - -TODO: describe the payload and return values more specifically? - -## Parameters - -• **payload**: `any` - -## Returns - -`any` \| `Promise`\<`any`\> \| `undefined` - -## Defined in - -[adapter.ts:820](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L820) diff --git a/docs/content/reference/interactive-messages/type-aliases/ViewClosedHandler.md b/docs/content/reference/interactive-messages/type-aliases/ViewClosedHandler.md deleted file mode 100644 index ff6a4d773..000000000 --- a/docs/content/reference/interactive-messages/type-aliases/ViewClosedHandler.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ViewClosedHandler() - -```ts -type ViewClosedHandler: (payload) => void; -``` - -A handler function for view closed requests. - -TODO: describe the payload and return values more specifically? - -## Parameters - -• **payload**: `any` - -## Returns - -`void` - -## Defined in - -[adapter.ts:849](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L849) diff --git a/docs/content/reference/interactive-messages/type-aliases/ViewSubmissionHandler.md b/docs/content/reference/interactive-messages/type-aliases/ViewSubmissionHandler.md deleted file mode 100644 index dae70ee31..000000000 --- a/docs/content/reference/interactive-messages/type-aliases/ViewSubmissionHandler.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ViewSubmissionHandler() - -```ts -type ViewSubmissionHandler: (payload) => any | Promise | undefined; -``` - -A handler function for view submission requests. - -TODO: describe the payload and return values more specifically? - -## Parameters - -• **payload**: `any` - -## Returns - -`any` \| `Promise`\<`any`\> \| `undefined` - -## Defined in - -[adapter.ts:842](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/adapter.ts#L842) diff --git a/docs/content/reference/interactive-messages/typedoc-sidebar.cjs b/docs/content/reference/interactive-messages/typedoc-sidebar.cjs deleted file mode 100644 index 0fb80bc36..000000000 --- a/docs/content/reference/interactive-messages/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/interactive-messages/enumerations/ErrorCode","label":"ErrorCode"},{"type":"doc","id":"reference/interactive-messages/enumerations/ResponseStatus","label":"ResponseStatus"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/interactive-messages/classes/SlackMessageAdapter","label":"SlackMessageAdapter"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/interactive-messages/interfaces/ActionConstraints","label":"ActionConstraints"},{"type":"doc","id":"reference/interactive-messages/interfaces/DispatchResult","label":"DispatchResult"},{"type":"doc","id":"reference/interactive-messages/interfaces/MessageAdapterOptions","label":"MessageAdapterOptions"},{"type":"doc","id":"reference/interactive-messages/interfaces/OptionsConstraints","label":"OptionsConstraints"},{"type":"doc","id":"reference/interactive-messages/interfaces/ShortcutConstraints","label":"ShortcutConstraints"},{"type":"doc","id":"reference/interactive-messages/interfaces/ViewConstraints","label":"ViewConstraints"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/interactive-messages/type-aliases/ActionHandler","label":"ActionHandler"},{"type":"doc","id":"reference/interactive-messages/type-aliases/OptionsHandler","label":"OptionsHandler"},{"type":"doc","id":"reference/interactive-messages/type-aliases/Respond","label":"Respond"},{"type":"doc","id":"reference/interactive-messages/type-aliases/ShortcutHandler","label":"ShortcutHandler"},{"type":"doc","id":"reference/interactive-messages/type-aliases/ViewClosedHandler","label":"ViewClosedHandler"},{"type":"doc","id":"reference/interactive-messages/type-aliases/ViewSubmissionHandler","label":"ViewSubmissionHandler"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/interactive-messages/variables/errorCodes","label":"errorCodes"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"reference/interactive-messages/functions/createMessageAdapter","label":"createMessageAdapter"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/interactive-messages/variables/errorCodes.md b/docs/content/reference/interactive-messages/variables/errorCodes.md deleted file mode 100644 index cddb80b45..000000000 --- a/docs/content/reference/interactive-messages/variables/errorCodes.md +++ /dev/null @@ -1,19 +0,0 @@ -# Variable: errorCodes - -```ts -const errorCodes: object; -``` - -Dictionary of error codes that may appear on errors emitted from this package's objects - -## Type declaration - -### BODY\_PARSER\_NOT\_PERMITTED - -```ts -readonly BODY_PARSER_NOT_PERMITTED: BodyParserNotPermitted = ErrorCode.BodyParserNotPermitted; -``` - -## Defined in - -[index.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/interactive-messages/src/index.ts#L25) diff --git a/docs/content/reference/logger/classes/ConsoleLogger.md b/docs/content/reference/logger/classes/ConsoleLogger.md deleted file mode 100644 index fecea0306..000000000 --- a/docs/content/reference/logger/classes/ConsoleLogger.md +++ /dev/null @@ -1,201 +0,0 @@ -# Class: ConsoleLogger - -Default logger which logs to stdout and stderr - -## Implements - -- [`Logger`](../interfaces/Logger.md) - -## Constructors - -### new ConsoleLogger() - -```ts -new ConsoleLogger(): ConsoleLogger -``` - -#### Returns - -[`ConsoleLogger`](ConsoleLogger.md) - -#### Defined in - -[index.ts:90](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L90) - -## Methods - -### debug() - -```ts -debug(...msg): void -``` - -Log a debug message - -#### Parameters - -• ...**msg**: `any`[] - -#### Returns - -`void` - -#### Implementation of - -[`Logger`](../interfaces/Logger.md).[`debug`](../interfaces/Logger.md#debug) - -#### Defined in - -[index.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L117) - -*** - -### error() - -```ts -error(...msg): void -``` - -Log an error message - -#### Parameters - -• ...**msg**: `any`[] - -#### Returns - -`void` - -#### Implementation of - -[`Logger`](../interfaces/Logger.md).[`error`](../interfaces/Logger.md#error) - -#### Defined in - -[index.ts:147](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L147) - -*** - -### getLevel() - -```ts -getLevel(): LogLevel -``` - -Return the current LogLevel. - -#### Returns - -[`LogLevel`](../enumerations/LogLevel.md) - -#### Implementation of - -[`Logger`](../interfaces/Logger.md).[`getLevel`](../interfaces/Logger.md#getlevel) - -#### Defined in - -[index.ts:95](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L95) - -*** - -### info() - -```ts -info(...msg): void -``` - -Log an info message - -#### Parameters - -• ...**msg**: `any`[] - -#### Returns - -`void` - -#### Implementation of - -[`Logger`](../interfaces/Logger.md).[`info`](../interfaces/Logger.md#info) - -#### Defined in - -[index.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L127) - -*** - -### setLevel() - -```ts -setLevel(level): void -``` - -Sets the instance's log level so that only messages which are equal or more severe are output to the console. - -#### Parameters - -• **level**: [`LogLevel`](../enumerations/LogLevel.md) - -#### Returns - -`void` - -#### Implementation of - -[`Logger`](../interfaces/Logger.md).[`setLevel`](../interfaces/Logger.md#setlevel) - -#### Defined in - -[index.ts:102](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L102) - -*** - -### setName() - -```ts -setName(name): void -``` - -Set the instance's name, which will appear on each log line before the message. - -#### Parameters - -• **name**: `string` - -#### Returns - -`void` - -#### Implementation of - -[`Logger`](../interfaces/Logger.md).[`setName`](../interfaces/Logger.md#setname) - -#### Defined in - -[index.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L109) - -*** - -### warn() - -```ts -warn(...msg): void -``` - -Log a warning message - -#### Parameters - -• ...**msg**: `any`[] - -#### Returns - -`void` - -#### Implementation of - -[`Logger`](../interfaces/Logger.md).[`warn`](../interfaces/Logger.md#warn) - -#### Defined in - -[index.ts:137](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L137) diff --git a/docs/content/reference/logger/enumerations/LogLevel.md b/docs/content/reference/logger/enumerations/LogLevel.md deleted file mode 100644 index 69614a47c..000000000 --- a/docs/content/reference/logger/enumerations/LogLevel.md +++ /dev/null @@ -1,51 +0,0 @@ -# Enumeration: LogLevel - -Severity levels for log entries - -## Enumeration Members - -### DEBUG - -```ts -DEBUG: "debug"; -``` - -#### Defined in - -[index.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L10) - -*** - -### ERROR - -```ts -ERROR: "error"; -``` - -#### Defined in - -[index.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L7) - -*** - -### INFO - -```ts -INFO: "info"; -``` - -#### Defined in - -[index.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L9) - -*** - -### WARN - -```ts -WARN: "warn"; -``` - -#### Defined in - -[index.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L8) diff --git a/docs/content/reference/logger/index.md b/docs/content/reference/logger/index.md deleted file mode 100644 index aa5090552..000000000 --- a/docs/content/reference/logger/index.md +++ /dev/null @@ -1,13 +0,0 @@ -# @slack/logger - -## Enumerations - -- [LogLevel](enumerations/LogLevel.md) - -## Classes - -- [ConsoleLogger](classes/ConsoleLogger.md) - -## Interfaces - -- [Logger](interfaces/Logger.md) diff --git a/docs/content/reference/logger/interfaces/Logger.md b/docs/content/reference/logger/interfaces/Logger.md deleted file mode 100644 index bc426ad6a..000000000 --- a/docs/content/reference/logger/interfaces/Logger.md +++ /dev/null @@ -1,167 +0,0 @@ -# Interface: Logger - -Interface for objects where objects in this package's logs can be sent (can be used as `logger` option). - -## Methods - -### debug() - -```ts -debug(...msg): void -``` - -Output debug message - -#### Parameters - -• ...**msg**: `any`[] - -any data to log - -#### Returns - -`void` - -#### Defined in - -[index.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L22) - -*** - -### error() - -```ts -error(...msg): void -``` - -Output error message - -#### Parameters - -• ...**msg**: `any`[] - -any data to log - -#### Returns - -`void` - -#### Defined in - -[index.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L43) - -*** - -### getLevel() - -```ts -getLevel(): LogLevel -``` - -Return the current LogLevel. - -#### Returns - -[`LogLevel`](../enumerations/LogLevel.md) - -#### Defined in - -[index.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L55) - -*** - -### info() - -```ts -info(...msg): void -``` - -Output info message - -#### Parameters - -• ...**msg**: `any`[] - -any data to log - -#### Returns - -`void` - -#### Defined in - -[index.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L29) - -*** - -### setLevel() - -```ts -setLevel(level): void -``` - -This disables all logging below the given level, so that after a log.setLevel("warn") call log.warn("something") -or log.error("something") will output messages, but log.info("something") will not. - -#### Parameters - -• **level**: [`LogLevel`](../enumerations/LogLevel.md) - -as a string, like 'error' (case-insensitive) - -#### Returns - -`void` - -#### Defined in - -[index.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L50) - -*** - -### setName() - -```ts -setName(name): void -``` - -This allows the instance to be named so that they can easily be filtered when many loggers are sending output -to the same destination. - -#### Parameters - -• **name**: `string` - -as a string, will be output with every log after the level - -#### Returns - -`void` - -#### Defined in - -[index.ts:62](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L62) - -*** - -### warn() - -```ts -warn(...msg): void -``` - -Output warn message - -#### Parameters - -• ...**msg**: `any`[] - -any data to log - -#### Returns - -`void` - -#### Defined in - -[index.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/logger/src/index.ts#L36) diff --git a/docs/content/reference/logger/typedoc-sidebar.cjs b/docs/content/reference/logger/typedoc-sidebar.cjs deleted file mode 100644 index be53408c9..000000000 --- a/docs/content/reference/logger/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/logger/enumerations/LogLevel","label":"LogLevel"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/logger/classes/ConsoleLogger","label":"ConsoleLogger"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/logger/interfaces/Logger","label":"Logger"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/oauth/classes/AuthorizationError.md b/docs/content/reference/oauth/classes/AuthorizationError.md deleted file mode 100644 index 75bb0549d..000000000 --- a/docs/content/reference/oauth/classes/AuthorizationError.md +++ /dev/null @@ -1,123 +0,0 @@ -# Class: AuthorizationError - -## Extends - -- `Error` - -## Implements - -- [`CodedError`](../interfaces/CodedError.md) - -## Constructors - -### new AuthorizationError() - -```ts -new AuthorizationError(message, original?): AuthorizationError -``` - -#### Parameters - -• **message**: `string` - -• **original?**: `Error` - -#### Returns - -[`AuthorizationError`](AuthorizationError.md) - -#### Overrides - -`Error.constructor` - -#### Defined in - -[packages/oauth/src/errors.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L45) - -## Properties - -### code - -```ts -code: ErrorCode = ErrorCode.AuthorizationError; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) - -#### Defined in - -[packages/oauth/src/errors.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L41) - -*** - -### message - -```ts -message: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) - -#### Inherited from - -`Error.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) - -#### Inherited from - -`Error.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### original - -```ts -original: undefined | Error; -``` - -#### Defined in - -[packages/oauth/src/errors.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L43) - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) - -#### Inherited from - -`Error.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/ClearStateStore.md b/docs/content/reference/oauth/classes/ClearStateStore.md deleted file mode 100644 index 5297be143..000000000 --- a/docs/content/reference/oauth/classes/ClearStateStore.md +++ /dev/null @@ -1,93 +0,0 @@ -# Class: ClearStateStore - -Generates state parameter value in the OAuth flow. -While the state parameter value works for the CSRF protection purpose, -it can transfer the given InstallURLOptions value to the Redirect URL handler -(Redirect URL: the default path is "/slack/oauth_redirect") - -## Implements - -- [`StateStore`](../interfaces/StateStore.md) - -## Constructors - -### new ClearStateStore() - -```ts -new ClearStateStore(stateSecret, stateExpirationSeconds): ClearStateStore -``` - -#### Parameters - -• **stateSecret**: `string` - -• **stateExpirationSeconds**: `number` = `600` - -#### Returns - -[`ClearStateStore`](ClearStateStore.md) - -#### Defined in - -[packages/oauth/src/state-stores/clear-state-store.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L13) - -## Methods - -### generateStateParam() - -```ts -generateStateParam(installOptions, now): Promise -``` - -Generates a valid state parameter value, which can be decoded as a StateObj object -by the verifyStateParam() method. This value may be stored on the server-side with expiration. -The InstallProvider verifies if this value is set in the installer's browser session. - -#### Parameters - -• **installOptions**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) - -• **now**: `Date` - -#### Returns - -`Promise`\<`string`\> - -#### Implementation of - -[`StateStore`](../interfaces/StateStore.md).[`generateStateParam`](../interfaces/StateStore.md#generatestateparam) - -#### Defined in - -[packages/oauth/src/state-stores/clear-state-store.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L21) - -*** - -### verifyStateParam() - -```ts -verifyStateParam(now, state): Promise -``` - -Verifies the given state string value by trying to decode the value and -build the passed InstallURLOptions object from the data. -This method verifies if the state value is not too old to detect replay attacks. -If the value is invalid, this method can throw InvalidStateError exception. - -#### Parameters - -• **now**: `Date` - -• **state**: `string` - -#### Returns - -`Promise`\<[`InstallURLOptions`](../interfaces/InstallURLOptions.md)\> - -#### Implementation of - -[`StateStore`](../interfaces/StateStore.md).[`verifyStateParam`](../interfaces/StateStore.md#verifystateparam) - -#### Defined in - -[packages/oauth/src/state-stores/clear-state-store.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts#L33) diff --git a/docs/content/reference/oauth/classes/FileInstallationStore.md b/docs/content/reference/oauth/classes/FileInstallationStore.md deleted file mode 100644 index 06ca6e1ae..000000000 --- a/docs/content/reference/oauth/classes/FileInstallationStore.md +++ /dev/null @@ -1,103 +0,0 @@ -# Class: FileInstallationStore - -## Implements - -- [`InstallationStore`](../interfaces/InstallationStore.md) - -## Constructors - -### new FileInstallationStore() - -```ts -new FileInstallationStore(__namedParameters): FileInstallationStore -``` - -#### Parameters - -• **\_\_namedParameters**: `FileInstallationOptions` = `{}` - -#### Returns - -[`FileInstallationStore`](FileInstallationStore.md) - -#### Defined in - -[packages/oauth/src/installation-stores/file-store.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L19) - -## Methods - -### deleteInstallation() - -```ts -deleteInstallation(query, logger?): Promise -``` - -#### Parameters - -• **query**: [`InstallationQuery`](../interfaces/InstallationQuery.md)\<`boolean`\> - -• **logger?**: `any` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`InstallationStore`](../interfaces/InstallationStore.md).[`deleteInstallation`](../interfaces/InstallationStore.md#deleteinstallation) - -#### Defined in - -[packages/oauth/src/installation-stores/file-store.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L97) - -*** - -### fetchInstallation() - -```ts -fetchInstallation(query, logger?): Promise> -``` - -#### Parameters - -• **query**: [`InstallationQuery`](../interfaces/InstallationQuery.md)\<`boolean`\> - -• **logger?**: `any` - -#### Returns - -`Promise`\<[`Installation`](../interfaces/Installation.md)\<`"v1"` \| `"v2"`, `boolean`\>\> - -#### Implementation of - -[`InstallationStore`](../interfaces/InstallationStore.md).[`fetchInstallation`](../interfaces/InstallationStore.md#fetchinstallation) - -#### Defined in - -[packages/oauth/src/installation-stores/file-store.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L61) - -*** - -### storeInstallation() - -```ts -storeInstallation(installation, logger?): Promise -``` - -#### Parameters - -• **installation**: [`Installation`](../interfaces/Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> - -• **logger?**: `any` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`InstallationStore`](../interfaces/InstallationStore.md).[`storeInstallation`](../interfaces/InstallationStore.md#storeinstallation) - -#### Defined in - -[packages/oauth/src/installation-stores/file-store.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts#L28) diff --git a/docs/content/reference/oauth/classes/FileStateStore.md b/docs/content/reference/oauth/classes/FileStateStore.md deleted file mode 100644 index 26fbe747e..000000000 --- a/docs/content/reference/oauth/classes/FileStateStore.md +++ /dev/null @@ -1,91 +0,0 @@ -# Class: FileStateStore - -Generates state parameter value in the OAuth flow. -While the state parameter value works for the CSRF protection purpose, -it can transfer the given InstallURLOptions value to the Redirect URL handler -(Redirect URL: the default path is "/slack/oauth_redirect") - -## Implements - -- [`StateStore`](../interfaces/StateStore.md) - -## Constructors - -### new FileStateStore() - -```ts -new FileStateStore(args): FileStateStore -``` - -#### Parameters - -• **args**: [`FileStateStoreArgs`](../interfaces/FileStateStoreArgs.md) - -#### Returns - -[`FileStateStore`](FileStateStore.md) - -#### Defined in - -[packages/oauth/src/state-stores/file-state-store.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L24) - -## Methods - -### generateStateParam() - -```ts -generateStateParam(installOptions, now): Promise -``` - -Generates a valid state parameter value, which can be decoded as a StateObj object -by the verifyStateParam() method. This value may be stored on the server-side with expiration. -The InstallProvider verifies if this value is set in the installer's browser session. - -#### Parameters - -• **installOptions**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) - -• **now**: `Date` - -#### Returns - -`Promise`\<`string`\> - -#### Implementation of - -[`StateStore`](../interfaces/StateStore.md).[`generateStateParam`](../interfaces/StateStore.md#generatestateparam) - -#### Defined in - -[packages/oauth/src/state-stores/file-state-store.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L34) - -*** - -### verifyStateParam() - -```ts -verifyStateParam(now, state): Promise -``` - -Verifies the given state string value by trying to decode the value and -build the passed InstallURLOptions object from the data. -This method verifies if the state value is not too old to detect replay attacks. -If the value is invalid, this method can throw InvalidStateError exception. - -#### Parameters - -• **now**: `Date` - -• **state**: `string` - -#### Returns - -`Promise`\<[`InstallURLOptions`](../interfaces/InstallURLOptions.md)\> - -#### Implementation of - -[`StateStore`](../interfaces/StateStore.md).[`verifyStateParam`](../interfaces/StateStore.md#verifystateparam) - -#### Defined in - -[packages/oauth/src/state-stores/file-state-store.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L48) diff --git a/docs/content/reference/oauth/classes/GenerateInstallUrlError.md b/docs/content/reference/oauth/classes/GenerateInstallUrlError.md deleted file mode 100644 index dd635be81..000000000 --- a/docs/content/reference/oauth/classes/GenerateInstallUrlError.md +++ /dev/null @@ -1,109 +0,0 @@ -# Class: GenerateInstallUrlError - -## Extends - -- `Error` - -## Implements - -- [`CodedError`](../interfaces/CodedError.md) - -## Constructors - -### new GenerateInstallUrlError() - -```ts -new GenerateInstallUrlError(message?): GenerateInstallUrlError -``` - -#### Parameters - -• **message?**: `string` - -#### Returns - -[`GenerateInstallUrlError`](GenerateInstallUrlError.md) - -#### Inherited from - -`Error.constructor` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 - -## Properties - -### code - -```ts -code: ErrorCode = ErrorCode.GenerateInstallUrlError; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) - -#### Defined in - -[packages/oauth/src/errors.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L23) - -*** - -### message - -```ts -message: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) - -#### Inherited from - -`Error.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) - -#### Inherited from - -`Error.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) - -#### Inherited from - -`Error.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/InstallProvider.md b/docs/content/reference/oauth/classes/InstallProvider.md deleted file mode 100644 index 82e2aca4a..000000000 --- a/docs/content/reference/oauth/classes/InstallProvider.md +++ /dev/null @@ -1,169 +0,0 @@ -# Class: InstallProvider - -InstallProvider Class. Refer to InsallProviderOptions interface for the details of constructor arguments. - -## Constructors - -### new InstallProvider() - -```ts -new InstallProvider(__namedParameters): InstallProvider -``` - -#### Parameters - -• **\_\_namedParameters**: [`InstallProviderOptions`](../interfaces/InstallProviderOptions.md) - -#### Returns - -[`InstallProvider`](InstallProvider.md) - -#### Defined in - -[packages/oauth/src/install-provider.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L87) - -## Properties - -### installationStore - -```ts -installationStore: InstallationStore; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L38) - -*** - -### stateStore? - -```ts -optional stateStore: StateStore; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L35) - -## Methods - -### authorize() - -```ts -authorize(source): Promise -``` - -Fetches data from the installationStore - -#### Parameters - -• **source**: [`InstallationQuery`](../interfaces/InstallationQuery.md)\<`boolean`\> - -#### Returns - -`Promise`\<[`AuthorizeResult`](../interfaces/AuthorizeResult.md)\> - -#### Defined in - -[packages/oauth/src/install-provider.ts:173](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L173) - -*** - -### generateInstallUrl() - -```ts -generateInstallUrl( - options, - stateVerification, -state?): Promise -``` - -Returns a URL that is suitable for including in an Add to Slack button -Uses stateStore to generate a value for the state query param. - -#### Parameters - -• **options**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) - -• **stateVerification**: `boolean` = `true` - -• **state?**: `string` - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[packages/oauth/src/install-provider.ts:408](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L408) - -*** - -### handleCallback() - -```ts -handleCallback( - req, - res, - options?, -installOptions?): Promise -``` - -This method handles the incoming request to the callback URL. -It can be used as a RequestListener in almost any HTTP server -framework. - -Verifies the state using the stateStore, exchanges the grant in the -query params for an access token, and stores token and associated data -in the installationStore. - -#### Parameters - -• **req**: `IncomingMessage` - -• **res**: `ServerResponse` - -• **options?**: [`CallbackOptions`](../interfaces/CallbackOptions.md) - -• **installOptions?**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/oauth/src/install-provider.ts:478](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L478) - -*** - -### handleInstallPath() - -```ts -handleInstallPath( - req, - res, - options?, -installOptions?): Promise -``` - -Handles the install path (the default is /slack/install) requests from an app installer. - -#### Parameters - -• **req**: `IncomingMessage` - -• **res**: `ServerResponse` - -• **options?**: [`InstallPathOptions`](../interfaces/InstallPathOptions.md) - -• **installOptions?**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/oauth/src/install-provider.ts:324](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L324) diff --git a/docs/content/reference/oauth/classes/InstallerInitializationError.md b/docs/content/reference/oauth/classes/InstallerInitializationError.md deleted file mode 100644 index 807b8df0e..000000000 --- a/docs/content/reference/oauth/classes/InstallerInitializationError.md +++ /dev/null @@ -1,109 +0,0 @@ -# Class: InstallerInitializationError - -## Extends - -- `Error` - -## Implements - -- [`CodedError`](../interfaces/CodedError.md) - -## Constructors - -### new InstallerInitializationError() - -```ts -new InstallerInitializationError(message?): InstallerInitializationError -``` - -#### Parameters - -• **message?**: `string` - -#### Returns - -[`InstallerInitializationError`](InstallerInitializationError.md) - -#### Inherited from - -`Error.constructor` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 - -## Properties - -### code - -```ts -code: ErrorCode = ErrorCode.InstallerInitializationError; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) - -#### Defined in - -[packages/oauth/src/errors.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L19) - -*** - -### message - -```ts -message: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) - -#### Inherited from - -`Error.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) - -#### Inherited from - -`Error.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) - -#### Inherited from - -`Error.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/InvalidStateError.md b/docs/content/reference/oauth/classes/InvalidStateError.md deleted file mode 100644 index b500bdccc..000000000 --- a/docs/content/reference/oauth/classes/InvalidStateError.md +++ /dev/null @@ -1,109 +0,0 @@ -# Class: InvalidStateError - -## Extends - -- `Error` - -## Implements - -- [`CodedError`](../interfaces/CodedError.md) - -## Constructors - -### new InvalidStateError() - -```ts -new InvalidStateError(message?): InvalidStateError -``` - -#### Parameters - -• **message?**: `string` - -#### Returns - -[`InvalidStateError`](InvalidStateError.md) - -#### Inherited from - -`Error.constructor` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 - -## Properties - -### code - -```ts -code: ErrorCode = ErrorCode.InvalidStateError; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) - -#### Defined in - -[packages/oauth/src/errors.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L29) - -*** - -### message - -```ts -message: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) - -#### Inherited from - -`Error.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) - -#### Inherited from - -`Error.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) - -#### Inherited from - -`Error.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/MemoryInstallationStore.md b/docs/content/reference/oauth/classes/MemoryInstallationStore.md deleted file mode 100644 index 0c62aed68..000000000 --- a/docs/content/reference/oauth/classes/MemoryInstallationStore.md +++ /dev/null @@ -1,107 +0,0 @@ -# Class: MemoryInstallationStore - -## Implements - -- [`InstallationStore`](../interfaces/InstallationStore.md) - -## Constructors - -### new MemoryInstallationStore() - -```ts -new MemoryInstallationStore(): MemoryInstallationStore -``` - -#### Returns - -[`MemoryInstallationStore`](MemoryInstallationStore.md) - -## Properties - -### devDB - -```ts -devDB: DevDatabase = {}; -``` - -#### Defined in - -[packages/oauth/src/installation-stores/memory-store.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/memory-store.ts#L12) - -## Methods - -### deleteInstallation() - -```ts -deleteInstallation(query, logger?): Promise -``` - -#### Parameters - -• **query**: [`InstallationQuery`](../interfaces/InstallationQuery.md)\<`boolean`\> - -• **logger?**: `any` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`InstallationStore`](../interfaces/InstallationStore.md).[`deleteInstallation`](../interfaces/InstallationStore.md#deleteinstallation) - -#### Defined in - -[packages/oauth/src/installation-stores/memory-store.ts:59](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/memory-store.ts#L59) - -*** - -### fetchInstallation() - -```ts -fetchInstallation(query, logger?): Promise> -``` - -#### Parameters - -• **query**: [`InstallationQuery`](../interfaces/InstallationQuery.md)\<`boolean`\> - -• **logger?**: `any` - -#### Returns - -`Promise`\<[`Installation`](../interfaces/Installation.md)\<`"v1"` \| `"v2"`, `boolean`\>\> - -#### Implementation of - -[`InstallationStore`](../interfaces/InstallationStore.md).[`fetchInstallation`](../interfaces/InstallationStore.md#fetchinstallation) - -#### Defined in - -[packages/oauth/src/installation-stores/memory-store.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/memory-store.ts#L38) - -*** - -### storeInstallation() - -```ts -storeInstallation(installation, logger?): Promise -``` - -#### Parameters - -• **installation**: [`Installation`](../interfaces/Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> - -• **logger?**: `any` - -#### Returns - -`Promise`\<`void`\> - -#### Implementation of - -[`InstallationStore`](../interfaces/InstallationStore.md).[`storeInstallation`](../interfaces/InstallationStore.md#storeinstallation) - -#### Defined in - -[packages/oauth/src/installation-stores/memory-store.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/memory-store.ts#L14) diff --git a/docs/content/reference/oauth/classes/MissingCodeError.md b/docs/content/reference/oauth/classes/MissingCodeError.md deleted file mode 100644 index 62db97341..000000000 --- a/docs/content/reference/oauth/classes/MissingCodeError.md +++ /dev/null @@ -1,109 +0,0 @@ -# Class: MissingCodeError - -## Extends - -- `Error` - -## Implements - -- [`CodedError`](../interfaces/CodedError.md) - -## Constructors - -### new MissingCodeError() - -```ts -new MissingCodeError(message?): MissingCodeError -``` - -#### Parameters - -• **message?**: `string` - -#### Returns - -[`MissingCodeError`](MissingCodeError.md) - -#### Inherited from - -`Error.constructor` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 - -## Properties - -### code - -```ts -code: ErrorCode = ErrorCode.MissingCodeError; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) - -#### Defined in - -[packages/oauth/src/errors.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L33) - -*** - -### message - -```ts -message: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) - -#### Inherited from - -`Error.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) - -#### Inherited from - -`Error.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) - -#### Inherited from - -`Error.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/MissingStateError.md b/docs/content/reference/oauth/classes/MissingStateError.md deleted file mode 100644 index cd31665b0..000000000 --- a/docs/content/reference/oauth/classes/MissingStateError.md +++ /dev/null @@ -1,109 +0,0 @@ -# Class: MissingStateError - -## Extends - -- `Error` - -## Implements - -- [`CodedError`](../interfaces/CodedError.md) - -## Constructors - -### new MissingStateError() - -```ts -new MissingStateError(message?): MissingStateError -``` - -#### Parameters - -• **message?**: `string` - -#### Returns - -[`MissingStateError`](MissingStateError.md) - -#### Inherited from - -`Error.constructor` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 - -## Properties - -### code - -```ts -code: ErrorCode = ErrorCode.MissingStateError; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) - -#### Defined in - -[packages/oauth/src/errors.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L26) - -*** - -### message - -```ts -message: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) - -#### Inherited from - -`Error.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) - -#### Inherited from - -`Error.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) - -#### Inherited from - -`Error.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/classes/UnknownError.md b/docs/content/reference/oauth/classes/UnknownError.md deleted file mode 100644 index 5f4713005..000000000 --- a/docs/content/reference/oauth/classes/UnknownError.md +++ /dev/null @@ -1,109 +0,0 @@ -# Class: UnknownError - -## Extends - -- `Error` - -## Implements - -- [`CodedError`](../interfaces/CodedError.md) - -## Constructors - -### new UnknownError() - -```ts -new UnknownError(message?): UnknownError -``` - -#### Parameters - -• **message?**: `string` - -#### Returns - -[`UnknownError`](UnknownError.md) - -#### Inherited from - -`Error.constructor` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1082 - -## Properties - -### code - -```ts -code: ErrorCode = ErrorCode.UnknownError; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) - -#### Defined in - -[packages/oauth/src/errors.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L37) - -*** - -### message - -```ts -message: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`message`](../interfaces/CodedError.md#message) - -#### Inherited from - -`Error.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`name`](../interfaces/CodedError.md#name) - -#### Inherited from - -`Error.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Implementation of - -[`CodedError`](../interfaces/CodedError.md).[`stack`](../interfaces/CodedError.md#stack) - -#### Inherited from - -`Error.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/enumerations/ErrorCode.md b/docs/content/reference/oauth/enumerations/ErrorCode.md deleted file mode 100644 index 8d311035c..000000000 --- a/docs/content/reference/oauth/enumerations/ErrorCode.md +++ /dev/null @@ -1,87 +0,0 @@ -# Enumeration: ErrorCode - -A dictionary of codes for errors produced by this package. - -## Enumeration Members - -### AuthorizationError - -```ts -AuthorizationError: "slack_oauth_installer_authorization_error"; -``` - -#### Defined in - -[packages/oauth/src/errors.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L10) - -*** - -### GenerateInstallUrlError - -```ts -GenerateInstallUrlError: "slack_oauth_generate_url_error"; -``` - -#### Defined in - -[packages/oauth/src/errors.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L11) - -*** - -### InstallerInitializationError - -```ts -InstallerInitializationError: "slack_oauth_installer_initialization_error"; -``` - -#### Defined in - -[packages/oauth/src/errors.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L9) - -*** - -### InvalidStateError - -```ts -InvalidStateError: "slack_oauth_invalid_state"; -``` - -#### Defined in - -[packages/oauth/src/errors.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L13) - -*** - -### MissingCodeError - -```ts -MissingCodeError: "slack_oauth_missing_code"; -``` - -#### Defined in - -[packages/oauth/src/errors.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L14) - -*** - -### MissingStateError - -```ts -MissingStateError: "slack_oauth_missing_state"; -``` - -#### Defined in - -[packages/oauth/src/errors.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L12) - -*** - -### UnknownError - -```ts -UnknownError: "slack_oauth_unknown_error"; -``` - -#### Defined in - -[packages/oauth/src/errors.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L15) diff --git a/docs/content/reference/oauth/functions/defaultCallbackFailure.md b/docs/content/reference/oauth/functions/defaultCallbackFailure.md deleted file mode 100644 index 4e5c155cd..000000000 --- a/docs/content/reference/oauth/functions/defaultCallbackFailure.md +++ /dev/null @@ -1,27 +0,0 @@ -# Function: defaultCallbackFailure() - -```ts -function defaultCallbackFailure( - error, - _options, - _req, - res): void -``` - -## Parameters - -• **error**: [`CodedError`](../interfaces/CodedError.md) - -• **\_options**: [`InstallURLOptions`](../interfaces/InstallURLOptions.md) - -• **\_req**: `IncomingMessage` - -• **res**: `ServerResponse` - -## Returns - -`void` - -## Defined in - -[packages/oauth/src/callback-options.ts:128](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L128) diff --git a/docs/content/reference/oauth/functions/defaultCallbackSuccess.md b/docs/content/reference/oauth/functions/defaultCallbackSuccess.md deleted file mode 100644 index 7b2d8c651..000000000 --- a/docs/content/reference/oauth/functions/defaultCallbackSuccess.md +++ /dev/null @@ -1,27 +0,0 @@ -# Function: defaultCallbackSuccess() - -```ts -function defaultCallbackSuccess( - installation, - _options, - _req, - res): void -``` - -## Parameters - -• **installation**: [`Installation`](../interfaces/Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> - -• **\_options**: `undefined` \| [`InstallURLOptions`](../interfaces/InstallURLOptions.md) - -• **\_req**: `IncomingMessage` - -• **res**: `ServerResponse` - -## Returns - -`void` - -## Defined in - -[packages/oauth/src/callback-options.ts:82](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L82) diff --git a/docs/content/reference/oauth/functions/defaultRenderHtmlForInstallPath.md b/docs/content/reference/oauth/functions/defaultRenderHtmlForInstallPath.md deleted file mode 100644 index fafe8097f..000000000 --- a/docs/content/reference/oauth/functions/defaultRenderHtmlForInstallPath.md +++ /dev/null @@ -1,17 +0,0 @@ -# Function: defaultRenderHtmlForInstallPath() - -```ts -function defaultRenderHtmlForInstallPath(addToSlackUrl): string -``` - -## Parameters - -• **addToSlackUrl**: `string` - -## Returns - -`string` - -## Defined in - -[packages/oauth/src/default-render-html-for-install-path.ts:1](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/default-render-html-for-install-path.ts#L1) diff --git a/docs/content/reference/oauth/index.md b/docs/content/reference/oauth/index.md deleted file mode 100644 index e73b1f689..000000000 --- a/docs/content/reference/oauth/index.md +++ /dev/null @@ -1,58 +0,0 @@ -# @slack/oauth - -## References - -### LogLevel - -Renames and re-exports [Logger](variables/Logger.md) - -## Enumerations - -- [ErrorCode](enumerations/ErrorCode.md) - -## Classes - -- [AuthorizationError](classes/AuthorizationError.md) -- [ClearStateStore](classes/ClearStateStore.md) -- [FileInstallationStore](classes/FileInstallationStore.md) -- [FileStateStore](classes/FileStateStore.md) -- [GenerateInstallUrlError](classes/GenerateInstallUrlError.md) -- [InstallProvider](classes/InstallProvider.md) -- [InstallerInitializationError](classes/InstallerInitializationError.md) -- [InvalidStateError](classes/InvalidStateError.md) -- [MemoryInstallationStore](classes/MemoryInstallationStore.md) -- [MissingCodeError](classes/MissingCodeError.md) -- [MissingStateError](classes/MissingStateError.md) -- [UnknownError](classes/UnknownError.md) - -## Interfaces - -- [AuthorizeResult](interfaces/AuthorizeResult.md) -- [CallbackOptions](interfaces/CallbackOptions.md) -- [CodedError](interfaces/CodedError.md) -- [FileStateStoreArgs](interfaces/FileStateStoreArgs.md) -- [InstallPathOptions](interfaces/InstallPathOptions.md) -- [InstallProviderOptions](interfaces/InstallProviderOptions.md) -- [InstallURLOptions](interfaces/InstallURLOptions.md) -- [Installation](interfaces/Installation.md) -- [InstallationQuery](interfaces/InstallationQuery.md) -- [InstallationStore](interfaces/InstallationStore.md) -- [OAuthV2Response](interfaces/OAuthV2Response.md) -- [OAuthV2TokenRefreshResponse](interfaces/OAuthV2TokenRefreshResponse.md) -- [StateObj](interfaces/StateObj.md) -- [StateStore](interfaces/StateStore.md) - -## Type Aliases - -- [OrgInstallation](type-aliases/OrgInstallation.md) -- [OrgInstallationQuery](type-aliases/OrgInstallationQuery.md) - -## Variables - -- [Logger](variables/Logger.md) - -## Functions - -- [defaultCallbackFailure](functions/defaultCallbackFailure.md) -- [defaultCallbackSuccess](functions/defaultCallbackSuccess.md) -- [defaultRenderHtmlForInstallPath](functions/defaultRenderHtmlForInstallPath.md) diff --git a/docs/content/reference/oauth/interfaces/AuthorizeResult.md b/docs/content/reference/oauth/interfaces/AuthorizeResult.md deleted file mode 100644 index 0b3c2be29..000000000 --- a/docs/content/reference/oauth/interfaces/AuthorizeResult.md +++ /dev/null @@ -1,121 +0,0 @@ -# Interface: AuthorizeResult - -## Properties - -### botId? - -```ts -optional botId: string; -``` - -#### Defined in - -[packages/oauth/src/authorize-result.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L11) - -*** - -### botRefreshToken? - -```ts -optional botRefreshToken: string; -``` - -#### Defined in - -[packages/oauth/src/authorize-result.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L6) - -*** - -### botToken? - -```ts -optional botToken: string; -``` - -#### Defined in - -[packages/oauth/src/authorize-result.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L5) - -*** - -### botTokenExpiresAt? - -```ts -optional botTokenExpiresAt: number; -``` - -#### Defined in - -[packages/oauth/src/authorize-result.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L7) - -*** - -### botUserId? - -```ts -optional botUserId: string; -``` - -#### Defined in - -[packages/oauth/src/authorize-result.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L12) - -*** - -### enterpriseId? - -```ts -optional enterpriseId: string; -``` - -#### Defined in - -[packages/oauth/src/authorize-result.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L14) - -*** - -### teamId? - -```ts -optional teamId: string; -``` - -#### Defined in - -[packages/oauth/src/authorize-result.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L13) - -*** - -### userRefreshToken? - -```ts -optional userRefreshToken: string; -``` - -#### Defined in - -[packages/oauth/src/authorize-result.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L9) - -*** - -### userToken? - -```ts -optional userToken: string; -``` - -#### Defined in - -[packages/oauth/src/authorize-result.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L8) - -*** - -### userTokenExpiresAt? - -```ts -optional userTokenExpiresAt: number; -``` - -#### Defined in - -[packages/oauth/src/authorize-result.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/authorize-result.ts#L10) diff --git a/docs/content/reference/oauth/interfaces/CallbackOptions.md b/docs/content/reference/oauth/interfaces/CallbackOptions.md deleted file mode 100644 index 24347058a..000000000 --- a/docs/content/reference/oauth/interfaces/CallbackOptions.md +++ /dev/null @@ -1,172 +0,0 @@ -# Interface: CallbackOptions - -## Properties - -### afterInstallation()? - -```ts -optional afterInstallation: (installation, options, callbackReq, callbackRes) => Promise; -``` - -An additional logic to run right after executing the Slack app installation with the given OAuth code parameter. - -When this method returns false, the InstallProvider skips storing the installation in database. -You can set false when your app needs to cancel the installation (you can call auth.revoke API method for it) -and then, the app needs to display an error page to the installing user. - -Also, when returning false, this method is responsible to call callbackRes#end() method -to build complete HTTP response for end-users. - -#### Parameters - -• **installation**: [`Installation`](Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> \| [`OrgInstallation`](../type-aliases/OrgInstallation.md) - -• **options**: [`InstallURLOptions`](InstallURLOptions.md) - -• **callbackReq**: `IncomingMessage` - -• **callbackRes**: `ServerResponse` - -#### Returns - -`Promise`\<`boolean`\> - -#### Defined in - -[packages/oauth/src/callback-options.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L34) - -*** - -### beforeInstallation()? - -```ts -optional beforeInstallation: (options, callbackReq, callbackRes) => Promise; -``` - -An additional logic to run right before executing the Slack app installation with the given OAuth code parameter. - -When this method returns false, the InstallProvider skips the installation. -You can set false when the visiting user is not eligible to proceed with the Slack app installation flow. - -Also, when returning false, this method is responsible for calling the callbackRes#end() method -to build a complete HTTP response for end-users. - -#### Parameters - -• **options**: [`InstallURLOptions`](InstallURLOptions.md) - -• **callbackReq**: `IncomingMessage` - -• **callbackRes**: `ServerResponse` - -#### Returns - -`Promise`\<`boolean`\> - -#### Defined in - -[packages/oauth/src/callback-options.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L18) - -*** - -### failure()? - -```ts -optional failure: (error, options, callbackReq, callbackRes) => void; -``` - -#### Parameters - -• **error**: [`CodedError`](CodedError.md) - -• **options**: [`InstallURLOptions`](InstallURLOptions.md) - -• **callbackReq**: `IncomingMessage` - -• **callbackRes**: `ServerResponse` - -#### Returns - -`void` - -#### Defined in - -[packages/oauth/src/callback-options.ts:64](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L64) - -*** - -### failureAsync()? - -```ts -optional failureAsync: (error, options, callbackReq, callbackRes) => Promise; -``` - -#### Parameters - -• **error**: [`CodedError`](CodedError.md) - -• **options**: [`InstallURLOptions`](InstallURLOptions.md) - -• **callbackReq**: `IncomingMessage` - -• **callbackRes**: `ServerResponse` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/oauth/src/callback-options.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L73) - -*** - -### success()? - -```ts -optional success: (installation, options, callbackReq, callbackRes) => void; -``` - -#### Parameters - -• **installation**: [`Installation`](Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> \| [`OrgInstallation`](../type-aliases/OrgInstallation.md) - -• **options**: [`InstallURLOptions`](InstallURLOptions.md) - -• **callbackReq**: `IncomingMessage` - -• **callbackRes**: `ServerResponse` - -#### Returns - -`void` - -#### Defined in - -[packages/oauth/src/callback-options.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L44) - -*** - -### successAsync()? - -```ts -optional successAsync: (installation, options, callbackReq, callbackRes) => Promise; -``` - -#### Parameters - -• **installation**: [`Installation`](Installation.md)\<`"v1"` \| `"v2"`, `boolean`\> \| [`OrgInstallation`](../type-aliases/OrgInstallation.md) - -• **options**: [`InstallURLOptions`](InstallURLOptions.md) - -• **callbackReq**: `IncomingMessage` - -• **callbackRes**: `ServerResponse` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/oauth/src/callback-options.ts:53](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L53) diff --git a/docs/content/reference/oauth/interfaces/CodedError.md b/docs/content/reference/oauth/interfaces/CodedError.md deleted file mode 100644 index 6925db6b3..000000000 --- a/docs/content/reference/oauth/interfaces/CodedError.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: CodedError - -## Extends - -- `Error` - -## Properties - -### code - -```ts -code: string; -``` - -#### Defined in - -[packages/oauth/src/errors.ts:2](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/errors.ts#L2) - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -`Error.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -`Error.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -`Error.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/oauth/interfaces/FileStateStoreArgs.md b/docs/content/reference/oauth/interfaces/FileStateStoreArgs.md deleted file mode 100644 index 181ddc4a4..000000000 --- a/docs/content/reference/oauth/interfaces/FileStateStoreArgs.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: FileStateStoreArgs - -## Properties - -### baseDir? - -```ts -optional baseDir: string; -``` - -#### Defined in - -[packages/oauth/src/state-stores/file-state-store.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L13) - -*** - -### logger? - -```ts -optional logger: any; -``` - -#### Defined in - -[packages/oauth/src/state-stores/file-state-store.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L14) - -*** - -### stateExpirationSeconds? - -```ts -optional stateExpirationSeconds: number; -``` - -#### Defined in - -[packages/oauth/src/state-stores/file-state-store.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/file-state-store.ts#L12) diff --git a/docs/content/reference/oauth/interfaces/InstallPathOptions.md b/docs/content/reference/oauth/interfaces/InstallPathOptions.md deleted file mode 100644 index d9e5b8959..000000000 --- a/docs/content/reference/oauth/interfaces/InstallPathOptions.md +++ /dev/null @@ -1,38 +0,0 @@ -# Interface: InstallPathOptions - -Customizable callbacks that are supposed to be called -inside InstallProvider#handleInstallPath() method. - -## Properties - -### beforeRedirection()? - -```ts -optional beforeRedirection: (request, response, options?) => Promise; -``` - -Customize the response headers and body data for -additional user-specific data handling such as acccount mapping and activity tracking. - -When this method returns false, the InstallProvider skips -the following operations including the redirection to Slack authorize URL. -You can set false when the visiting user is not eligible to proceed with the Slack app installation flow. - -Also, when returning false, this method is responsible for calling the response#end() method -to build a complete HTTP response for end-users. - -#### Parameters - -• **request**: `IncomingMessage` - -• **response**: `ServerResponse` - -• **options?**: [`InstallURLOptions`](InstallURLOptions.md) - -#### Returns - -`Promise`\<`boolean`\> - -#### Defined in - -[packages/oauth/src/install-path-options.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-path-options.ts#L22) diff --git a/docs/content/reference/oauth/interfaces/InstallProviderOptions.md b/docs/content/reference/oauth/interfaces/InstallProviderOptions.md deleted file mode 100644 index 81b5689b0..000000000 --- a/docs/content/reference/oauth/interfaces/InstallProviderOptions.md +++ /dev/null @@ -1,253 +0,0 @@ -# Interface: InstallProviderOptions - -## Properties - -### authVersion? - -```ts -optional authVersion: "v1" | "v2"; -``` - -The default is "v2" (a.k.a. Granular Bot Permissions), different from "v1" (a.k.a. "Classic Apps"). -More details here: -- https://medium.com/slack-developer-blog/more-precision-less-restrictions-a3550006f9c3 -- https://api.slack.com/authentication/migration - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:79](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L79) - -*** - -### authorizationUrl? - -```ts -optional authorizationUrl: string; -``` - -The slack.com authorize URL - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L28) - -*** - -### clientId - -```ts -clientId: string; -``` - -Client ID, which can be found under the Basic Information section of your application on https://api.slack.com/apps - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L13) - -*** - -### clientOptions? - -```ts -optional clientOptions: Omit; -``` - -The customization options for WebClient - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L99) - -*** - -### clientSecret - -```ts -clientSecret: string; -``` - -Client Secret, which can be found under the Basic Information section of your application on https://api.slack.com/apps - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L18) - -*** - -### directInstall? - -```ts -optional directInstall: boolean; -``` - -The install path web page rendering will be skipped if true (default: false) - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:71](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L71) - -*** - -### installUrlOptions? - -```ts -optional installUrlOptions: InstallURLOptions; -``` - -The initialization options for the OAuth flow - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L84) - -*** - -### installationStore? - -```ts -optional installationStore: InstallationStore; -``` - -Manages installation data, which can be called by both the OAuth flow and authorize() in event handling - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L23) - -*** - -### legacyStateVerification? - -```ts -optional legacyStateVerification: boolean; -``` - -handleCallback() skips checking browser cookies if true (default: false) -Enabling this option is not recommended. -This is supposed to be used only for backward-compatibility with v2.4 and olders. - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L51) - -*** - -### logLevel? - -```ts -optional logLevel: any; -``` - -@slack/logger logging level used in this class - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:94](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L94) - -*** - -### logger? - -```ts -optional logger: any; -``` - -@slack/logger logging used in this class - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:89](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L89) - -*** - -### renderHtmlForInstallPath()? - -```ts -optional renderHtmlForInstallPath: (url) => string; -``` - -The function for rendering the web page for the install path URL - -#### Parameters - -• **url**: `string` - -#### Returns - -`string` - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:66](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L66) - -*** - -### stateCookieExpirationSeconds? - -```ts -optional stateCookieExpirationSeconds: number; -``` - -The expiration time in seconds for the state parameter value stored via cookies - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L61) - -*** - -### stateCookieName? - -```ts -optional stateCookieName: string; -``` - -The cookie name used for setting state parameter value in cookies - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:56](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L56) - -*** - -### stateSecret? - -```ts -optional stateSecret: string; -``` - -The secret value used for generating the state parameter value - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L39) - -*** - -### stateStore? - -```ts -optional stateStore: StateStore; -``` - -Stores state issued to authorization server -and verifies the value returned at redirection during OAuth flow to prevent CSRF - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L34) - -*** - -### stateVerification? - -```ts -optional stateVerification: boolean; -``` - -handleCallback() verifies the state parameter if true (default: true) - -#### Defined in - -[packages/oauth/src/install-provider-options.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts#L44) diff --git a/docs/content/reference/oauth/interfaces/InstallURLOptions.md b/docs/content/reference/oauth/interfaces/InstallURLOptions.md deleted file mode 100644 index 0a6cb1838..000000000 --- a/docs/content/reference/oauth/interfaces/InstallURLOptions.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: InstallURLOptions - -## Properties - -### metadata? - -```ts -optional metadata: string; -``` - -#### Defined in - -[packages/oauth/src/install-url-options.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-url-options.ts#L6) - -*** - -### redirectUri? - -```ts -optional redirectUri: string; -``` - -#### Defined in - -[packages/oauth/src/install-url-options.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-url-options.ts#L4) - -*** - -### scopes - -```ts -scopes: string | string[]; -``` - -#### Defined in - -[packages/oauth/src/install-url-options.ts:2](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-url-options.ts#L2) - -*** - -### teamId? - -```ts -optional teamId: string; -``` - -#### Defined in - -[packages/oauth/src/install-url-options.ts:3](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-url-options.ts#L3) - -*** - -### userScopes? - -```ts -optional userScopes: string | string[]; -``` - -#### Defined in - -[packages/oauth/src/install-url-options.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-url-options.ts#L5) diff --git a/docs/content/reference/oauth/interfaces/Installation.md b/docs/content/reference/oauth/interfaces/Installation.md deleted file mode 100644 index bc6c69d95..000000000 --- a/docs/content/reference/oauth/interfaces/Installation.md +++ /dev/null @@ -1,283 +0,0 @@ -# Interface: Installation\ - -An individual installation of the Slack app. - -This interface creates a representation for installations that normalizes the responses from OAuth grant exchanges -across auth versions (responses from the Web API methods `oauth.v2.access` and `oauth.access`). It describes some of -these differences using the `AuthVersion` generic placeholder type. - -This interface also represents both installations which occur on individual Slack workspaces and on Slack enterprise -organizations. The `IsEnterpriseInstall` generic placeholder type is used to describe some of those differences. - -This representation is designed to be used both when producing data that should be stored by an InstallationStore, -and when consuming data that is fetched from an InstallationStore. Most often, InstallationStore implementations -are a database. If you are going to implement an InstallationStore, it's advised that you **store as much of the -data in these objects as possible so that you can return as much as possible inside `fetchInstallation()`**. - -A few properties are synthesized with a default value if they are not present when returned from -`fetchInstallation()`. These properties are optional in the interface so that stored installations from previous -versions of this library (from before those properties were introduced) continue to work without requiring a breaking -change. However the synthesized default values are not always perfect and are based on some assumptions, so this is -why it's recommended to store as much of that data as possible in any InstallationStore. - -Some of the properties (e.g. `team.name`) can change between when the installation occurred and when it is fetched -from the InstallationStore. This can be seen as a reason not to store those properties. In most workspaces these -properties rarely change, and for most Slack apps having a slightly out of date value has no impact. However if your -app uses these values in a way where it must be up to date, it's recommended to implement a caching strategy in the -InstallationStore to fetch the latest data from the Web API (using methods such as `auth.test`, `teams.info`, etc.) -as often as it makes sense for your Slack app. - -TODO: IsEnterpriseInstall is always false when AuthVersion is v1 - -## Type Parameters - -• **AuthVersion** *extends* `"v1"` \| `"v2"` = `"v1"` \| `"v2"` - -• **IsEnterpriseInstall** *extends* `boolean` = `boolean` - -## Properties - -### appId? - -```ts -optional appId: AuthVersion extends "v2" ? string : undefined; -``` - -The App ID, which does not vary per installation. Left as undefined when not returned from fetch. - -#### Defined in - -[packages/oauth/src/installation.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L76) - -*** - -### authVersion? - -```ts -optional authVersion: AuthVersion; -``` - -The version of Slack's auth flow that produced this installation. Synthesized as `v2` when not present. - -#### Defined in - -[packages/oauth/src/installation.ts:91](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L91) - -*** - -### bot? - -```ts -optional bot: object; -``` - -#### expiresAt? - -```ts -optional expiresAt: number; -``` - -#### id - -```ts -id: string; -``` - -#### refreshToken? - -```ts -optional refreshToken: string; -``` - -#### scopes - -```ts -scopes: string[]; -``` - -#### token - -```ts -token: string; -``` - -#### userId - -```ts -userId: string; -``` - -#### Defined in - -[packages/oauth/src/installation.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L57) - -*** - -### enterprise - -```ts -enterprise: IsEnterpriseInstall extends true ? EnterpriseInfo : undefined | EnterpriseInfo; -``` - -When the installation is an enterprise install or when the installation occurs on the org to acquire `admin` scope, -the name and ID of the enterprise org. - -#### Defined in - -[packages/oauth/src/installation.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L47) - -*** - -### enterpriseUrl? - -```ts -optional enterpriseUrl: AuthVersion extends "v2" ? string : undefined; -``` - -When the installation is an enterprise org install, the URL of the landing page for all workspaces in the org. -Left as undefined when not returned from fetch. - -#### Defined in - -[packages/oauth/src/installation.ts:85](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L85) - -*** - -### incomingWebhook? - -```ts -optional incomingWebhook: object; -``` - -#### channel? - -```ts -optional channel: string; -``` - -Left as undefined when not returned from fetch. - -#### channelId? - -```ts -optional channelId: string; -``` - -Left as undefined when not returned from fetch. - -#### configurationUrl? - -```ts -optional configurationUrl: string; -``` - -Left as undefined when not returned from fetch. - -#### url - -```ts -url: string; -``` - -#### Defined in - -[packages/oauth/src/installation.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L65) - -*** - -### isEnterpriseInstall? - -```ts -optional isEnterpriseInstall: IsEnterpriseInstall; -``` - -Whether the installation was performed on an enterprise org. Synthesized as `false` when not present. - -#### Defined in - -[packages/oauth/src/installation.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L88) - -*** - -### metadata? - -```ts -optional metadata: string; -``` - -A string value that can be held in the state parameter in the OAuth flow. - -#### Defined in - -[packages/oauth/src/installation.ts:94](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L94) - -*** - -### team - -```ts -team: IsEnterpriseInstall extends true ? undefined : object; -``` - -TODO: when performing a “single workspace” install with the admin scope on the enterprise, -is the team property returned from oauth.access? - -#### Defined in - -[packages/oauth/src/installation.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L37) - -*** - -### tokenType? - -```ts -optional tokenType: "bot"; -``` - -When the installation contains a bot user, the token type. Left as undefined when not returned from fetch. - -#### Defined in - -[packages/oauth/src/installation.ts:79](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L79) - -*** - -### user - -```ts -user: object; -``` - -#### expiresAt? - -```ts -optional expiresAt: AuthVersion extends "v1" ? never : undefined | number; -``` - -#### id - -```ts -id: string; -``` - -#### refreshToken? - -```ts -optional refreshToken: AuthVersion extends "v1" ? never : undefined | string; -``` - -#### scopes - -```ts -scopes: AuthVersion extends "v1" ? string[] : undefined | string[]; -``` - -#### token - -```ts -token: AuthVersion extends "v1" ? string : undefined | string; -``` - -#### Defined in - -[packages/oauth/src/installation.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L49) diff --git a/docs/content/reference/oauth/interfaces/InstallationQuery.md b/docs/content/reference/oauth/interfaces/InstallationQuery.md deleted file mode 100644 index 9db8d8fd7..000000000 --- a/docs/content/reference/oauth/interfaces/InstallationQuery.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: InstallationQuery\ - -## Type Parameters - -• **isEnterpriseInstall** *extends* `boolean` - -## Properties - -### conversationId? - -```ts -optional conversationId: string; -``` - -#### Defined in - -[packages/oauth/src/installation-query.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L8) - -*** - -### enterpriseId - -```ts -enterpriseId: isEnterpriseInstall extends true ? string : undefined | string; -``` - -#### Defined in - -[packages/oauth/src/installation-query.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L6) - -*** - -### isEnterpriseInstall - -```ts -isEnterpriseInstall: isEnterpriseInstall; -``` - -#### Defined in - -[packages/oauth/src/installation-query.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L4) - -*** - -### teamId - -```ts -teamId: isEnterpriseInstall extends false ? string : undefined; -``` - -#### Defined in - -[packages/oauth/src/installation-query.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L5) - -*** - -### userId? - -```ts -optional userId: string; -``` - -#### Defined in - -[packages/oauth/src/installation-query.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L7) diff --git a/docs/content/reference/oauth/interfaces/InstallationStore.md b/docs/content/reference/oauth/interfaces/InstallationStore.md deleted file mode 100644 index 901aab173..000000000 --- a/docs/content/reference/oauth/interfaces/InstallationStore.md +++ /dev/null @@ -1,71 +0,0 @@ -# Interface: InstallationStore - -## Properties - -### deleteInstallation()? - -```ts -optional deleteInstallation: (query, logger?) => Promise; -``` - -#### Parameters - -• **query**: [`InstallationQuery`](InstallationQuery.md)\<`boolean`\> - -• **logger?**: `any` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/oauth/src/installation-stores/interface.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/interface.ts#L14) - -*** - -### fetchInstallation() - -```ts -fetchInstallation: (query, logger?) => Promise>; -``` - -#### Parameters - -• **query**: [`InstallationQuery`](InstallationQuery.md)\<`boolean`\> - -• **logger?**: `any` - -#### Returns - -`Promise`\<[`Installation`](Installation.md)\<`"v1"` \| `"v2"`, `boolean`\>\> - -#### Defined in - -[packages/oauth/src/installation-stores/interface.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/interface.ts#L11) - -## Methods - -### storeInstallation() - -```ts -storeInstallation(installation, logger?): Promise -``` - -#### Type Parameters - -• **AuthVersion** *extends* `"v1"` \| `"v2"` - -#### Parameters - -• **installation**: [`Installation`](Installation.md)\<`AuthVersion`, `boolean`\> - -• **logger?**: `any` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/oauth/src/installation-stores/interface.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/interface.ts#L7) diff --git a/docs/content/reference/oauth/interfaces/OAuthV2Response.md b/docs/content/reference/oauth/interfaces/OAuthV2Response.md deleted file mode 100644 index 7cfa2cc81..000000000 --- a/docs/content/reference/oauth/interfaces/OAuthV2Response.md +++ /dev/null @@ -1,209 +0,0 @@ -# Interface: OAuthV2Response - -## Extends - -- [`Logger`](../variables/Logger.md) - -## Properties - -### access\_token? - -```ts -optional access_token: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:769](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L769) - -*** - -### app\_id - -```ts -app_id: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:758](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L758) - -*** - -### authed\_user - -```ts -authed_user: object; -``` - -#### access\_token? - -```ts -optional access_token: string; -``` - -#### expires\_in? - -```ts -optional expires_in: number; -``` - -#### id - -```ts -id: string; -``` - -#### refresh\_token? - -```ts -optional refresh_token: string; -``` - -#### scope? - -```ts -optional scope: string; -``` - -#### token\_type? - -```ts -optional token_type: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:759](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L759) - -*** - -### bot\_user\_id? - -```ts -optional bot_user_id: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:772](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L772) - -*** - -### enterprise - -```ts -enterprise: null | object; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:774](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L774) - -*** - -### expires\_in? - -```ts -optional expires_in: number; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:771](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L771) - -*** - -### incoming\_webhook? - -```ts -optional incoming_webhook: object; -``` - -#### channel - -```ts -channel: string; -``` - -#### channel\_id - -```ts -channel_id: string; -``` - -#### configuration\_url - -```ts -configuration_url: string; -``` - -#### url - -```ts -url: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:776](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L776) - -*** - -### is\_enterprise\_install - -```ts -is_enterprise_install: boolean; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:775](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L775) - -*** - -### refresh\_token? - -```ts -optional refresh_token: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:770](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L770) - -*** - -### scope? - -```ts -optional scope: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:767](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L767) - -*** - -### team - -```ts -team: null | object; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:773](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L773) - -*** - -### token\_type? - -```ts -optional token_type: "bot"; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:768](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L768) diff --git a/docs/content/reference/oauth/interfaces/OAuthV2TokenRefreshResponse.md b/docs/content/reference/oauth/interfaces/OAuthV2TokenRefreshResponse.md deleted file mode 100644 index d31fe31d5..000000000 --- a/docs/content/reference/oauth/interfaces/OAuthV2TokenRefreshResponse.md +++ /dev/null @@ -1,137 +0,0 @@ -# Interface: OAuthV2TokenRefreshResponse - -## Extends - -- [`Logger`](../variables/Logger.md) - -## Properties - -### access\_token - -```ts -access_token: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:788](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L788) - -*** - -### app\_id - -```ts -app_id: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:785](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L785) - -*** - -### bot\_user\_id? - -```ts -optional bot_user_id: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:791](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L791) - -*** - -### enterprise - -```ts -enterprise: null | object; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:793](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L793) - -*** - -### expires\_in - -```ts -expires_in: number; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:790](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L790) - -*** - -### is\_enterprise\_install - -```ts -is_enterprise_install: boolean; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:794](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L794) - -*** - -### refresh\_token - -```ts -refresh_token: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:789](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L789) - -*** - -### scope - -```ts -scope: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:786](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L786) - -*** - -### team - -```ts -team: object; -``` - -#### id - -```ts -id: string; -``` - -#### name - -```ts -name: string; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:792](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L792) - -*** - -### token\_type - -```ts -token_type: "bot" | "user"; -``` - -#### Defined in - -[packages/oauth/src/install-provider.ts:787](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L787) diff --git a/docs/content/reference/oauth/interfaces/StateObj.md b/docs/content/reference/oauth/interfaces/StateObj.md deleted file mode 100644 index 750dcb299..000000000 --- a/docs/content/reference/oauth/interfaces/StateObj.md +++ /dev/null @@ -1,43 +0,0 @@ -# Interface: StateObj - -The data structure represented by the state parameter. - -## Properties - -### installOptions - -```ts -installOptions: InstallURLOptions; -``` - -The passed InstallURLOptions object when generating this state parameter. - -#### Defined in - -[packages/oauth/src/state-stores/interface.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/interface.ts#L16) - -*** - -### now - -```ts -now: Date; -``` - -The timestamp that the state object was generated. - -#### Defined in - -[packages/oauth/src/state-stores/interface.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/interface.ts#L11) - -*** - -### random? - -```ts -optional random: string | number; -``` - -#### Defined in - -[packages/oauth/src/state-stores/interface.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/interface.ts#L17) diff --git a/docs/content/reference/oauth/interfaces/StateStore.md b/docs/content/reference/oauth/interfaces/StateStore.md deleted file mode 100644 index 5fa3abc67..000000000 --- a/docs/content/reference/oauth/interfaces/StateStore.md +++ /dev/null @@ -1,59 +0,0 @@ -# Interface: StateStore - -Generates state parameter value in the OAuth flow. -While the state parameter value works for the CSRF protection purpose, -it can transfer the given InstallURLOptions value to the Redirect URL handler -(Redirect URL: the default path is "/slack/oauth_redirect") - -## Properties - -### generateStateParam() - -```ts -generateStateParam: (installOptions, now) => Promise; -``` - -Generates a valid state parameter value, which can be decoded as a StateObj object -by the verifyStateParam() method. This value may be stored on the server-side with expiration. -The InstallProvider verifies if this value is set in the installer's browser session. - -#### Parameters - -• **installOptions**: [`InstallURLOptions`](InstallURLOptions.md) - -• **now**: `Date` - -#### Returns - -`Promise`\<`string`\> - -#### Defined in - -[packages/oauth/src/state-stores/interface.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/interface.ts#L33) - -*** - -### verifyStateParam() - -```ts -verifyStateParam: (now, state) => Promise; -``` - -Verifies the given state string value by trying to decode the value and -build the passed InstallURLOptions object from the data. -This method verifies if the state value is not too old to detect replay attacks. -If the value is invalid, this method can throw InvalidStateError exception. - -#### Parameters - -• **now**: `Date` - -• **state**: `string` - -#### Returns - -`Promise`\<[`InstallURLOptions`](InstallURLOptions.md)\> - -#### Defined in - -[packages/oauth/src/state-stores/interface.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/interface.ts#L41) diff --git a/docs/content/reference/oauth/type-aliases/OrgInstallation.md b/docs/content/reference/oauth/type-aliases/OrgInstallation.md deleted file mode 100644 index 1746752df..000000000 --- a/docs/content/reference/oauth/type-aliases/OrgInstallation.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: OrgInstallation - -```ts -type OrgInstallation: Installation<"v2", true>; -``` - -A type to describe enterprise organization installations. - -## Defined in - -[packages/oauth/src/installation.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation.ts#L100) diff --git a/docs/content/reference/oauth/type-aliases/OrgInstallationQuery.md b/docs/content/reference/oauth/type-aliases/OrgInstallationQuery.md deleted file mode 100644 index 596ba3b34..000000000 --- a/docs/content/reference/oauth/type-aliases/OrgInstallationQuery.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: OrgInstallationQuery - -```ts -type OrgInstallationQuery: InstallationQuery; -``` - -## Defined in - -[packages/oauth/src/installation-query.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-query.ts#L12) diff --git a/docs/content/reference/oauth/typedoc-sidebar.cjs b/docs/content/reference/oauth/typedoc-sidebar.cjs deleted file mode 100644 index f303649b9..000000000 --- a/docs/content/reference/oauth/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/oauth/enumerations/ErrorCode","label":"ErrorCode"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/oauth/classes/AuthorizationError","label":"AuthorizationError"},{"type":"doc","id":"reference/oauth/classes/ClearStateStore","label":"ClearStateStore"},{"type":"doc","id":"reference/oauth/classes/FileInstallationStore","label":"FileInstallationStore"},{"type":"doc","id":"reference/oauth/classes/FileStateStore","label":"FileStateStore"},{"type":"doc","id":"reference/oauth/classes/GenerateInstallUrlError","label":"GenerateInstallUrlError"},{"type":"doc","id":"reference/oauth/classes/InstallProvider","label":"InstallProvider"},{"type":"doc","id":"reference/oauth/classes/InstallerInitializationError","label":"InstallerInitializationError"},{"type":"doc","id":"reference/oauth/classes/InvalidStateError","label":"InvalidStateError"},{"type":"doc","id":"reference/oauth/classes/MemoryInstallationStore","label":"MemoryInstallationStore"},{"type":"doc","id":"reference/oauth/classes/MissingCodeError","label":"MissingCodeError"},{"type":"doc","id":"reference/oauth/classes/MissingStateError","label":"MissingStateError"},{"type":"doc","id":"reference/oauth/classes/UnknownError","label":"UnknownError"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/oauth/interfaces/AuthorizeResult","label":"AuthorizeResult"},{"type":"doc","id":"reference/oauth/interfaces/CallbackOptions","label":"CallbackOptions"},{"type":"doc","id":"reference/oauth/interfaces/CodedError","label":"CodedError"},{"type":"doc","id":"reference/oauth/interfaces/FileStateStoreArgs","label":"FileStateStoreArgs"},{"type":"doc","id":"reference/oauth/interfaces/InstallPathOptions","label":"InstallPathOptions"},{"type":"doc","id":"reference/oauth/interfaces/InstallProviderOptions","label":"InstallProviderOptions"},{"type":"doc","id":"reference/oauth/interfaces/InstallURLOptions","label":"InstallURLOptions"},{"type":"doc","id":"reference/oauth/interfaces/Installation","label":"Installation"},{"type":"doc","id":"reference/oauth/interfaces/InstallationQuery","label":"InstallationQuery"},{"type":"doc","id":"reference/oauth/interfaces/InstallationStore","label":"InstallationStore"},{"type":"doc","id":"reference/oauth/interfaces/OAuthV2Response","label":"OAuthV2Response"},{"type":"doc","id":"reference/oauth/interfaces/OAuthV2TokenRefreshResponse","label":"OAuthV2TokenRefreshResponse"},{"type":"doc","id":"reference/oauth/interfaces/StateObj","label":"StateObj"},{"type":"doc","id":"reference/oauth/interfaces/StateStore","label":"StateStore"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/oauth/type-aliases/OrgInstallation","label":"OrgInstallation"},{"type":"doc","id":"reference/oauth/type-aliases/OrgInstallationQuery","label":"OrgInstallationQuery"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/oauth/variables/Logger","label":"Logger"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"reference/oauth/functions/defaultCallbackFailure","label":"defaultCallbackFailure"},{"type":"doc","id":"reference/oauth/functions/defaultCallbackSuccess","label":"defaultCallbackSuccess"},{"type":"doc","id":"reference/oauth/functions/defaultRenderHtmlForInstallPath","label":"defaultRenderHtmlForInstallPath"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/oauth/variables/Logger.md b/docs/content/reference/oauth/variables/Logger.md deleted file mode 100644 index e32c0b8c7..000000000 --- a/docs/content/reference/oauth/variables/Logger.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: Logger - -```ts -Logger: any; -``` diff --git a/docs/content/reference/rtm-api/classes/RTMClient.md b/docs/content/reference/rtm-api/classes/RTMClient.md deleted file mode 100644 index 7a5da3ed5..000000000 --- a/docs/content/reference/rtm-api/classes/RTMClient.md +++ /dev/null @@ -1,316 +0,0 @@ -# Class: RTMClient - -An RTMClient allows programs to communicate with the [Platform's RTM API](https://api.slack.com/rtm|Slack). -This object uses the EventEmitter pattern to dispatch incoming events and has several methods for sending outgoing -messages. - -## Extends - -- [`Logger`](../variables/Logger.md) - -## Constructors - -### new RTMClient() - -```ts -new RTMClient(token, __namedParameters): RTMClient -``` - -#### Parameters - -• **token**: `string` - -• **\_\_namedParameters**: [`RTMClientOptions`](../interfaces/RTMClientOptions.md) = `{}` - -#### Returns - -[`RTMClient`](RTMClient.md) - -#### Overrides - -`EventEmitter.constructor` - -#### Defined in - -[RTMClient.ts:340](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L340) - -## Properties - -### activeTeamId? - -```ts -optional activeTeamId: string; -``` - -The team ID for the workspace the client is connected to. - -#### Defined in - -[RTMClient.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L83) - -*** - -### activeUserId? - -```ts -optional activeUserId: string; -``` - -The user ID for the connected client. - -#### Defined in - -[RTMClient.ts:78](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L78) - -*** - -### authenticated - -```ts -authenticated: boolean = false; -``` - -Whether or not the client has authenticated to the RTM API. This occurs when the connect method -completes, and a WebSocket URL is available for the client's connection. - -#### Defined in - -[RTMClient.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L73) - -*** - -### connected - -```ts -connected: boolean = false; -``` - -Whether or not the client is currently connected to the RTM API - -#### Defined in - -[RTMClient.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L67) - -## Methods - -### addOutgoingEvent() - -#### addOutgoingEvent(awaitReply, type, body) - -```ts -addOutgoingEvent( - awaitReply, - type, -body?): Promise -``` - -Generic method for sending an outgoing message of an arbitrary type. This method guards the higher-level methods -from concern of which state the client is in, because it places all messages into a queue. The tasks on the queue -will buffer until the client is in a state where they can be sent. - -If the awaitReply parameter is set to true, then the returned Promise is resolved with the platform's -acknowledgement response. Not all message types will result in an acknowledgement response, so use this carefully. -This promise may be rejected with an error containing code=RTMNoReplyReceivedError if the client disconnects or -reconnects before receiving the acknowledgement response. - -If the awaitReply parameter is set to false, then the returned Promise is resolved as soon as the message is sent -from the websocket. - -##### Parameters - -• **awaitReply**: `true` - -whether to wait for an acknowledgement response from the platform before resolving the returned -Promise. - -• **type**: `string` - -the message type - -• **body?**: `Record`\<`string`, `unknown`\> - -the message body - -##### Returns - -`Promise`\<[`RTMCallResult`](../interfaces/RTMCallResult.md)\> - -##### Defined in - -[RTMClient.ts:493](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L493) - -#### addOutgoingEvent(awaitReply, type, body) - -```ts -addOutgoingEvent( - awaitReply, - type, -body?): Promise -``` - -##### Parameters - -• **awaitReply**: `false` - -• **type**: `string` - -• **body?**: `Record`\<`string`, `unknown`\> - -##### Returns - -`Promise`\<`void`\> - -##### Defined in - -[RTMClient.ts:494](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L494) - -*** - -### disconnect() - -```ts -disconnect(): Promise -``` - -End an RTM session. After this method is called no messages will be sent or received unless you call -start() again later. - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[RTMClient.ts:432](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L432) - -*** - -### send() - -```ts -send(type, body): Promise -``` - -Generic method for sending an outgoing message of an arbitrary type. The main difference between this method and -addOutgoingEvent() is that this method does not use a queue so it can only be used while the client is ready -to send messages (in the 'ready' substate of the 'connected' state). It returns a Promise for the message ID of the -sent message. This is an internal ID and generally shouldn't be used as an identifier for messages (for that, -there is `ts` on messages once the server acknowledges it). - -#### Parameters - -• **type**: `string` - -the message type - -• **body** = `{}` - -the message body - -#### Returns - -`Promise`\<`number`\> - -#### Defined in - -[RTMClient.ts:541](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L541) - -*** - -### sendMessage() - -```ts -sendMessage(text, conversationId): Promise -``` - -Send a simple message to a public channel, private channel, DM, or MPDM. - -#### Parameters - -• **text**: `string` - -The message text. - -• **conversationId**: `string` - -A conversation ID for the destination of this message. - -#### Returns - -`Promise`\<[`RTMCallResult`](../interfaces/RTMCallResult.md)\> - -#### Defined in - -[RTMClient.ts:455](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L455) - -*** - -### sendTyping() - -```ts -sendTyping(conversationId): Promise -``` - -Sends a typing indicator to indicate that the user with `activeUserId` is typing. - -#### Parameters - -• **conversationId**: `string` - -The destination for where the typing indicator should be shown. - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[RTMClient.ts:463](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L463) - -*** - -### start() - -```ts -start(options?): Promise -``` - -Begin an RTM session using the provided options. This method must be called before any messages can -be sent or received. - -#### Parameters - -• **options?**: `any` - -#### Returns - -`Promise`\<`WebAPICallResult`\> - -#### Defined in - -[RTMClient.ts:406](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L406) - -*** - -### subscribePresence() - -```ts -subscribePresence(userIds): Promise -``` - -Subscribes this client to presence changes for only the given `userIds`. - -#### Parameters - -• **userIds**: `string`[] - -An array of user IDs whose presence you are interested in. This list will replace the list from -any previous calls to this method. - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[RTMClient.ts:472](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L472) diff --git a/docs/content/reference/rtm-api/enumerations/ErrorCode.md b/docs/content/reference/rtm-api/enumerations/ErrorCode.md deleted file mode 100644 index 8d83347ba..000000000 --- a/docs/content/reference/rtm-api/enumerations/ErrorCode.md +++ /dev/null @@ -1,99 +0,0 @@ -# Enumeration: ErrorCode - -A dictionary of codes for errors produced by this package - -## Enumeration Members - -### KeepAliveClientNotConnected - -```ts -KeepAliveClientNotConnected: "slack_rtmapi_keepalive_client_not_connected"; -``` - -#### Defined in - -[errors.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L22) - -*** - -### KeepAliveConfigError - -```ts -KeepAliveConfigError: "slack_rtmapi_keepalive_config_error"; -``` - -#### Defined in - -[errors.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L21) - -*** - -### KeepAliveInconsistentState - -```ts -KeepAliveInconsistentState: "slack_rtmapi_keepalive_inconsistent_state"; -``` - -#### Defined in - -[errors.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L23) - -*** - -### NoReplyReceivedError - -```ts -NoReplyReceivedError: "slack_rtmapi_no_reply_received_error"; -``` - -#### Defined in - -[errors.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L18) - -*** - -### SendMessagePlatformError - -```ts -SendMessagePlatformError: "slack_rtmapi_send_message_platform_error"; -``` - -#### Defined in - -[errors.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L16) - -*** - -### SendWhileDisconnectedError - -```ts -SendWhileDisconnectedError: "slack_rtmapi_send_while_disconnected_error"; -``` - -#### Defined in - -[errors.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L14) - -*** - -### SendWhileNotReadyError - -```ts -SendWhileNotReadyError: "slack_rtmapi_send_while_not_ready_error"; -``` - -#### Defined in - -[errors.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L15) - -*** - -### WebsocketError - -```ts -WebsocketError: "slack_rtmapi_websocket_error"; -``` - -#### Defined in - -[errors.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L17) diff --git a/docs/content/reference/rtm-api/index.md b/docs/content/reference/rtm-api/index.md deleted file mode 100644 index 086fabe18..000000000 --- a/docs/content/reference/rtm-api/index.md +++ /dev/null @@ -1,35 +0,0 @@ -# @slack/rtm-api - -## References - -### LogLevel - -Renames and re-exports [Logger](variables/Logger.md) - -## Enumerations - -- [ErrorCode](enumerations/ErrorCode.md) - -## Classes - -- [RTMClient](classes/RTMClient.md) - -## Interfaces - -- [CodedError](interfaces/CodedError.md) -- [RTMCallResult](interfaces/RTMCallResult.md) -- [RTMClientOptions](interfaces/RTMClientOptions.md) -- [RTMNoReplyReceivedError](interfaces/RTMNoReplyReceivedError.md) -- [RTMPlatformError](interfaces/RTMPlatformError.md) -- [RTMSendWhileDisconnectedError](interfaces/RTMSendWhileDisconnectedError.md) -- [RTMSendWhileNotReadyError](interfaces/RTMSendWhileNotReadyError.md) -- [RTMWebsocketError](interfaces/RTMWebsocketError.md) - -## Type Aliases - -- [RTMCallError](type-aliases/RTMCallError.md) -- [RTMStartOptions](type-aliases/RTMStartOptions.md) - -## Variables - -- [Logger](variables/Logger.md) diff --git a/docs/content/reference/rtm-api/interfaces/CodedError.md b/docs/content/reference/rtm-api/interfaces/CodedError.md deleted file mode 100644 index 8f94ea7e1..000000000 --- a/docs/content/reference/rtm-api/interfaces/CodedError.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: CodedError - -All errors produced by this package adhere to this interface - -## Extends - -- `ErrnoException` - -## Extended by - -- [`RTMPlatformError`](RTMPlatformError.md) -- [`RTMWebsocketError`](RTMWebsocketError.md) -- [`RTMNoReplyReceivedError`](RTMNoReplyReceivedError.md) -- [`RTMSendWhileDisconnectedError`](RTMSendWhileDisconnectedError.md) -- [`RTMSendWhileNotReadyError`](RTMSendWhileNotReadyError.md) - -## Properties - -### code - -```ts -code: ErrorCode; -``` - -#### Defined in - -[errors.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L7) diff --git a/docs/content/reference/rtm-api/interfaces/RTMCallResult.md b/docs/content/reference/rtm-api/interfaces/RTMCallResult.md deleted file mode 100644 index 6a59717f3..000000000 --- a/docs/content/reference/rtm-api/interfaces/RTMCallResult.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: RTMCallResult - -## Properties - -### error? - -```ts -optional error: object; -``` - -#### code - -```ts -code: number; -``` - -#### msg - -```ts -msg: string; -``` - -#### Defined in - -[RTMClient.ts:698](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L698) - -*** - -### reply\_to? - -```ts -optional reply_to: number; -``` - -#### Defined in - -[RTMClient.ts:697](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L697) - -*** - -### ts - -```ts -ts: string; -``` - -#### Defined in - -[RTMClient.ts:696](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L696) diff --git a/docs/content/reference/rtm-api/interfaces/RTMClientOptions.md b/docs/content/reference/rtm-api/interfaces/RTMClientOptions.md deleted file mode 100644 index 918c272b4..000000000 --- a/docs/content/reference/rtm-api/interfaces/RTMClientOptions.md +++ /dev/null @@ -1,145 +0,0 @@ -# Interface: RTMClientOptions - -## Properties - -### agent? - -```ts -optional agent: any; -``` - -#### Defined in - -[RTMClient.ts:682](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L682) - -*** - -### autoReconnect? - -```ts -optional autoReconnect: boolean; -``` - -#### Defined in - -[RTMClient.ts:683](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L683) - -*** - -### clientPingTimeout? - -```ts -optional clientPingTimeout: number; -``` - -#### Defined in - -[RTMClient.ts:687](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L687) - -*** - -### logLevel? - -```ts -optional logLevel: any; -``` - -#### Defined in - -[RTMClient.ts:680](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L680) - -*** - -### logger? - -```ts -optional logger: any; -``` - -#### Defined in - -[RTMClient.ts:679](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L679) - -*** - -### replyAckOnReconnectTimeout? - -```ts -optional replyAckOnReconnectTimeout: number; -``` - -#### Defined in - -[RTMClient.ts:689](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L689) - -*** - -### retryConfig? - -```ts -optional retryConfig: any; -``` - -#### Defined in - -[RTMClient.ts:681](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L681) - -*** - -### serverPongTimeout? - -```ts -optional serverPongTimeout: number; -``` - -#### Defined in - -[RTMClient.ts:688](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L688) - -*** - -### slackApiUrl? - -```ts -optional slackApiUrl: string; -``` - -#### Defined in - -[RTMClient.ts:678](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L678) - -*** - -### tls? - -```ts -optional tls: any; -``` - -#### Defined in - -[RTMClient.ts:690](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L690) - -*** - -### useRtmConnect? - -```ts -optional useRtmConnect: boolean; -``` - -#### Defined in - -[RTMClient.ts:686](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L686) - -*** - -### webClient? - -```ts -optional webClient: any; -``` - -#### Defined in - -[RTMClient.ts:677](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L677) diff --git a/docs/content/reference/rtm-api/interfaces/RTMNoReplyReceivedError.md b/docs/content/reference/rtm-api/interfaces/RTMNoReplyReceivedError.md deleted file mode 100644 index e3394260b..000000000 --- a/docs/content/reference/rtm-api/interfaces/RTMNoReplyReceivedError.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: RTMNoReplyReceivedError - -All errors produced by this package adhere to this interface - -## Extends - -- [`CodedError`](CodedError.md) - -## Properties - -### code - -```ts -code: NoReplyReceivedError; -``` - -#### Overrides - -[`CodedError`](CodedError.md).[`code`](CodedError.md#code) - -#### Defined in - -[errors.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L40) diff --git a/docs/content/reference/rtm-api/interfaces/RTMPlatformError.md b/docs/content/reference/rtm-api/interfaces/RTMPlatformError.md deleted file mode 100644 index 507970f46..000000000 --- a/docs/content/reference/rtm-api/interfaces/RTMPlatformError.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: RTMPlatformError - -All errors produced by this package adhere to this interface - -## Extends - -- [`CodedError`](CodedError.md) - -## Properties - -### code - -```ts -code: SendMessagePlatformError; -``` - -#### Overrides - -[`CodedError`](CodedError.md).[`code`](CodedError.md#code) - -#### Defined in - -[errors.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L30) - -*** - -### data - -```ts -data: RTMCallResult; -``` - -#### Defined in - -[errors.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L31) diff --git a/docs/content/reference/rtm-api/interfaces/RTMSendWhileDisconnectedError.md b/docs/content/reference/rtm-api/interfaces/RTMSendWhileDisconnectedError.md deleted file mode 100644 index 812d92be4..000000000 --- a/docs/content/reference/rtm-api/interfaces/RTMSendWhileDisconnectedError.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: RTMSendWhileDisconnectedError - -All errors produced by this package adhere to this interface - -## Extends - -- [`CodedError`](CodedError.md) - -## Properties - -### code - -```ts -code: SendWhileDisconnectedError; -``` - -#### Overrides - -[`CodedError`](CodedError.md).[`code`](CodedError.md#code) - -#### Defined in - -[errors.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L44) diff --git a/docs/content/reference/rtm-api/interfaces/RTMSendWhileNotReadyError.md b/docs/content/reference/rtm-api/interfaces/RTMSendWhileNotReadyError.md deleted file mode 100644 index 577135ac2..000000000 --- a/docs/content/reference/rtm-api/interfaces/RTMSendWhileNotReadyError.md +++ /dev/null @@ -1,23 +0,0 @@ -# Interface: RTMSendWhileNotReadyError - -All errors produced by this package adhere to this interface - -## Extends - -- [`CodedError`](CodedError.md) - -## Properties - -### code - -```ts -code: SendWhileNotReadyError; -``` - -#### Overrides - -[`CodedError`](CodedError.md).[`code`](CodedError.md#code) - -#### Defined in - -[errors.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L48) diff --git a/docs/content/reference/rtm-api/interfaces/RTMWebsocketError.md b/docs/content/reference/rtm-api/interfaces/RTMWebsocketError.md deleted file mode 100644 index 15c380e52..000000000 --- a/docs/content/reference/rtm-api/interfaces/RTMWebsocketError.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: RTMWebsocketError - -All errors produced by this package adhere to this interface - -## Extends - -- [`CodedError`](CodedError.md) - -## Properties - -### code - -```ts -code: WebsocketError; -``` - -#### Overrides - -[`CodedError`](CodedError.md).[`code`](CodedError.md#code) - -#### Defined in - -[errors.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L35) - -*** - -### original - -```ts -original: Error; -``` - -#### Defined in - -[errors.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L36) diff --git a/docs/content/reference/rtm-api/type-aliases/RTMCallError.md b/docs/content/reference/rtm-api/type-aliases/RTMCallError.md deleted file mode 100644 index abc824c22..000000000 --- a/docs/content/reference/rtm-api/type-aliases/RTMCallError.md +++ /dev/null @@ -1,14 +0,0 @@ -# Type Alias: RTMCallError - -```ts -type RTMCallError: - | RTMPlatformError - | RTMWebsocketError - | RTMNoReplyReceivedError - | RTMSendWhileDisconnectedError - | RTMSendWhileNotReadyError; -``` - -## Defined in - -[errors.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/errors.ts#L26) diff --git a/docs/content/reference/rtm-api/type-aliases/RTMStartOptions.md b/docs/content/reference/rtm-api/type-aliases/RTMStartOptions.md deleted file mode 100644 index 8acb7effe..000000000 --- a/docs/content/reference/rtm-api/type-aliases/RTMStartOptions.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: RTMStartOptions - -```ts -type RTMStartOptions: Logger | Logger; -``` - -## Defined in - -[RTMClient.ts:704](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L704) diff --git a/docs/content/reference/rtm-api/typedoc-sidebar.cjs b/docs/content/reference/rtm-api/typedoc-sidebar.cjs deleted file mode 100644 index 58e1b4982..000000000 --- a/docs/content/reference/rtm-api/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/rtm-api/enumerations/ErrorCode","label":"ErrorCode"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/rtm-api/classes/RTMClient","label":"RTMClient"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/rtm-api/interfaces/CodedError","label":"CodedError"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMCallResult","label":"RTMCallResult"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMClientOptions","label":"RTMClientOptions"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMNoReplyReceivedError","label":"RTMNoReplyReceivedError"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMPlatformError","label":"RTMPlatformError"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMSendWhileDisconnectedError","label":"RTMSendWhileDisconnectedError"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMSendWhileNotReadyError","label":"RTMSendWhileNotReadyError"},{"type":"doc","id":"reference/rtm-api/interfaces/RTMWebsocketError","label":"RTMWebsocketError"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/rtm-api/type-aliases/RTMCallError","label":"RTMCallError"},{"type":"doc","id":"reference/rtm-api/type-aliases/RTMStartOptions","label":"RTMStartOptions"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/rtm-api/variables/Logger","label":"Logger"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/rtm-api/variables/Logger.md b/docs/content/reference/rtm-api/variables/Logger.md deleted file mode 100644 index e32c0b8c7..000000000 --- a/docs/content/reference/rtm-api/variables/Logger.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: Logger - -```ts -Logger: any; -``` diff --git a/docs/content/reference/socket-mode/classes/SocketModeClient.md b/docs/content/reference/socket-mode/classes/SocketModeClient.md deleted file mode 100644 index cff68f6fc..000000000 --- a/docs/content/reference/socket-mode/classes/SocketModeClient.md +++ /dev/null @@ -1,115 +0,0 @@ -# Class: SocketModeClient - -A Socket Mode Client allows programs to communicate with the -[Slack Platform's Events API](https://api.slack.com/events-api) over WebSocket connections. -This object uses the EventEmitter pattern to dispatch incoming events -and has a built in send method to acknowledge incoming events over the WebSocket connection. - -## Extends - -- [`Logger`](../variables/Logger.md) - -## Constructors - -### new SocketModeClient() - -```ts -new SocketModeClient(__namedParameters): SocketModeClient -``` - -#### Parameters - -• **\_\_namedParameters**: [`SocketModeOptions`](../interfaces/SocketModeOptions.md) = `...` - -#### Returns - -[`SocketModeClient`](SocketModeClient.md) - -#### Overrides - -`EventEmitter.constructor` - -#### Defined in - -[packages/socket-mode/src/SocketModeClient.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeClient.ts#L99) - -## Properties - -### websocket? - -```ts -optional websocket: SlackWebSocket; -``` - -The underlying WebSocket client instance - -#### Defined in - -[packages/socket-mode/src/SocketModeClient.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeClient.ts#L69) - -## Methods - -### disconnect() - -```ts -disconnect(): Promise -``` - -End a Socket Mode session. After this method is called no messages will be sent or received -unless you call start() again later. - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/socket-mode/src/SocketModeClient.ts:205](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeClient.ts#L205) - -*** - -### onWebSocketMessage() - -```ts -protected onWebSocketMessage(data, isBinary): Promise -``` - -`onmessage` handler for the client's WebSocket. -This will parse the payload and dispatch the application-relevant events for each incoming message. -Mediates: -- raising the State.Connected event (when Slack sends a type:hello message) -- disconnecting the underlying socket (when Slack sends a type:disconnect message) - -#### Parameters - -• **data**: `RawData` - -• **isBinary**: `boolean` - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[packages/socket-mode/src/SocketModeClient.ts:282](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeClient.ts#L282) - -*** - -### start() - -```ts -start(): Promise -``` - -Start a Socket Mode session app. -This method must be called before any messages can be sent or received, -or to disconnect the client via the `disconnect` method. - -#### Returns - -`Promise`\<`AppsConnectionsOpenResponse`\> - -#### Defined in - -[packages/socket-mode/src/SocketModeClient.ts:163](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeClient.ts#L163) diff --git a/docs/content/reference/socket-mode/enumerations/ErrorCode.md b/docs/content/reference/socket-mode/enumerations/ErrorCode.md deleted file mode 100644 index cd71b1c17..000000000 --- a/docs/content/reference/socket-mode/enumerations/ErrorCode.md +++ /dev/null @@ -1,75 +0,0 @@ -# Enumeration: ErrorCode - -A dictionary of codes for errors produced by this package - -## Enumeration Members - -### InitializationError - -```ts -InitializationError: "slack_socket_mode_initialization_error"; -``` - -#### Defined in - -[packages/socket-mode/src/errors.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L17) - -*** - -### NoReplyReceivedError - -```ts -NoReplyReceivedError: "slack_socket_mode_no_reply_received_error"; -``` - -#### Defined in - -[packages/socket-mode/src/errors.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L16) - -*** - -### SendMessagePlatformError - -```ts -SendMessagePlatformError: "slack_socket_mode_send_message_platform_error"; -``` - -#### Defined in - -[packages/socket-mode/src/errors.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L14) - -*** - -### SendWhileDisconnectedError - -```ts -SendWhileDisconnectedError: "slack_socket_mode_send_while_disconnected_error"; -``` - -#### Defined in - -[packages/socket-mode/src/errors.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L12) - -*** - -### SendWhileNotReadyError - -```ts -SendWhileNotReadyError: "slack_socket_mode_send_while_not_ready_error"; -``` - -#### Defined in - -[packages/socket-mode/src/errors.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L13) - -*** - -### WebsocketError - -```ts -WebsocketError: "slack_socket_mode_websocket_error"; -``` - -#### Defined in - -[packages/socket-mode/src/errors.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L15) diff --git a/docs/content/reference/socket-mode/enumerations/UnrecoverableSocketModeStartError.md b/docs/content/reference/socket-mode/enumerations/UnrecoverableSocketModeStartError.md deleted file mode 100644 index 720734b11..000000000 --- a/docs/content/reference/socket-mode/enumerations/UnrecoverableSocketModeStartError.md +++ /dev/null @@ -1,61 +0,0 @@ -# Enumeration: UnrecoverableSocketModeStartError - -## Enumeration Members - -### AccountInactive - -```ts -AccountInactive: "account_inactive"; -``` - -#### Defined in - -[packages/socket-mode/src/UnrecoverableSocketModeStartError.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/UnrecoverableSocketModeStartError.ts#L8) - -*** - -### InvalidAuth - -```ts -InvalidAuth: "invalid_auth"; -``` - -#### Defined in - -[packages/socket-mode/src/UnrecoverableSocketModeStartError.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/UnrecoverableSocketModeStartError.ts#L7) - -*** - -### NotAuthed - -```ts -NotAuthed: "not_authed"; -``` - -#### Defined in - -[packages/socket-mode/src/UnrecoverableSocketModeStartError.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/UnrecoverableSocketModeStartError.ts#L6) - -*** - -### TeamDisabled - -```ts -TeamDisabled: "team_disabled"; -``` - -#### Defined in - -[packages/socket-mode/src/UnrecoverableSocketModeStartError.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/UnrecoverableSocketModeStartError.ts#L10) - -*** - -### UserRemovedFromTeam - -```ts -UserRemovedFromTeam: "user_removed_from_team"; -``` - -#### Defined in - -[packages/socket-mode/src/UnrecoverableSocketModeStartError.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/UnrecoverableSocketModeStartError.ts#L9) diff --git a/docs/content/reference/socket-mode/index.md b/docs/content/reference/socket-mode/index.md deleted file mode 100644 index 9e4708f53..000000000 --- a/docs/content/reference/socket-mode/index.md +++ /dev/null @@ -1,33 +0,0 @@ -# @slack/socket-mode - -## References - -### LogLevel - -Renames and re-exports [Logger](variables/Logger.md) - -## Enumerations - -- [ErrorCode](enumerations/ErrorCode.md) -- [UnrecoverableSocketModeStartError](enumerations/UnrecoverableSocketModeStartError.md) - -## Classes - -- [SocketModeClient](classes/SocketModeClient.md) - -## Interfaces - -- [SMNoReplyReceivedError](interfaces/SMNoReplyReceivedError.md) -- [SMPlatformError](interfaces/SMPlatformError.md) -- [SMSendWhileDisconnectedError](interfaces/SMSendWhileDisconnectedError.md) -- [SMSendWhileNotReadyError](interfaces/SMSendWhileNotReadyError.md) -- [SMWebsocketError](interfaces/SMWebsocketError.md) -- [SocketModeOptions](interfaces/SocketModeOptions.md) - -## Type Aliases - -- [SMCallError](type-aliases/SMCallError.md) - -## Variables - -- [Logger](variables/Logger.md) diff --git a/docs/content/reference/socket-mode/interfaces/SMNoReplyReceivedError.md b/docs/content/reference/socket-mode/interfaces/SMNoReplyReceivedError.md deleted file mode 100644 index 1f50807ea..000000000 --- a/docs/content/reference/socket-mode/interfaces/SMNoReplyReceivedError.md +++ /dev/null @@ -1,69 +0,0 @@ -# Interface: SMNoReplyReceivedError - -## Extends - -- `CodedError` - -## Properties - -### code - -```ts -code: NoReplyReceivedError; -``` - -#### Overrides - -`CodedError.code` - -#### Defined in - -[packages/socket-mode/src/errors.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L35) - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -`CodedError.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -`CodedError.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -`CodedError.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/socket-mode/interfaces/SMPlatformError.md b/docs/content/reference/socket-mode/interfaces/SMPlatformError.md deleted file mode 100644 index 3b54a8644..000000000 --- a/docs/content/reference/socket-mode/interfaces/SMPlatformError.md +++ /dev/null @@ -1,81 +0,0 @@ -# Interface: SMPlatformError - -## Extends - -- `CodedError` - -## Properties - -### code - -```ts -code: SendMessagePlatformError; -``` - -#### Overrides - -`CodedError.code` - -#### Defined in - -[packages/socket-mode/src/errors.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L24) - -*** - -### data - -```ts -data: any; -``` - -#### Defined in - -[packages/socket-mode/src/errors.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L26) - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -`CodedError.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -`CodedError.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -`CodedError.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/socket-mode/interfaces/SMSendWhileDisconnectedError.md b/docs/content/reference/socket-mode/interfaces/SMSendWhileDisconnectedError.md deleted file mode 100644 index c0058ede8..000000000 --- a/docs/content/reference/socket-mode/interfaces/SMSendWhileDisconnectedError.md +++ /dev/null @@ -1,69 +0,0 @@ -# Interface: SMSendWhileDisconnectedError - -## Extends - -- `CodedError` - -## Properties - -### code - -```ts -code: SendWhileDisconnectedError; -``` - -#### Overrides - -`CodedError.code` - -#### Defined in - -[packages/socket-mode/src/errors.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L39) - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -`CodedError.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -`CodedError.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -`CodedError.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/socket-mode/interfaces/SMSendWhileNotReadyError.md b/docs/content/reference/socket-mode/interfaces/SMSendWhileNotReadyError.md deleted file mode 100644 index 137a0c0ce..000000000 --- a/docs/content/reference/socket-mode/interfaces/SMSendWhileNotReadyError.md +++ /dev/null @@ -1,69 +0,0 @@ -# Interface: SMSendWhileNotReadyError - -## Extends - -- `CodedError` - -## Properties - -### code - -```ts -code: SendWhileNotReadyError; -``` - -#### Overrides - -`CodedError.code` - -#### Defined in - -[packages/socket-mode/src/errors.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L43) - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -`CodedError.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -`CodedError.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -`CodedError.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/socket-mode/interfaces/SMWebsocketError.md b/docs/content/reference/socket-mode/interfaces/SMWebsocketError.md deleted file mode 100644 index ba71a3021..000000000 --- a/docs/content/reference/socket-mode/interfaces/SMWebsocketError.md +++ /dev/null @@ -1,81 +0,0 @@ -# Interface: SMWebsocketError - -## Extends - -- `CodedError` - -## Properties - -### code - -```ts -code: WebsocketError; -``` - -#### Overrides - -`CodedError.code` - -#### Defined in - -[packages/socket-mode/src/errors.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L30) - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -`CodedError.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -`CodedError.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### original - -```ts -original: Error; -``` - -#### Defined in - -[packages/socket-mode/src/errors.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L31) - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -`CodedError.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 diff --git a/docs/content/reference/socket-mode/interfaces/SocketModeOptions.md b/docs/content/reference/socket-mode/interfaces/SocketModeOptions.md deleted file mode 100644 index 69eda330f..000000000 --- a/docs/content/reference/socket-mode/interfaces/SocketModeOptions.md +++ /dev/null @@ -1,123 +0,0 @@ -# Interface: SocketModeOptions - -## Properties - -### appToken - -```ts -appToken: string; -``` - -The App-level token associated with your app, located under the Basic Information page on api.slack.com/apps. - -#### Defined in - -[packages/socket-mode/src/SocketModeOptions.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L8) - -*** - -### autoReconnectEnabled? - -```ts -optional autoReconnectEnabled: boolean; -``` - -Whether the client should automatically reconnect when the socket mode connection is disrupted. Defaults to `true`. -Note that disconnects are regular and expected when using Socket Mode, so setting this to `false` will likely lead -to a disconnected client after some amount of time. - -#### Defined in - -[packages/socket-mode/src/SocketModeOptions.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L22) - -*** - -### clientOptions? - -```ts -optional clientOptions: Omit; -``` - -The `@slack/web-api` `WebClientOptions` to provide to the HTTP client interacting with Slack's HTTP API. -Useful for setting retry configurations, TLS and HTTP Agent options. - -#### Defined in - -[packages/socket-mode/src/SocketModeOptions.ts:46](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L46) - -*** - -### clientPingTimeout? - -```ts -optional clientPingTimeout: number; -``` - -How long the client should wait for a `pong` response to the client's `ping` to the server, in milliseconds. -If this timeout is hit, the client will attempt to reconnect if `autoReconnectEnabled` is `true`; -otherwise, it will disconnect. -Defaults to 5,000. - -#### Defined in - -[packages/socket-mode/src/SocketModeOptions.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L29) - -*** - -### logLevel? - -```ts -optional logLevel: any; -``` - -An instance of `@slack/logger`'s LogLevel enum, setting the minimum log level to emit log messages for. - -#### Defined in - -[packages/socket-mode/src/SocketModeOptions.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L16) - -*** - -### logger? - -```ts -optional logger: any; -``` - -An instance of `@slack/logger`'s Logger interface, to send log messages to. - -#### Defined in - -[packages/socket-mode/src/SocketModeOptions.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L12) - -*** - -### pingPongLoggingEnabled? - -```ts -optional pingPongLoggingEnabled: boolean; -``` - -Should logging related to `ping` and `pong` messages between the client and server be logged at a -`LogLevel.DEBUG` level. Defaults to `false. - -#### Defined in - -[packages/socket-mode/src/SocketModeOptions.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L41) - -*** - -### serverPingTimeout? - -```ts -optional serverPingTimeout: number; -``` - -How long the client should wait for `ping` messages from the server, in milliseconds. -If this timeout is hit, the client will attempt to reconnect if `autoReconnectEnabled` is `true`; -otherwise, it will disconnect. -Defaults to 30,000. - -#### Defined in - -[packages/socket-mode/src/SocketModeOptions.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeOptions.ts#L36) diff --git a/docs/content/reference/socket-mode/type-aliases/SMCallError.md b/docs/content/reference/socket-mode/type-aliases/SMCallError.md deleted file mode 100644 index 50c968687..000000000 --- a/docs/content/reference/socket-mode/type-aliases/SMCallError.md +++ /dev/null @@ -1,14 +0,0 @@ -# Type Alias: SMCallError - -```ts -type SMCallError: - | SMPlatformError - | SMWebsocketError - | SMNoReplyReceivedError - | SMSendWhileDisconnectedError - | SMSendWhileNotReadyError; -``` - -## Defined in - -[packages/socket-mode/src/errors.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/errors.ts#L20) diff --git a/docs/content/reference/socket-mode/typedoc-sidebar.cjs b/docs/content/reference/socket-mode/typedoc-sidebar.cjs deleted file mode 100644 index fc52a0b5e..000000000 --- a/docs/content/reference/socket-mode/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/socket-mode/enumerations/ErrorCode","label":"ErrorCode"},{"type":"doc","id":"reference/socket-mode/enumerations/UnrecoverableSocketModeStartError","label":"UnrecoverableSocketModeStartError"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/socket-mode/classes/SocketModeClient","label":"SocketModeClient"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/socket-mode/interfaces/SMNoReplyReceivedError","label":"SMNoReplyReceivedError"},{"type":"doc","id":"reference/socket-mode/interfaces/SMPlatformError","label":"SMPlatformError"},{"type":"doc","id":"reference/socket-mode/interfaces/SMSendWhileDisconnectedError","label":"SMSendWhileDisconnectedError"},{"type":"doc","id":"reference/socket-mode/interfaces/SMSendWhileNotReadyError","label":"SMSendWhileNotReadyError"},{"type":"doc","id":"reference/socket-mode/interfaces/SMWebsocketError","label":"SMWebsocketError"},{"type":"doc","id":"reference/socket-mode/interfaces/SocketModeOptions","label":"SocketModeOptions"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/socket-mode/type-aliases/SMCallError","label":"SMCallError"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/socket-mode/variables/Logger","label":"Logger"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/socket-mode/variables/Logger.md b/docs/content/reference/socket-mode/variables/Logger.md deleted file mode 100644 index e32c0b8c7..000000000 --- a/docs/content/reference/socket-mode/variables/Logger.md +++ /dev/null @@ -1,5 +0,0 @@ -# Variable: Logger - -```ts -Logger: any; -``` diff --git a/docs/content/reference/types/index.md b/docs/content/reference/types/index.md deleted file mode 100644 index ab930a3fb..000000000 --- a/docs/content/reference/types/index.md +++ /dev/null @@ -1,108 +0,0 @@ -# @slack/types - -## Interfaces - -- [Action](interfaces/Action.md) -- [Actionable](interfaces/Actionable.md) -- [ActionsBlock](interfaces/ActionsBlock.md) -- [Block](interfaces/Block.md) -- [Button](interfaces/Button.md) -- [CallUserExternal](interfaces/CallUserExternal.md) -- [CallUserSlack](interfaces/CallUserSlack.md) -- [ChannelsSelect](interfaces/ChannelsSelect.md) -- [Checkboxes](interfaces/Checkboxes.md) -- [Confirm](interfaces/Confirm.md) -- [Confirmable](interfaces/Confirmable.md) -- [Confirmation](interfaces/Confirmation.md) -- [ConfirmationDialog](interfaces/ConfirmationDialog.md) -- [ContextBlock](interfaces/ContextBlock.md) -- [ConversationsSelect](interfaces/ConversationsSelect.md) -- [DateTimepicker](interfaces/DateTimepicker.md) -- [Datepicker](interfaces/Datepicker.md) -- [Dialog](interfaces/Dialog.md) -- [DispatchActionConfig](interfaces/DispatchActionConfig.md) -- [Dispatchable](interfaces/Dispatchable.md) -- [DividerBlock](interfaces/DividerBlock.md) -- [EmailInput](interfaces/EmailInput.md) -- [ExternalSelect](interfaces/ExternalSelect.md) -- [FileBlock](interfaces/FileBlock.md) -- [FileInput](interfaces/FileInput.md) -- [Focusable](interfaces/Focusable.md) -- [HeaderBlock](interfaces/HeaderBlock.md) -- [HomeView](interfaces/HomeView.md) -- [InputBlock](interfaces/InputBlock.md) -- [LinkUnfurls](interfaces/LinkUnfurls.md) -- [MaxItemsSelectable](interfaces/MaxItemsSelectable.md) -- [MessageAttachment](interfaces/MessageAttachment.md) -- [MessageAttachmentField](interfaces/MessageAttachmentField.md) -- [MessageMetadata](interfaces/MessageMetadata.md) -- [MessageMetadataEventPayloadObject](interfaces/MessageMetadataEventPayloadObject.md) -- [ModalView](interfaces/ModalView.md) -- [MrkdwnElement](interfaces/MrkdwnElement.md) -- [MrkdwnOption](interfaces/MrkdwnOption.md) -- [MultiChannelsSelect](interfaces/MultiChannelsSelect.md) -- [MultiConversationsSelect](interfaces/MultiConversationsSelect.md) -- [MultiExternalSelect](interfaces/MultiExternalSelect.md) -- [MultiStaticSelect](interfaces/MultiStaticSelect.md) -- [MultiUsersSelect](interfaces/MultiUsersSelect.md) -- [NumberInput](interfaces/NumberInput.md) -- [OptionGroup](interfaces/OptionGroup.md) -- [Overflow](interfaces/Overflow.md) -- [Placeholdable](interfaces/Placeholdable.md) -- [PlainTextElement](interfaces/PlainTextElement.md) -- [PlainTextInput](interfaces/PlainTextInput.md) -- [PlainTextOption](interfaces/PlainTextOption.md) -- [RadioButtons](interfaces/RadioButtons.md) -- [RichTextBlock](interfaces/RichTextBlock.md) -- [RichTextBorderable](interfaces/RichTextBorderable.md) -- [RichTextBroadcastMention](interfaces/RichTextBroadcastMention.md) -- [RichTextChannelMention](interfaces/RichTextChannelMention.md) -- [RichTextColor](interfaces/RichTextColor.md) -- [RichTextDate](interfaces/RichTextDate.md) -- [RichTextEmoji](interfaces/RichTextEmoji.md) -- [RichTextInput](interfaces/RichTextInput.md) -- [RichTextLink](interfaces/RichTextLink.md) -- [RichTextList](interfaces/RichTextList.md) -- [RichTextPreformatted](interfaces/RichTextPreformatted.md) -- [RichTextQuote](interfaces/RichTextQuote.md) -- [RichTextSection](interfaces/RichTextSection.md) -- [RichTextStyleable](interfaces/RichTextStyleable.md) -- [RichTextTeamMention](interfaces/RichTextTeamMention.md) -- [RichTextText](interfaces/RichTextText.md) -- [RichTextUserMention](interfaces/RichTextUserMention.md) -- [RichTextUsergroupMention](interfaces/RichTextUsergroupMention.md) -- [SectionBlock](interfaces/SectionBlock.md) -- [SelectOption](interfaces/SelectOption.md) -- [SlackFileImageObject](interfaces/SlackFileImageObject.md) -- [StaticSelect](interfaces/StaticSelect.md) -- [Timepicker](interfaces/Timepicker.md) -- [URLInput](interfaces/URLInput.md) -- [URLRespondable](interfaces/URLRespondable.md) -- [UrlImageObject](interfaces/UrlImageObject.md) -- [UsersSelect](interfaces/UsersSelect.md) -- [VideoBlock](interfaces/VideoBlock.md) -- [WorkflowButton](interfaces/WorkflowButton.md) -- [WorkflowStepView](interfaces/WorkflowStepView.md) - -## Type Aliases - -- [ActionsBlockElement](type-aliases/ActionsBlockElement.md) -- [AnyBlock](type-aliases/AnyBlock.md) -- [CallUser](type-aliases/CallUser.md) -- [ColorScheme](type-aliases/ColorScheme.md) -- [ContextBlockElement](type-aliases/ContextBlockElement.md) -- [ConversationFilter](type-aliases/ConversationFilter.md) -- [ConversationType](type-aliases/ConversationType.md) -- [ImageBlock](type-aliases/ImageBlock.md) -- [ImageElement](type-aliases/ImageElement.md) -- [InputBlockElement](type-aliases/InputBlockElement.md) -- [KnownBlock](type-aliases/KnownBlock.md) -- [MultiSelect](type-aliases/MultiSelect.md) -- [Option](type-aliases/Option.md) -- [RichTextBlockElement](type-aliases/RichTextBlockElement.md) -- [RichTextElement](type-aliases/RichTextElement.md) -- [SectionBlockAccessory](type-aliases/SectionBlockAccessory.md) -- [Select](type-aliases/Select.md) -- [SlackFile](type-aliases/SlackFile.md) -- [TextObject](type-aliases/TextObject.md) -- [View](type-aliases/View.md) diff --git a/docs/content/reference/types/interfaces/Action.md b/docs/content/reference/types/interfaces/Action.md deleted file mode 100644 index bd1ee6937..000000000 --- a/docs/content/reference/types/interfaces/Action.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: ~~Action~~ - -## Deprecated - -[Action](Action.md) aliased to [Actionable](Actionable.md) in order to name the mixins in this file consistently. - -## Extended by - -- [`Actionable`](Actionable.md) - -## Properties - -### ~~action\_id?~~ - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### ~~type~~ - -```ts -type: string; -``` - -#### Defined in - -[block-kit/extensions.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L9) diff --git a/docs/content/reference/types/interfaces/Actionable.md b/docs/content/reference/types/interfaces/Actionable.md deleted file mode 100644 index c0d4b154f..000000000 --- a/docs/content/reference/types/interfaces/Actionable.md +++ /dev/null @@ -1,71 +0,0 @@ -# Interface: ~~Actionable~~ - -## Deprecated - -[Action](Action.md) aliased to [Actionable](Actionable.md) in order to name the mixins in this file consistently. - -## Extends - -- [`Action`](Action.md) - -## Extended by - -- [`Button`](Button.md) -- [`Checkboxes`](Checkboxes.md) -- [`Datepicker`](Datepicker.md) -- [`DateTimepicker`](DateTimepicker.md) -- [`EmailInput`](EmailInput.md) -- [`FileInput`](FileInput.md) -- [`UsersSelect`](UsersSelect.md) -- [`MultiUsersSelect`](MultiUsersSelect.md) -- [`StaticSelect`](StaticSelect.md) -- [`MultiStaticSelect`](MultiStaticSelect.md) -- [`ConversationsSelect`](ConversationsSelect.md) -- [`MultiConversationsSelect`](MultiConversationsSelect.md) -- [`ChannelsSelect`](ChannelsSelect.md) -- [`MultiChannelsSelect`](MultiChannelsSelect.md) -- [`ExternalSelect`](ExternalSelect.md) -- [`MultiExternalSelect`](MultiExternalSelect.md) -- [`NumberInput`](NumberInput.md) -- [`Overflow`](Overflow.md) -- [`PlainTextInput`](PlainTextInput.md) -- [`RadioButtons`](RadioButtons.md) -- [`Timepicker`](Timepicker.md) -- [`URLInput`](URLInput.md) -- [`RichTextInput`](RichTextInput.md) - -## Properties - -### ~~action\_id?~~ - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Action`](Action.md).[`action_id`](Action.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### ~~type~~ - -```ts -type: string; -``` - -#### Inherited from - -[`Action`](Action.md).[`type`](Action.md#type) - -#### Defined in - -[block-kit/extensions.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L9) diff --git a/docs/content/reference/types/interfaces/ActionsBlock.md b/docs/content/reference/types/interfaces/ActionsBlock.md deleted file mode 100644 index bc0d72be5..000000000 --- a/docs/content/reference/types/interfaces/ActionsBlock.md +++ /dev/null @@ -1,74 +0,0 @@ -# Interface: ActionsBlock - -## Description - -Holds multiple interactive elements. - -## See - -[Actions block reference](https://api.slack.com/reference/block-kit/blocks#actions). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) - -*** - -### elements - -```ts -elements: ActionsBlockElement[]; -``` - -#### Description - -An array of InteractiveElements objects. -There is a maximum of 25 elements in each action block. - -#### Defined in - -[block-kit/blocks.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L80) - -*** - -### type - -```ts -type: "actions"; -``` - -#### Description - -The type of block. For an actions block, `type` is always `actions`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -[block-kit/blocks.ts:75](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L75) diff --git a/docs/content/reference/types/interfaces/Block.md b/docs/content/reference/types/interfaces/Block.md deleted file mode 100644 index a1b3ad885..000000000 --- a/docs/content/reference/types/interfaces/Block.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: Block - -## Extended by - -- [`ActionsBlock`](ActionsBlock.md) -- [`ContextBlock`](ContextBlock.md) -- [`DividerBlock`](DividerBlock.md) -- [`FileBlock`](FileBlock.md) -- [`HeaderBlock`](HeaderBlock.md) -- [`InputBlock`](InputBlock.md) -- [`RichTextBlock`](RichTextBlock.md) -- [`SectionBlock`](SectionBlock.md) -- [`VideoBlock`](VideoBlock.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Defined in - -[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) - -*** - -### type - -```ts -type: string; -``` - -#### Description - -The type of block. - -#### Defined in - -[block-kit/blocks.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L36) diff --git a/docs/content/reference/types/interfaces/Button.md b/docs/content/reference/types/interfaces/Button.md deleted file mode 100644 index b677c3277..000000000 --- a/docs/content/reference/types/interfaces/Button.md +++ /dev/null @@ -1,165 +0,0 @@ -# Interface: Button - -## Description - -Allows users a direct path to performing basic actions. - -## See - - - [Button element reference](https://api.slack.com/reference/block-kit/block-elements#button). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md) - -## Properties - -### accessibility\_label? - -```ts -optional accessibility_label: string; -``` - -#### Description - -A label for longer descriptive text about a button element. This label will be read out by screen -readers instead of the button `text` object. Maximum length for this field is 75 characters. - -#### Defined in - -[block-kit/block-elements.ts:63](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L63) - -*** - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### style? - -```ts -optional style: ColorScheme; -``` - -#### Description - -Decorates buttons with alternative visual color schemes. Use this option with restraint. -`primary` gives buttons a green outline and text, ideal for affirmation or confirmation actions. `primary` should -only be used for one button within a set. -`danger` gives buttons a red outline and text, and should be used when the action is destructive. Use `danger` even -more sparingly than primary. -If you don't include this field, the default button style will be used. - -#### Defined in - -[block-kit/block-elements.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L58) - -*** - -### text - -```ts -text: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) that defines the button's text. `text` may truncate with ~30 characters. -Maximum length for the text in this field is 75 characters. - -#### Defined in - -[block-kit/block-elements.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L38) - -*** - -### type - -```ts -type: "button"; -``` - -#### Description - -The type of element. In this case `type` is always `button`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L33) - -*** - -### url? - -```ts -optional url: string; -``` - -#### Description - -A URL to load in the user's browser when the button is clicked. Maximum length for this field is 3000 -characters. If you're using `url`, you'll still receive an [interaction payload](https://api.slack.com/interactivity/handling#payloads) -and will need to send an [acknowledgement response](https://api.slack.com/interactivity/handling#acknowledgment_response). - -#### Defined in - -[block-kit/block-elements.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L49) - -*** - -### value? - -```ts -optional value: string; -``` - -#### Description - -The value to send along with the [interaction payload](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 2000 characters. - -#### Defined in - -[block-kit/block-elements.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L43) diff --git a/docs/content/reference/types/interfaces/CallUserExternal.md b/docs/content/reference/types/interfaces/CallUserExternal.md deleted file mode 100644 index 0182a2f8d..000000000 --- a/docs/content/reference/types/interfaces/CallUserExternal.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: CallUserExternal - -## Properties - -### avatar\_url? - -```ts -optional avatar_url: string; -``` - -#### Description - -URL to an avatar image of the user. - -#### Defined in - -[calls.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/calls.ts#L30) - -*** - -### display\_name - -```ts -display_name: string; -``` - -#### Description - -Name of the user to be displayed in the Call block in a message. - -#### Defined in - -[calls.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/calls.ts#L26) - -*** - -### external\_id - -```ts -external_id: string; -``` - -#### Description - -A unique ID created by your app to represent your users. - -#### Defined in - -[calls.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/calls.ts#L22) diff --git a/docs/content/reference/types/interfaces/CallUserSlack.md b/docs/content/reference/types/interfaces/CallUserSlack.md deleted file mode 100644 index ad6df8881..000000000 --- a/docs/content/reference/types/interfaces/CallUserSlack.md +++ /dev/null @@ -1,18 +0,0 @@ -# Interface: CallUserSlack - -## Properties - -### slack\_id - -```ts -slack_id: string; -``` - -#### Description - -The Slack encoded user ID, e.g. U1234ABCD. Set this if you have it or know it, otherwise, set -`external_id` and `display_name`. - -#### Defined in - -[calls.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/calls.ts#L15) diff --git a/docs/content/reference/types/interfaces/ChannelsSelect.md b/docs/content/reference/types/interfaces/ChannelsSelect.md deleted file mode 100644 index 9fadc4e91..000000000 --- a/docs/content/reference/types/interfaces/ChannelsSelect.md +++ /dev/null @@ -1,158 +0,0 @@ -# Interface: ChannelsSelect - -## Description - -This select menu will populate its options with a list of public channels visible to the current user -in the active workspace. - -## See - - - [Select menu of public channels reference](https://api.slack.com/reference/block-kit/block-elements#channels_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md).[`URLRespondable`](URLRespondable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_channel? - -```ts -optional initial_channel: string; -``` - -#### Description - -The ID of any valid public channel to be pre-selected when the menu loads. - -#### Defined in - -[block-kit/block-elements.ts:448](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L448) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### response\_url\_enabled? - -```ts -optional response_url_enabled: boolean; -``` - -#### Description - -When set to `true`, the [`view_submission` payload](https://api.slack.com/reference/interaction-payloads/views#view_submission) -from the menu's parent view will contain a `response_url`. This `response_url` can be used for -[message responses](https://api.slack.com/interactivity/handling#message_responses). The target conversation -for the message will be determined by the value of this select menu. - -#### Inherited from - -[`URLRespondable`](URLRespondable.md).[`response_url_enabled`](URLRespondable.md#response_url_enabled) - -#### Defined in - -[block-kit/extensions.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L67) - -*** - -### type - -```ts -type: "channels_select"; -``` - -#### Description - -The type of element. In this case `type` is always `channels_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:444](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L444) diff --git a/docs/content/reference/types/interfaces/Checkboxes.md b/docs/content/reference/types/interfaces/Checkboxes.md deleted file mode 100644 index e644e385b..000000000 --- a/docs/content/reference/types/interfaces/Checkboxes.md +++ /dev/null @@ -1,130 +0,0 @@ -# Interface: Checkboxes - -## Description - -Allows users to choose multiple items from a list of options. - -## See - - - [Checkboxes element reference](https://api.slack.com/reference/block-kit/block-elements#checkboxes). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_options? - -```ts -optional initial_options: Option[]; -``` - -#### Description - -An array of [Option](../type-aliases/Option.md) objects that exactly matches one or more of the options within `options`. -These options will be selected when the checkbox group initially loads. - -#### Defined in - -[block-kit/block-elements.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L80) - -*** - -### options - -```ts -options: Option[]; -``` - -#### Description - -An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options are allowed. - -#### Defined in - -[block-kit/block-elements.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L84) - -*** - -### type - -```ts -type: "checkboxes"; -``` - -#### Description - -The type of element. In this case `type` is always `checkboxes`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:75](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L75) diff --git a/docs/content/reference/types/interfaces/Confirm.md b/docs/content/reference/types/interfaces/Confirm.md deleted file mode 100644 index e0b67389c..000000000 --- a/docs/content/reference/types/interfaces/Confirm.md +++ /dev/null @@ -1,104 +0,0 @@ -# Interface: ~~Confirm~~ - -## Deprecated - -[Confirm](Confirm.md) aliased to [ConfirmationDialog](ConfirmationDialog.md) in order to make the construct clearer -and line up terminology with api.slack.com. - -## Description - -Defines a dialog that adds a confirmation step to interactive elements. - -## See - -[Confirmation dialog object reference](https://api.slack.com/reference/block-kit/composition-objects#confirm). - -## Extended by - -- [`ConfirmationDialog`](ConfirmationDialog.md) - -## Properties - -### ~~confirm?~~ - -```ts -optional confirm: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that confirms the action. -Maximum length for the `text` in this field is 30 characters. - -#### Defined in - -[block-kit/composition-objects.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L34) - -*** - -### ~~deny?~~ - -```ts -optional deny: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that cancels the action. -Maximum length for the `text` in this field is 30 characters. - -#### Defined in - -[block-kit/composition-objects.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L39) - -*** - -### ~~style?~~ - -```ts -optional style: ColorScheme; -``` - -#### Description - -Defines the color scheme applied to the `confirm` button. A value of `danger` will display the button -with a red background on desktop, or red text on mobile. A value of `primary` will display the button with a green -background on desktop, or blue text on mobile. If this field is not provided, the default value will be `primary`. - -#### Defined in - -[block-kit/composition-objects.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L45) - -*** - -### ~~text~~ - -```ts -text: PlainTextElement | MrkdwnElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object that defines the explanatory text that appears in the confirm -dialog. Maximum length for the `text` in this field is 300 characters. - -#### Defined in - -[block-kit/composition-objects.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L29) - -*** - -### ~~title?~~ - -```ts -optional title: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object that defines the dialog's title. -Maximum length for this field is 100 characters. - -#### Defined in - -[block-kit/composition-objects.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L24) diff --git a/docs/content/reference/types/interfaces/Confirmable.md b/docs/content/reference/types/interfaces/Confirmable.md deleted file mode 100644 index 08bf4fa92..000000000 --- a/docs/content/reference/types/interfaces/Confirmable.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: Confirmable - -## Extended by - -- [`Button`](Button.md) -- [`Checkboxes`](Checkboxes.md) -- [`Datepicker`](Datepicker.md) -- [`DateTimepicker`](DateTimepicker.md) -- [`UsersSelect`](UsersSelect.md) -- [`MultiUsersSelect`](MultiUsersSelect.md) -- [`StaticSelect`](StaticSelect.md) -- [`MultiStaticSelect`](MultiStaticSelect.md) -- [`ConversationsSelect`](ConversationsSelect.md) -- [`MultiConversationsSelect`](MultiConversationsSelect.md) -- [`ChannelsSelect`](ChannelsSelect.md) -- [`MultiChannelsSelect`](MultiChannelsSelect.md) -- [`ExternalSelect`](ExternalSelect.md) -- [`MultiExternalSelect`](MultiExternalSelect.md) -- [`Overflow`](Overflow.md) -- [`RadioButtons`](RadioButtons.md) -- [`Timepicker`](Timepicker.md) -- [`WorkflowButton`](WorkflowButton.md) - -## Properties - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) diff --git a/docs/content/reference/types/interfaces/Confirmation.md b/docs/content/reference/types/interfaces/Confirmation.md deleted file mode 100644 index 8f959c3d5..000000000 --- a/docs/content/reference/types/interfaces/Confirmation.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: Confirmation - -## Properties - -### dismiss\_text? - -```ts -optional dismiss_text: string; -``` - -#### Defined in - -[message-attachments.ts:177](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L177) - -*** - -### ok\_text? - -```ts -optional ok_text: string; -``` - -#### Defined in - -[message-attachments.ts:178](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L178) - -*** - -### text - -```ts -text: string; -``` - -#### Defined in - -[message-attachments.ts:179](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L179) - -*** - -### title? - -```ts -optional title: string; -``` - -#### Defined in - -[message-attachments.ts:180](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L180) diff --git a/docs/content/reference/types/interfaces/ConfirmationDialog.md b/docs/content/reference/types/interfaces/ConfirmationDialog.md deleted file mode 100644 index 1cecde5dd..000000000 --- a/docs/content/reference/types/interfaces/ConfirmationDialog.md +++ /dev/null @@ -1,119 +0,0 @@ -# Interface: ConfirmationDialog - -## Description - -Defines a dialog that adds a confirmation step to interactive elements. - -## See - -[Confirmation dialog object reference](https://api.slack.com/reference/block-kit/composition-objects#confirm). - -## Extends - -- [`Confirm`](Confirm.md) - -## Properties - -### confirm? - -```ts -optional confirm: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that confirms the action. -Maximum length for the `text` in this field is 30 characters. - -#### Inherited from - -[`Confirm`](Confirm.md).[`confirm`](Confirm.md#confirm) - -#### Defined in - -[block-kit/composition-objects.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L34) - -*** - -### deny? - -```ts -optional deny: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that cancels the action. -Maximum length for the `text` in this field is 30 characters. - -#### Inherited from - -[`Confirm`](Confirm.md).[`deny`](Confirm.md#deny) - -#### Defined in - -[block-kit/composition-objects.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L39) - -*** - -### style? - -```ts -optional style: ColorScheme; -``` - -#### Description - -Defines the color scheme applied to the `confirm` button. A value of `danger` will display the button -with a red background on desktop, or red text on mobile. A value of `primary` will display the button with a green -background on desktop, or blue text on mobile. If this field is not provided, the default value will be `primary`. - -#### Inherited from - -[`Confirm`](Confirm.md).[`style`](Confirm.md#style) - -#### Defined in - -[block-kit/composition-objects.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L45) - -*** - -### text - -```ts -text: PlainTextElement | MrkdwnElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object that defines the explanatory text that appears in the confirm -dialog. Maximum length for the `text` in this field is 300 characters. - -#### Inherited from - -[`Confirm`](Confirm.md).[`text`](Confirm.md#text) - -#### Defined in - -[block-kit/composition-objects.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L29) - -*** - -### title? - -```ts -optional title: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object that defines the dialog's title. -Maximum length for this field is 100 characters. - -#### Inherited from - -[`Confirm`](Confirm.md).[`title`](Confirm.md#title) - -#### Defined in - -[block-kit/composition-objects.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L24) diff --git a/docs/content/reference/types/interfaces/ContextBlock.md b/docs/content/reference/types/interfaces/ContextBlock.md deleted file mode 100644 index 6164a2388..000000000 --- a/docs/content/reference/types/interfaces/ContextBlock.md +++ /dev/null @@ -1,74 +0,0 @@ -# Interface: ContextBlock - -## Description - -Displays contextual info, which can include both images and text. - -## See - -[Context block reference](https://api.slack.com/reference/block-kit/blocks#context). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) - -*** - -### elements - -```ts -elements: ContextBlockElement[]; -``` - -#### Description - -An array of [ImageElement](../type-aliases/ImageElement.md), [PlainTextElement](PlainTextElement.md) or [MrkdwnElement](MrkdwnElement.md) objects. -Maximum number of items is 10. - -#### Defined in - -[block-kit/blocks.ts:102](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L102) - -*** - -### type - -```ts -type: "context"; -``` - -#### Description - -The type of block. For a context block, `type` is always `context`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -[block-kit/blocks.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L97) diff --git a/docs/content/reference/types/interfaces/ConversationsSelect.md b/docs/content/reference/types/interfaces/ConversationsSelect.md deleted file mode 100644 index 60a626c91..000000000 --- a/docs/content/reference/types/interfaces/ConversationsSelect.md +++ /dev/null @@ -1,210 +0,0 @@ -# Interface: ConversationsSelect - -## Description - -This select menu will populate its options with a list of public and private channels, DMs, and MPIMs -visible to the current user in the active workspace. - -## See - - - [Select menu of conversations reference](https://api.slack.com/reference/block-kit/block-elements#conversations_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md).[`URLRespondable`](URLRespondable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### default\_to\_current\_conversation? - -```ts -optional default_to_current_conversation: boolean; -``` - -#### Description - -Pre-populates the select menu with the conversation that the user was viewing when they opened the -modal, if available. Default is `false`. - -#### Defined in - -[block-kit/block-elements.ts:377](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L377) - -*** - -### filter? - -```ts -optional filter: object; -``` - -#### exclude\_bot\_users? - -```ts -optional exclude_bot_users: boolean; -``` - -#### exclude\_external\_shared\_channels? - -```ts -optional exclude_external_shared_channels: boolean; -``` - -#### include? - -```ts -optional include: ("im" | "mpim" | "private" | "public")[]; -``` - -#### Description - -A filter object that reduces the list of available conversations using the specified criteria. - -#### Defined in - -[block-kit/block-elements.ts:381](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L381) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_conversation? - -```ts -optional initial_conversation: string; -``` - -#### Description - -The ID of any valid conversation to be pre-selected when the menu loads. If -`default_to_current_conversation` is also supplied, `initial_conversation` will take precedence. - -#### Defined in - -[block-kit/block-elements.ts:372](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L372) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### response\_url\_enabled? - -```ts -optional response_url_enabled: boolean; -``` - -#### Description - -When set to `true`, the [`view_submission` payload](https://api.slack.com/reference/interaction-payloads/views#view_submission) -from the menu's parent view will contain a `response_url`. This `response_url` can be used for -[message responses](https://api.slack.com/interactivity/handling#message_responses). The target conversation -for the message will be determined by the value of this select menu. - -#### Inherited from - -[`URLRespondable`](URLRespondable.md).[`response_url_enabled`](URLRespondable.md#response_url_enabled) - -#### Defined in - -[block-kit/extensions.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L67) - -*** - -### type - -```ts -type: "conversations_select"; -``` - -#### Description - -The type of element. In this case `type` is always `conversations_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:367](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L367) diff --git a/docs/content/reference/types/interfaces/DateTimepicker.md b/docs/content/reference/types/interfaces/DateTimepicker.md deleted file mode 100644 index 478003493..000000000 --- a/docs/content/reference/types/interfaces/DateTimepicker.md +++ /dev/null @@ -1,118 +0,0 @@ -# Interface: DateTimepicker - -## Description - -Allows users to select both a date and a time of day, formatted as a Unix timestamp. On desktop -clients, this time picker will take the form of a dropdown list and the date picker will take the form of a dropdown -calendar. Both options will have free-text entry for precise choices. On mobile clients, the time picker and date -picker will use native UIs. - -## See - - - [Datetime picker element reference](https://api.slack.com/reference/block-kit/block-elements#datetimepicker). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_date\_time? - -```ts -optional initial_date_time: number; -``` - -#### Description - -The initial date and time that is selected when the element is loaded, represented as a UNIX -timestamp in seconds. This should be in the format of 10 digits, for example `1628633820` represents the date and -time August 10th, 2021 at 03:17pm PST. - -#### Defined in - -[block-kit/block-elements.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L126) - -*** - -### type - -```ts -type: "datetimepicker"; -``` - -#### Description - -The type of element. In this case `type` is always `datetimepicker`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:120](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L120) diff --git a/docs/content/reference/types/interfaces/Datepicker.md b/docs/content/reference/types/interfaces/Datepicker.md deleted file mode 100644 index 27daa3695..000000000 --- a/docs/content/reference/types/interfaces/Datepicker.md +++ /dev/null @@ -1,135 +0,0 @@ -# Interface: Datepicker - -## Description - -Allows users to select a date from a calendar style UI. - -## See - - - [Date picker element reference](https://api.slack.com/reference/block-kit/block-elements#datepicker). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_date? - -```ts -optional initial_date: string; -``` - -#### Description - -The initial date that is selected when the element is loaded. -This should be in the format `YYYY-MM-DD`. - -#### Defined in - -[block-kit/block-elements.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L105) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "datepicker"; -``` - -#### Description - -The type of element. In this case `type` is always `datepicker`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L100) diff --git a/docs/content/reference/types/interfaces/Dialog.md b/docs/content/reference/types/interfaces/Dialog.md deleted file mode 100644 index dbfb40924..000000000 --- a/docs/content/reference/types/interfaces/Dialog.md +++ /dev/null @@ -1,79 +0,0 @@ -# Interface: ~~Dialog~~ - -Reusable shapes for argument values - -## Deprecated - -Dialogs are a deprecated surface in Slack. For more details on how to upgrade, check out our [Upgrading outmoded dialogs to modals guide](https://api.slack.com/block-kit/dialogs-to-modals). This will be removed in the next major version. - -## Properties - -### ~~callback\_id~~ - -```ts -callback_id: string; -``` - -#### Defined in - -[dialog.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L7) - -*** - -### ~~elements~~ - -```ts -elements: object[]; -``` - -#### Defined in - -[dialog.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L8) - -*** - -### ~~notify\_on\_cancel?~~ - -```ts -optional notify_on_cancel: boolean; -``` - -#### Defined in - -[dialog.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L31) - -*** - -### ~~state?~~ - -```ts -optional state: string; -``` - -#### Defined in - -[dialog.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L32) - -*** - -### ~~submit\_label?~~ - -```ts -optional submit_label: string; -``` - -#### Defined in - -[dialog.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L30) - -*** - -### ~~title~~ - -```ts -title: string; -``` - -#### Defined in - -[dialog.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L6) diff --git a/docs/content/reference/types/interfaces/DispatchActionConfig.md b/docs/content/reference/types/interfaces/DispatchActionConfig.md deleted file mode 100644 index 803ae38e3..000000000 --- a/docs/content/reference/types/interfaces/DispatchActionConfig.md +++ /dev/null @@ -1,30 +0,0 @@ -# Interface: DispatchActionConfig - -## Description - -Defines when a [PlainTextElement](PlainTextElement.md) will return a [`block_actions` interaction payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -## See - -[`block_actions` interaction payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -## Properties - -### trigger\_actions\_on? - -```ts -optional trigger_actions_on: ("on_enter_pressed" | "on_character_entered")[]; -``` - -#### Description - -An array of interaction types that you would like to receive a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions) for. Should be -one or both of: - `on_enter_pressed` — payload is dispatched when user presses the enter key while the input is in focus. Hint - text will appear underneath the input explaining to the user to press enter to submit. - `on_character_entered` — payload is dispatched when a character is entered (or removed) in the input. - -#### Defined in - -[block-kit/composition-objects.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L67) diff --git a/docs/content/reference/types/interfaces/Dispatchable.md b/docs/content/reference/types/interfaces/Dispatchable.md deleted file mode 100644 index 71d495076..000000000 --- a/docs/content/reference/types/interfaces/Dispatchable.md +++ /dev/null @@ -1,26 +0,0 @@ -# Interface: Dispatchable - -## Extended by - -- [`EmailInput`](EmailInput.md) -- [`NumberInput`](NumberInput.md) -- [`PlainTextInput`](PlainTextInput.md) -- [`URLInput`](URLInput.md) -- [`RichTextInput`](RichTextInput.md) - -## Properties - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Defined in - -[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) diff --git a/docs/content/reference/types/interfaces/DividerBlock.md b/docs/content/reference/types/interfaces/DividerBlock.md deleted file mode 100644 index 1c5143f28..000000000 --- a/docs/content/reference/types/interfaces/DividerBlock.md +++ /dev/null @@ -1,58 +0,0 @@ -# Interface: DividerBlock - -## Description - -Visually separates pieces of info inside of a message. A content divider, like an `
`, to split up -different blocks inside of a message. The divider block is nice and neat, requiring only a `type`. - -## See - -[Divider block reference](https://api.slack.com/reference/block-kit/blocks#divider). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) - -*** - -### type - -```ts -type: "divider"; -``` - -#### Description - -The type of block. For a divider block, `type` is always `divider`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -[block-kit/blocks.ts:114](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L114) diff --git a/docs/content/reference/types/interfaces/EmailInput.md b/docs/content/reference/types/interfaces/EmailInput.md deleted file mode 100644 index 2575bcb46..000000000 --- a/docs/content/reference/types/interfaces/EmailInput.md +++ /dev/null @@ -1,134 +0,0 @@ -# Interface: EmailInput - -## Description - -Allows user to enter an email into a single-line field. - -## See - - - [Email input element reference](https://api.slack.com/reference/block-kit/block-elements#email). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Inherited from - -[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) - -#### Defined in - -[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_value? - -```ts -optional initial_value: string; -``` - -#### Description - -The initial value in the email input when it is loaded. - -#### Defined in - -[block-kit/block-elements.ts:146](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L146) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "email_text_input"; -``` - -#### Description - -The type of element. In this case `type` is always `email_text_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:142](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L142) diff --git a/docs/content/reference/types/interfaces/ExternalSelect.md b/docs/content/reference/types/interfaces/ExternalSelect.md deleted file mode 100644 index f59494485..000000000 --- a/docs/content/reference/types/interfaces/ExternalSelect.md +++ /dev/null @@ -1,153 +0,0 @@ -# Interface: ExternalSelect - -## Description - -This select menu will load its options from an external data source, allowing for a dynamic list of -options. - -## See - - - [Select menu of external data source reference](https://api.slack.com/reference/block-kit/block-elements#external_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_option? - -```ts -optional initial_option: PlainTextOption; -``` - -#### Description - -A single option to be selected when the menu initially loads. - -#### Defined in - -[block-kit/block-elements.ts:493](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L493) - -*** - -### min\_query\_length? - -```ts -optional min_query_length: number; -``` - -#### Description - -When the typeahead field is used, a request will be sent on every character change. If you prefer -fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number -of typed characters required before dispatch. The default value is `3`. - -#### Defined in - -[block-kit/block-elements.ts:499](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L499) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "external_select"; -``` - -#### Description - -The type of element. In this case `type` is always `external_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:488](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L488) diff --git a/docs/content/reference/types/interfaces/FileBlock.md b/docs/content/reference/types/interfaces/FileBlock.md deleted file mode 100644 index 05db04a2e..000000000 --- a/docs/content/reference/types/interfaces/FileBlock.md +++ /dev/null @@ -1,92 +0,0 @@ -# Interface: FileBlock - -## Description - -Displays a [remote file](https://api.slack.com/messaging/files/remote). You can't add this block to -app surfaces directly, but it will show up when [retrieving messages](https://api.slack.com/messaging/retrieving) -that contain remote files. If you want to add remote files to messages, -[follow our guide](https://api.slack.com/messaging/files/remote). - -## See - -[File block reference](https://api.slack.com/reference/block-kit/blocks#file). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) - -*** - -### external\_id - -```ts -external_id: string; -``` - -#### Description - -The external unique ID for this file. - -#### Defined in - -[block-kit/blocks.ts:136](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L136) - -*** - -### source - -```ts -source: string; -``` - -#### Description - -At the moment, source will always be `remote` for a remote file. - -#### Defined in - -[block-kit/blocks.ts:132](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L132) - -*** - -### type - -```ts -type: "file"; -``` - -#### Description - -The type of block. For a file block, `type` is always `file`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -[block-kit/blocks.ts:128](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L128) diff --git a/docs/content/reference/types/interfaces/FileInput.md b/docs/content/reference/types/interfaces/FileInput.md deleted file mode 100644 index 833271a9e..000000000 --- a/docs/content/reference/types/interfaces/FileInput.md +++ /dev/null @@ -1,89 +0,0 @@ -# Interface: FileInput - -## Description - -Allows user to upload files. In order to use the `file_input` element within your app, -your app must have the `files:read` scope. - -## See - -[File input element reference](https://api.slack.com/reference/block-kit/block-elements#file_input). - -## Extends - -- [`Actionable`](Actionable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### filetypes? - -```ts -optional filetypes: string[]; -``` - -#### Description - -An array of valid [file extensions](https://api.slack.com/types/file#types) that will be accepted -for this element. All file extensions will be accepted if `filetypes` is not specified. This validation is provided -for convenience only, and you should perform your own file type validation based on what you expect to receive. - -#### Defined in - -[block-kit/block-elements.ts:164](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L164) - -*** - -### max\_files? - -```ts -optional max_files: number; -``` - -#### Description - -Maximum number of files that can be uploaded for this `file_input` element. Minimum of `1`, maximum of -`10`. Defaults to `10` if not specified. - -#### Defined in - -[block-kit/block-elements.ts:169](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L169) - -*** - -### type - -```ts -type: "file_input"; -``` - -#### Description - -The type of element. In this case `type` is always `file_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:158](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L158) diff --git a/docs/content/reference/types/interfaces/Focusable.md b/docs/content/reference/types/interfaces/Focusable.md deleted file mode 100644 index fac8198f5..000000000 --- a/docs/content/reference/types/interfaces/Focusable.md +++ /dev/null @@ -1,42 +0,0 @@ -# Interface: Focusable - -## Extended by - -- [`Checkboxes`](Checkboxes.md) -- [`Datepicker`](Datepicker.md) -- [`DateTimepicker`](DateTimepicker.md) -- [`EmailInput`](EmailInput.md) -- [`UsersSelect`](UsersSelect.md) -- [`MultiUsersSelect`](MultiUsersSelect.md) -- [`StaticSelect`](StaticSelect.md) -- [`MultiStaticSelect`](MultiStaticSelect.md) -- [`ConversationsSelect`](ConversationsSelect.md) -- [`MultiConversationsSelect`](MultiConversationsSelect.md) -- [`ChannelsSelect`](ChannelsSelect.md) -- [`MultiChannelsSelect`](MultiChannelsSelect.md) -- [`ExternalSelect`](ExternalSelect.md) -- [`MultiExternalSelect`](MultiExternalSelect.md) -- [`NumberInput`](NumberInput.md) -- [`PlainTextInput`](PlainTextInput.md) -- [`RadioButtons`](RadioButtons.md) -- [`Timepicker`](Timepicker.md) -- [`URLInput`](URLInput.md) -- [`RichTextInput`](RichTextInput.md) - -## Properties - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) diff --git a/docs/content/reference/types/interfaces/HeaderBlock.md b/docs/content/reference/types/interfaces/HeaderBlock.md deleted file mode 100644 index bbb9c30bc..000000000 --- a/docs/content/reference/types/interfaces/HeaderBlock.md +++ /dev/null @@ -1,75 +0,0 @@ -# Interface: HeaderBlock - -## Description - -Displays a larger-sized text block. A `header` is a plain-text block that displays in a larger, bold -font. Use it to delineate between different groups of content in your app's surfaces. - -## See - -[Header block reference](https://api.slack.com/reference/block-kit/blocks#header). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) - -*** - -### text - -```ts -text: PlainTextElement; -``` - -#### Description - -The text for the block, in the form of a [PlainTextElement](PlainTextElement.md). -Maximum length for the text in this field is 150 characters. - -#### Defined in - -[block-kit/blocks.ts:153](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L153) - -*** - -### type - -```ts -type: "header"; -``` - -#### Description - -The type of block. For a header block, `type` is always `header`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -[block-kit/blocks.ts:148](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L148) diff --git a/docs/content/reference/types/interfaces/HomeView.md b/docs/content/reference/types/interfaces/HomeView.md deleted file mode 100644 index 6d6318cd3..000000000 --- a/docs/content/reference/types/interfaces/HomeView.md +++ /dev/null @@ -1,109 +0,0 @@ -# Interface: HomeView - -## Extends - -- `BaseView` - -## Properties - -### blocks - -```ts -blocks: AnyBlock[]; -``` - -#### Description - -An array of [AnyBlock](../type-aliases/AnyBlock.md) that defines the content of the view. Max of 100 blocks. - -#### Inherited from - -`BaseView.blocks` - -#### Defined in - -[views.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L6) - -*** - -### callback\_id? - -```ts -optional callback_id: string; -``` - -#### Description - -An identifier to recognize interactions and submissions of this particular view. Don't use this to -store sensitive information (use `private_metadata` instead). Maximum length of 255 characters. - -#### See - -[Handling and responding to interactions](https://api.slack.com/surfaces/modals#interactions). - -#### Inherited from - -`BaseView.callback_id` - -#### Defined in - -[views.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L19) - -*** - -### external\_id? - -```ts -optional external_id: string; -``` - -#### Description - -A custom identifier that must be unique for all views on a per-team basis. - -#### Inherited from - -`BaseView.external_id` - -#### Defined in - -[views.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L21) - -*** - -### private\_metadata? - -```ts -optional private_metadata: string; -``` - -#### Description - -String that will be sent to your app in -[`view_submission`](https://api.slack.com/reference/interaction-payloads/views#view_submission) and -[`block_actions`](https://api.slack.com/reference/interaction-payloads/block-actions) events. -Maximum length of 3000 characters. - -#### Inherited from - -`BaseView.private_metadata` - -#### Defined in - -[views.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L13) - -*** - -### type - -```ts -type: "home"; -``` - -#### Description - -The type of view. Set to `home` for Home tabs. - -#### Defined in - -[views.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L27) diff --git a/docs/content/reference/types/interfaces/InputBlock.md b/docs/content/reference/types/interfaces/InputBlock.md deleted file mode 100644 index ca33952ca..000000000 --- a/docs/content/reference/types/interfaces/InputBlock.md +++ /dev/null @@ -1,143 +0,0 @@ -# Interface: InputBlock - -## Description - -Collects information from users via block elements. - -## See - - - [Input block reference](https://api.slack.com/reference/block-kit/blocks#input). - - [Collecting input in modals guide](https://api.slack.com/surfaces/modals#gathering_input). - - [Collecting input in Home tabs guide](https://api.slack.com/surfaces/app-home#gathering_input). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) - -*** - -### dispatch\_action? - -```ts -optional dispatch_action: boolean; -``` - -#### Description - -A boolean that indicates whether or not the use of elements in this block should dispatch a -[block_actions payload](https://api.slack.com/reference/interaction-payloads/block-actions). Defaults to `false`. - -#### Defined in - -[block-kit/blocks.ts:218](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L218) - -*** - -### element - -```ts -element: InputBlockElement; -``` - -#### Description - -A block element. - -#### Defined in - -[block-kit/blocks.ts:213](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L213) - -*** - -### hint? - -```ts -optional hint: PlainTextElement; -``` - -#### Description - -An optional hint that appears below an input element in a lighter grey. It must be a -[object](PlainTextElement.md). Maximum length for the `text` in this field is 2000 characters. - -#### Defined in - -[block-kit/blocks.ts:204](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L204) - -*** - -### label - -```ts -label: PlainTextElement; -``` - -#### Description - -A label that appears above an input element in the form of a [PlainTextElement](PlainTextElement.md) object. -Maximum length for the text in this field is 2000 characters. - -#### Defined in - -[block-kit/blocks.ts:199](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L199) - -*** - -### optional? - -```ts -optional optional: boolean; -``` - -#### Description - -A boolean that indicates whether the input element may be empty when a user submits the modal. -Defaults to `false`. - -#### Defined in - -[block-kit/blocks.ts:209](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L209) - -*** - -### type - -```ts -type: "input"; -``` - -#### Description - -The type of block. For an input block, `type` is always `input`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -[block-kit/blocks.ts:194](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L194) diff --git a/docs/content/reference/types/interfaces/LinkUnfurls.md b/docs/content/reference/types/interfaces/LinkUnfurls.md deleted file mode 100644 index d041ae784..000000000 --- a/docs/content/reference/types/interfaces/LinkUnfurls.md +++ /dev/null @@ -1,5 +0,0 @@ -# Interface: LinkUnfurls - -## Indexable - - \[`linkUrl`: `string`\]: [`MessageAttachment`](MessageAttachment.md) diff --git a/docs/content/reference/types/interfaces/MaxItemsSelectable.md b/docs/content/reference/types/interfaces/MaxItemsSelectable.md deleted file mode 100644 index ab49365c4..000000000 --- a/docs/content/reference/types/interfaces/MaxItemsSelectable.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: MaxItemsSelectable - -## Extended by - -- [`MultiUsersSelect`](MultiUsersSelect.md) -- [`MultiStaticSelect`](MultiStaticSelect.md) -- [`MultiConversationsSelect`](MultiConversationsSelect.md) -- [`MultiChannelsSelect`](MultiChannelsSelect.md) -- [`MultiExternalSelect`](MultiExternalSelect.md) - -## Properties - -### max\_selected\_items? - -```ts -optional max_selected_items: number; -``` - -#### Description - -Specifies the maximum number of items that can be selected. Minimum number is 1. - -#### Defined in - -[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) diff --git a/docs/content/reference/types/interfaces/MessageAttachment.md b/docs/content/reference/types/interfaces/MessageAttachment.md deleted file mode 100644 index 4585932f5..000000000 --- a/docs/content/reference/types/interfaces/MessageAttachment.md +++ /dev/null @@ -1,401 +0,0 @@ -# Interface: MessageAttachment - -Add [secondary attachments](https://api.slack.com/messaging/composing/layouts#attachments) to your messages in Slack. -Message attachments are considered a legacy part of messaging functionality. They are not deprecated per se, but they may change in the future, in ways that reduce their visibility or utility. We recommend moving to Block Kit instead. Read more about [when to use message attachments](https://api.slack.com/messaging/composing/layouts#when-to-use-attachments). - -## See - -[Secondary message attachments reference documentation](https://api.slack.com/reference/messaging/attachments) - -## Properties - -### actions? - -```ts -optional actions: AttachmentAction[]; -``` - -#### Defined in - -[message-attachments.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L105) - -*** - -### app\_id? - -```ts -optional app_id: string; -``` - -#### Defined in - -[message-attachments.ts:115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L115) - -*** - -### app\_unfurl\_url? - -```ts -optional app_unfurl_url: string; -``` - -#### Defined in - -[message-attachments.ts:113](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L113) - -*** - -### author\_icon? - -```ts -optional author_icon: string; -``` - -#### Description - -A valid URL that displays a small 16px by 16px image to the left of the `author_name` text. -Will only work if `author_name` is present. - -#### Defined in - -[message-attachments.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L49) - -*** - -### author\_link? - -```ts -optional author_link: string; -``` - -#### Description - -A valid URL that will hyperlink the `author_name` text. Will only work if `author_name` is present. - -#### Defined in - -[message-attachments.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L44) - -*** - -### author\_name? - -```ts -optional author_name: string; -``` - -#### Description - -Small text used to display the author's name. - -#### Defined in - -[message-attachments.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L40) - -*** - -### author\_subname? - -```ts -optional author_subname: string; -``` - -#### Defined in - -[message-attachments.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L50) - -*** - -### blocks? - -```ts -optional blocks: AnyBlock[]; -``` - -#### Description - -An array of [layout blocks](../type-aliases/KnownBlock.md) in the same format -[as described in the building blocks guide](https://api.slack.com/block-kit/building). - -#### Defined in - -[message-attachments.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L21) - -*** - -### bot\_id? - -```ts -optional bot_id: string; -``` - -#### Defined in - -[message-attachments.ts:116](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L116) - -*** - -### callback\_id? - -```ts -optional callback_id: string; -``` - -#### Defined in - -[message-attachments.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L106) - -*** - -### color? - -```ts -optional color: string; -``` - -#### Description - -Changes the color of the border on the left side of this attachment from the default gray. Can either -be one of `good` (green), `warning` (yellow), `danger` (red), or any hex color code (eg. `#439FE0`) - -#### Defined in - -[message-attachments.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L31) - -*** - -### fallback? - -```ts -optional fallback: string; -``` - -#### Description - -A plain text summary of the attachment used in clients that -don't show formatted text (e.g. mobile notifications). - -#### Defined in - -[message-attachments.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L26) - -*** - -### fields? - -```ts -optional fields: MessageAttachmentField[]; -``` - -#### Description - -An array of [MessageAttachmentField](MessageAttachmentField.md) that get displayed in a table-like way -(see [this example](https://api.slack.com/reference/messaging/attachments#example)). -For best results, include no more than 2-3 field objects. - -#### Defined in - -[message-attachments.ts:71](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L71) - -*** - -### footer? - -```ts -optional footer: string; -``` - -#### Description - -Some brief text to help contextualize and identify an attachment. Limited to 300 characters, -and may be truncated further when displayed to users in environments with limited screen real estate. - -#### Defined in - -[message-attachments.ts:91](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L91) - -*** - -### footer\_icon? - -```ts -optional footer_icon: string; -``` - -#### Description - -A valid URL to an image file that will be displayed beside the `footer` text. -Will only work if `footer` is present. We'll render what you provide at 16px by 16px. -It's best to use an image that is similarly sized. - -#### Defined in - -[message-attachments.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L97) - -*** - -### image\_url? - -```ts -optional image_url: string; -``` - -#### Description - -A valid URL to an image file that will be displayed at the bottom of the attachment. -We support GIF, JPEG, PNG, and BMP formats. -Large images will be resized to a maximum width of 360px or a maximum height of 500px, while still -maintaining the original aspect ratio. Cannot be used with `thumb_url`. - -#### Defined in - -[message-attachments.ts:78](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L78) - -*** - -### is\_app\_unfurl? - -```ts -optional is_app_unfurl: boolean; -``` - -#### Defined in - -[message-attachments.ts:114](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L114) - -*** - -### mrkdwn\_in? - -```ts -optional mrkdwn_in: ("text" | "pretext" | "fields")[]; -``` - -#### Description - -Field names that should be [formatted by `mrkdwn` syntax](https://api.slack.com/reference/surfaces/formatting#basics). -The fields that can be formatted in this way include the names of the `fields` property, or -the `text` or `pretext` properties. - -#### Defined in - -[message-attachments.ts:112](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L112) - -*** - -### pretext? - -```ts -optional pretext: string; -``` - -#### Description - -Text that appears above the message attachment block. It can be formatted as plain text, -or with [`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by including it in the `mrkdwn_in` field. - -#### Defined in - -[message-attachments.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L36) - -*** - -### preview? - -```ts -optional preview: MessageAttachmentPreview; -``` - -#### Defined in - -[message-attachments.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L117) - -*** - -### text? - -```ts -optional text: string; -``` - -#### Description - -The main body text of the attachment. It can be formatted as plain text, or with -[`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by including it in the `mrkdwn_in` field. -The content will automatically collapse if it contains 700+ characters or 5+ line breaks, and will display -a "Show more..." link to expand the content. - -#### Defined in - -[message-attachments.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L65) - -*** - -### thumb\_url? - -```ts -optional thumb_url: string; -``` - -#### Description - -A valid URL to an image file that will be displayed as a thumbnail on the right side of -a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP. -The thumbnail's longest dimension will be scaled down to 75px while maintaining the aspect ratio of the image. -The file size of the image must also be less than 500 KB. -For best results, please use images that are already 75px by 75px. - -#### Defined in - -[message-attachments.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L86) - -*** - -### title? - -```ts -optional title: string; -``` - -#### Description - -Large title text near the top of the attachment. - -#### Defined in - -[message-attachments.ts:54](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L54) - -*** - -### title\_link? - -```ts -optional title_link: string; -``` - -#### Description - -A valid URL that turns the `title` text into a hyperlink. - -#### Defined in - -[message-attachments.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L58) - -*** - -### ts? - -```ts -optional ts: string; -``` - -#### Description - -A Unix timestamp that is used to relate your attachment to a specific time. -The attachment will display the additional timestamp value as part of the attachment's footer. -Your message's timestamp will be displayed in varying ways, depending on how far in the past or future it is, -relative to the present. Form factors, like mobile versus desktop may also transform its rendered appearance. - -#### Defined in - -[message-attachments.ts:104](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L104) diff --git a/docs/content/reference/types/interfaces/MessageAttachmentField.md b/docs/content/reference/types/interfaces/MessageAttachmentField.md deleted file mode 100644 index 64fd7e461..000000000 --- a/docs/content/reference/types/interfaces/MessageAttachmentField.md +++ /dev/null @@ -1,59 +0,0 @@ -# Interface: MessageAttachmentField - -## Description - -A field object to include in a [MessageAttachment](MessageAttachment.md). - -## See - -[Field objects reference](https://api.slack.com/reference/messaging/attachments#field_objects). - -## Properties - -### short? - -```ts -optional short: boolean; -``` - -#### Description - -Indicates whether the field object is short enough to be displayed side-by-side with -other field objects. Defaults to `false`. - -#### Defined in - -[message-attachments.ts:138](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L138) - -*** - -### title - -```ts -title: string; -``` - -#### Description - -Shown as a bold heading displayed in the field object. It cannot contain markup and -will be escaped for you. - -#### Defined in - -[message-attachments.ts:129](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L129) - -*** - -### value - -```ts -value: string; -``` - -#### Description - -The text value displayed in the field object. It can be formatted as plain text, or with [`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by using the `mrkdwn_in` option of [MessageAttachment](MessageAttachment.md). - -#### Defined in - -[message-attachments.ts:133](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-attachments.ts#L133) diff --git a/docs/content/reference/types/interfaces/MessageMetadata.md b/docs/content/reference/types/interfaces/MessageMetadata.md deleted file mode 100644 index 26a7a902b..000000000 --- a/docs/content/reference/types/interfaces/MessageMetadata.md +++ /dev/null @@ -1,52 +0,0 @@ -# Interface: MessageMetadata - -## Description - -Application-specific data to attach to Slack message. - -## See - - - [Using Metadata](https://api.slack.com/metadata/using) - - [Metadata Payload Structure](https://api.slack.com/reference/metadata#payload_structure) - -## Properties - -### event\_payload - -```ts -event_payload: object; -``` - -#### Index Signature - - \[`key`: `string`\]: - \| `string` - \| `number` - \| `boolean` - \| [`MessageMetadataEventPayloadObject`](MessageMetadataEventPayloadObject.md) - \| [`MessageMetadataEventPayloadObject`](MessageMetadataEventPayloadObject.md)[] - -#### Description - -A free-form object containing whatever data your application wishes to attach to messages. - -#### Defined in - -[message-metadata.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L15) - -*** - -### event\_type - -```ts -event_type: string; -``` - -#### Description - -A human readable alphanumeric string representing your application's metadata event. -The value of this field may appear in the UI to developers. - -#### Defined in - -[message-metadata.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/message-metadata.ts#L11) diff --git a/docs/content/reference/types/interfaces/MessageMetadataEventPayloadObject.md b/docs/content/reference/types/interfaces/MessageMetadataEventPayloadObject.md deleted file mode 100644 index fa6b94c30..000000000 --- a/docs/content/reference/types/interfaces/MessageMetadataEventPayloadObject.md +++ /dev/null @@ -1,5 +0,0 @@ -# Interface: MessageMetadataEventPayloadObject - -## Indexable - - \[`key`: `string`\]: `string` \| `number` \| `boolean` diff --git a/docs/content/reference/types/interfaces/ModalView.md b/docs/content/reference/types/interfaces/ModalView.md deleted file mode 100644 index 99053f1ad..000000000 --- a/docs/content/reference/types/interfaces/ModalView.md +++ /dev/null @@ -1,196 +0,0 @@ -# Interface: ModalView - -## Extends - -- `BaseView` - -## Properties - -### blocks - -```ts -blocks: AnyBlock[]; -``` - -#### Description - -An array of [AnyBlock](../type-aliases/AnyBlock.md) that defines the content of the view. Max of 100 blocks. - -#### Inherited from - -`BaseView.blocks` - -#### Defined in - -[views.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L6) - -*** - -### callback\_id? - -```ts -optional callback_id: string; -``` - -#### Description - -An identifier to recognize interactions and submissions of this particular view. Don't use this to -store sensitive information (use `private_metadata` instead). Maximum length of 255 characters. - -#### See - -[Handling and responding to interactions](https://api.slack.com/surfaces/modals#interactions). - -#### Inherited from - -`BaseView.callback_id` - -#### Defined in - -[views.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L19) - -*** - -### clear\_on\_close? - -```ts -optional clear_on_close: boolean; -``` - -#### Description - -When set to `true`, clicking on the close button will clear all views in a modal and close it. -Defaults to `false`. - -#### Defined in - -[views.ts:54](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L54) - -*** - -### close? - -```ts -optional close: PlainTextElement; -``` - -#### Description - -An optional [PlainTextElement](PlainTextElement.md) that defines the text displayed in the close button at the -bottom-right of the view. Maximum length of 24 characters. - -#### Defined in - -[views.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L43) - -*** - -### external\_id? - -```ts -optional external_id: string; -``` - -#### Description - -A custom identifier that must be unique for all views on a per-team basis. - -#### Inherited from - -`BaseView.external_id` - -#### Defined in - -[views.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L21) - -*** - -### notify\_on\_close? - -```ts -optional notify_on_close: boolean; -``` - -#### Description - -Indicates whether Slack will send your app a -[`view_closed`](https://api.slack.com/reference/interaction-payloads/views#view_closed) event when a user -clicks the close button. Defaults to `false`. - -#### Defined in - -[views.ts:60](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L60) - -*** - -### private\_metadata? - -```ts -optional private_metadata: string; -``` - -#### Description - -String that will be sent to your app in -[`view_submission`](https://api.slack.com/reference/interaction-payloads/views#view_submission) and -[`block_actions`](https://api.slack.com/reference/interaction-payloads/block-actions) events. -Maximum length of 3000 characters. - -#### Inherited from - -`BaseView.private_metadata` - -#### Defined in - -[views.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L13) - -*** - -### submit? - -```ts -optional submit: PlainTextElement; -``` - -#### Description - -An optional [PlainTextElement](PlainTextElement.md) that defines the text displayed in the submit button at the -bottom-right of the view. `submit` is required when an input block is within the `blocks` array. Max length of 24 -characters. - -#### Defined in - -[views.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L49) - -*** - -### title - -```ts -title: PlainTextElement; -``` - -#### Description - -The title that appears in the top-left of the modal. Must be a [PlainTextElement](PlainTextElement.md) with a -maximum length of 24 characters. - -#### Defined in - -[views.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L38) - -*** - -### type - -```ts -type: "modal"; -``` - -#### Description - -The type of view. Set to `modal` for modals. - -#### Defined in - -[views.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L33) diff --git a/docs/content/reference/types/interfaces/MrkdwnElement.md b/docs/content/reference/types/interfaces/MrkdwnElement.md deleted file mode 100644 index 4b90e8608..000000000 --- a/docs/content/reference/types/interfaces/MrkdwnElement.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: MrkdwnElement - -## Description - -Defines an object containing some text. - -## See - -[Text object reference](https://api.slack.com/reference/block-kit/composition-objects#text). - -## Properties - -### text - -```ts -text: string; -``` - -#### Description - -The text for the block. This field accepts any of the standard text formatting markup. -The minimum length is 1 and maximum length is 3000 characters. - -#### Defined in - -[block-kit/composition-objects.ts:166](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L166) - -*** - -### type - -```ts -type: "mrkdwn"; -``` - -#### Description - -The formatting to use for this text object. - -#### Defined in - -[block-kit/composition-objects.ts:161](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L161) - -*** - -### verbatim? - -```ts -optional verbatim: boolean; -``` - -#### Description - -When set to `false` (as is default) URLs will be auto-converted into links, conversation names will -be link-ified, and certain mentions will be [automatically parsed](https://api.slack.com/reference/surfaces/formatting#automatic-parsing). -Using a value of `true` will skip any preprocessing of this nature, although you can still include -[manual parsing strings](https://api.slack.com/reference/surfaces/formatting#advanced). - -#### Defined in - -[block-kit/composition-objects.ts:173](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L173) diff --git a/docs/content/reference/types/interfaces/MrkdwnOption.md b/docs/content/reference/types/interfaces/MrkdwnOption.md deleted file mode 100644 index ab6216f66..000000000 --- a/docs/content/reference/types/interfaces/MrkdwnOption.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: MrkdwnOption - -## Extends - -- `OptionDescriptor` - -## Properties - -### description? - -```ts -optional description: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) that defines a line of descriptive text shown below the `text` field. -Maximum length for the `text` within this field is 75 characters. - -#### Inherited from - -`OptionDescriptor.description` - -#### Defined in - -[block-kit/composition-objects.ts:85](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L85) - -*** - -### text - -```ts -text: MrkdwnElement; -``` - -#### Description - -A [MrkdwnElement](MrkdwnElement.md) that defines the text shown in the option on the menu. To be used with -radio buttons and checkboxes. Maximum length for the `text` in this field is 75 characters. - -#### Defined in - -[block-kit/composition-objects.ts:93](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L93) - -*** - -### url? - -```ts -optional url: string; -``` - -#### Description - -Only available in overflow menus! A URL to load in the user's browser when the option is clicked. -Maximum length for this field is 3000 characters. - -#### Inherited from - -`OptionDescriptor.url` - -#### Defined in - -[block-kit/composition-objects.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L80) - -*** - -### value? - -```ts -optional value: string; -``` - -#### Description - -A unique string value that will be passed to your app when this option is chosen. -Maximum length for this field is 75 characters. - -#### Inherited from - -`OptionDescriptor.value` - -#### Defined in - -[block-kit/composition-objects.ts:75](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L75) diff --git a/docs/content/reference/types/interfaces/MultiChannelsSelect.md b/docs/content/reference/types/interfaces/MultiChannelsSelect.md deleted file mode 100644 index 3d393347e..000000000 --- a/docs/content/reference/types/interfaces/MultiChannelsSelect.md +++ /dev/null @@ -1,155 +0,0 @@ -# Interface: MultiChannelsSelect - -## Description - -This multi-select menu will populate its options with a list of public channels visible to the current -user in the active workspace. - -## See - - - [Multi-select menu of public channels reference](https://api.slack.com/reference/block-kit/block-elements#channel_multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`MaxItemsSelectable`](MaxItemsSelectable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_channels? - -```ts -optional initial_channels: string[]; -``` - -#### Description - -An array of one or more IDs of any valid public channel to be pre-selected when the menu loads. - -#### Defined in - -[block-kit/block-elements.ts:471](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L471) - -*** - -### max\_selected\_items? - -```ts -optional max_selected_items: number; -``` - -#### Description - -Specifies the maximum number of items that can be selected. Minimum number is 1. - -#### Inherited from - -[`MaxItemsSelectable`](MaxItemsSelectable.md).[`max_selected_items`](MaxItemsSelectable.md#max_selected_items) - -#### Defined in - -[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "multi_channels_select"; -``` - -#### Description - -The type of element. In this case `type` is always `multi_channels_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:466](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L466) diff --git a/docs/content/reference/types/interfaces/MultiConversationsSelect.md b/docs/content/reference/types/interfaces/MultiConversationsSelect.md deleted file mode 100644 index e2286c567..000000000 --- a/docs/content/reference/types/interfaces/MultiConversationsSelect.md +++ /dev/null @@ -1,207 +0,0 @@ -# Interface: MultiConversationsSelect - -## Description - -This multi-select menu will populate its options with a list of public and private channels, DMs, and -MPIMs visible to the current user in the active workspace. - -## See - - - [Multi-select menu of conversations reference](https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`MaxItemsSelectable`](MaxItemsSelectable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### default\_to\_current\_conversation? - -```ts -optional default_to_current_conversation: boolean; -``` - -#### Description - -Pre-populates the select menu with the conversation that the user was viewing when they opened the -modal, if available. Default is `false`. - -#### Defined in - -[block-kit/block-elements.ts:417](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L417) - -*** - -### filter? - -```ts -optional filter: object; -``` - -#### exclude\_bot\_users? - -```ts -optional exclude_bot_users: boolean; -``` - -#### exclude\_external\_shared\_channels? - -```ts -optional exclude_external_shared_channels: boolean; -``` - -#### include? - -```ts -optional include: ("im" | "mpim" | "private" | "public")[]; -``` - -#### Description - -A filter object that reduces the list of available conversations using the specified criteria. - -#### Defined in - -[block-kit/block-elements.ts:421](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L421) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_conversations? - -```ts -optional initial_conversations: string[]; -``` - -#### Description - -An array of one or more IDs of any valid conversations to be pre-selected when the menu loads. If -`default_to_current_conversation` is also supplied, `initial_conversation` will be ignored. - -#### Defined in - -[block-kit/block-elements.ts:412](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L412) - -*** - -### max\_selected\_items? - -```ts -optional max_selected_items: number; -``` - -#### Description - -Specifies the maximum number of items that can be selected. Minimum number is 1. - -#### Inherited from - -[`MaxItemsSelectable`](MaxItemsSelectable.md).[`max_selected_items`](MaxItemsSelectable.md#max_selected_items) - -#### Defined in - -[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "multi_conversations_select"; -``` - -#### Description - -The type of element. In this case `type` is always `conversations_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:406](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L406) diff --git a/docs/content/reference/types/interfaces/MultiExternalSelect.md b/docs/content/reference/types/interfaces/MultiExternalSelect.md deleted file mode 100644 index 9872bc56f..000000000 --- a/docs/content/reference/types/interfaces/MultiExternalSelect.md +++ /dev/null @@ -1,172 +0,0 @@ -# Interface: MultiExternalSelect - -## Description - -This menu will load its options from an external data source, allowing for a dynamic list of options. - -## See - - - [Multi-select menu of external data source reference](https://api.slack.com/reference/block-kit/block-elements#external_multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`MaxItemsSelectable`](MaxItemsSelectable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_options? - -```ts -optional initial_options: PlainTextOption[]; -``` - -#### Description - -An array of options to be selected when the menu initially loads. - -#### Defined in - -[block-kit/block-elements.ts:521](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L521) - -*** - -### max\_selected\_items? - -```ts -optional max_selected_items: number; -``` - -#### Description - -Specifies the maximum number of items that can be selected. Minimum number is 1. - -#### Inherited from - -[`MaxItemsSelectable`](MaxItemsSelectable.md).[`max_selected_items`](MaxItemsSelectable.md#max_selected_items) - -#### Defined in - -[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) - -*** - -### min\_query\_length? - -```ts -optional min_query_length: number; -``` - -#### Description - -When the typeahead field is used, a request will be sent on every character change. If you prefer -fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number -of typed characters required before dispatch. The default value is `3`. - -#### Defined in - -[block-kit/block-elements.ts:527](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L527) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "multi_external_select"; -``` - -#### Description - -The type of element. In this case `type` is always `multi_external_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:516](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L516) diff --git a/docs/content/reference/types/interfaces/MultiStaticSelect.md b/docs/content/reference/types/interfaces/MultiStaticSelect.md deleted file mode 100644 index a073f7189..000000000 --- a/docs/content/reference/types/interfaces/MultiStaticSelect.md +++ /dev/null @@ -1,190 +0,0 @@ -# Interface: MultiStaticSelect - -## Description - -This is the simplest form of select menu, with a static list of options passed in when defining the -element. - -## See - - - [Multi-select menu of static options reference](https://api.slack.com/reference/block-kit/block-elements#static_multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`MaxItemsSelectable`](MaxItemsSelectable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_options? - -```ts -optional initial_options: PlainTextOption[]; -``` - -#### Description - -An array of option objects that exactly match one or more of the options within `options` or -`option_groups`. These options will be selected when the menu initially loads. - -#### Defined in - -[block-kit/block-elements.ts:331](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L331) - -*** - -### max\_selected\_items? - -```ts -optional max_selected_items: number; -``` - -#### Description - -Specifies the maximum number of items that can be selected. Minimum number is 1. - -#### Inherited from - -[`MaxItemsSelectable`](MaxItemsSelectable.md).[`max_selected_items`](MaxItemsSelectable.md#max_selected_items) - -#### Defined in - -[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) - -*** - -### option\_groups? - -```ts -optional option_groups: object[]; -``` - -#### Description - -An array of option group objects. Maximum number of option groups is 100. If `options` is specified, -this field should not be. - -#### Defined in - -[block-kit/block-elements.ts:346](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L346) - -*** - -### options? - -```ts -optional options: PlainTextOption[]; -``` - -#### Description - -An array of [PlainTextOption](PlainTextOption.md). Maximum number of options is 100. If `option_groups` is -specified, this field should not be. - -#### Defined in - -[block-kit/block-elements.ts:338](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L338) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "multi_static_select"; -``` - -#### Description - -The type of element. In this case `type` is always `multi_static_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:325](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L325) diff --git a/docs/content/reference/types/interfaces/MultiUsersSelect.md b/docs/content/reference/types/interfaces/MultiUsersSelect.md deleted file mode 100644 index 3bb63f9b9..000000000 --- a/docs/content/reference/types/interfaces/MultiUsersSelect.md +++ /dev/null @@ -1,155 +0,0 @@ -# Interface: MultiUsersSelect - -## Description - -This multi-select menu will populate its options with a list of Slack users visible to the current user -in the active workspace. - -## See - - - [Multi-select menu of users reference](https://api.slack.com/reference/block-kit/block-elements#users_multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`MaxItemsSelectable`](MaxItemsSelectable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_users? - -```ts -optional initial_users: string[]; -``` - -#### Description - -An array of user IDs of any valid users to be pre-selected when the menu loads. - -#### Defined in - -[block-kit/block-elements.ts:266](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L266) - -*** - -### max\_selected\_items? - -```ts -optional max_selected_items: number; -``` - -#### Description - -Specifies the maximum number of items that can be selected. Minimum number is 1. - -#### Inherited from - -[`MaxItemsSelectable`](MaxItemsSelectable.md).[`max_selected_items`](MaxItemsSelectable.md#max_selected_items) - -#### Defined in - -[block-kit/extensions.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L49) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "multi_users_select"; -``` - -#### Description - -The type of element. In this case `type` is always `multi_users_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:262](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L262) diff --git a/docs/content/reference/types/interfaces/NumberInput.md b/docs/content/reference/types/interfaces/NumberInput.md deleted file mode 100644 index c7eea927f..000000000 --- a/docs/content/reference/types/interfaces/NumberInput.md +++ /dev/null @@ -1,184 +0,0 @@ -# Interface: NumberInput - -## Description - -Allows user to enter a number into a single-line field. The number input element accepts both whole and -decimal numbers. For example, 0.25, 5.5, and -10 are all valid input values. Decimal numbers are only allowed when -`is_decimal_allowed` is equal to `true`. - -## See - - - [Number input element reference](https://api.slack.com/reference/block-kit/block-elements#number). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Inherited from - -[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) - -#### Defined in - -[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_value? - -```ts -optional initial_value: string; -``` - -#### Description - -The initial value in the input when it is loaded. - -#### Defined in - -[block-kit/block-elements.ts:557](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L557) - -*** - -### is\_decimal\_allowed - -```ts -is_decimal_allowed: boolean; -``` - -#### Description - -Decimal numbers are allowed if this property is `true`, set the value to `false` otherwise. - -#### Defined in - -[block-kit/block-elements.ts:553](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L553) - -*** - -### max\_value? - -```ts -optional max_value: string; -``` - -#### Description - -The maximum value, cannot be less than `min_value`. - -#### Defined in - -[block-kit/block-elements.ts:565](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L565) - -*** - -### min\_value? - -```ts -optional min_value: string; -``` - -#### Description - -The minimum value, cannot be greater than `max_value`. - -#### Defined in - -[block-kit/block-elements.ts:561](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L561) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "number_input"; -``` - -#### Description - -The type of element. In this case `type` is always `number_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:549](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L549) diff --git a/docs/content/reference/types/interfaces/OptionGroup.md b/docs/content/reference/types/interfaces/OptionGroup.md deleted file mode 100644 index 11b2ce3fb..000000000 --- a/docs/content/reference/types/interfaces/OptionGroup.md +++ /dev/null @@ -1,42 +0,0 @@ -# Interface: OptionGroup - -## Description - -Defines a way to group options in a select or multi-select menu. - -## See - -[Option group object reference](https://api.slack.com/reference/block-kit/composition-objects#option_group). - -## Properties - -### label - -```ts -label: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object that defines the label shown above this group of options. -Maximum length for the `text` in this field is 75 characters. - -#### Defined in - -[block-kit/composition-objects.ts:120](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L120) - -*** - -### options - -```ts -options: Option[]; -``` - -#### Description - -An array of [Option](../type-aliases/Option.md) that belong to this specific group. Maximum of 100 items. - -#### Defined in - -[block-kit/composition-objects.ts:124](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L124) diff --git a/docs/content/reference/types/interfaces/Overflow.md b/docs/content/reference/types/interfaces/Overflow.md deleted file mode 100644 index 21ac78054..000000000 --- a/docs/content/reference/types/interfaces/Overflow.md +++ /dev/null @@ -1,95 +0,0 @@ -# Interface: Overflow - -## Description - -Allows users to press a button to view a list of options. -Unlike the select menu, there is no typeahead field, and the button always appears with an ellipsis ('…') rather -than customizable text. As such, it is usually used if you want a more compact layout than a select menu, or to -supply a list of less visually important actions after a row of buttons. You can also specify simple URL links as -overflow menu options, instead of actions. - -## See - - - [Overflow menu element reference](https://api.slack.com/reference/block-kit/block-elements#overflow). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### options - -```ts -options: PlainTextOption[]; -``` - -#### Description - -An array of up to 5 [PlainTextOption](PlainTextOption.md) to display in the menu. - -#### Defined in - -[block-kit/block-elements.ts:586](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L586) - -*** - -### type - -```ts -type: "overflow"; -``` - -#### Description - -The type of element. In this case `type` is always `number_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:581](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L581) diff --git a/docs/content/reference/types/interfaces/Placeholdable.md b/docs/content/reference/types/interfaces/Placeholdable.md deleted file mode 100644 index a00cfc058..000000000 --- a/docs/content/reference/types/interfaces/Placeholdable.md +++ /dev/null @@ -1,38 +0,0 @@ -# Interface: Placeholdable - -## Extended by - -- [`Datepicker`](Datepicker.md) -- [`EmailInput`](EmailInput.md) -- [`UsersSelect`](UsersSelect.md) -- [`MultiUsersSelect`](MultiUsersSelect.md) -- [`StaticSelect`](StaticSelect.md) -- [`MultiStaticSelect`](MultiStaticSelect.md) -- [`ConversationsSelect`](ConversationsSelect.md) -- [`MultiConversationsSelect`](MultiConversationsSelect.md) -- [`ChannelsSelect`](ChannelsSelect.md) -- [`MultiChannelsSelect`](MultiChannelsSelect.md) -- [`ExternalSelect`](ExternalSelect.md) -- [`MultiExternalSelect`](MultiExternalSelect.md) -- [`NumberInput`](NumberInput.md) -- [`PlainTextInput`](PlainTextInput.md) -- [`Timepicker`](Timepicker.md) -- [`URLInput`](URLInput.md) -- [`RichTextInput`](RichTextInput.md) - -## Properties - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) diff --git a/docs/content/reference/types/interfaces/PlainTextElement.md b/docs/content/reference/types/interfaces/PlainTextElement.md deleted file mode 100644 index 70892b4f3..000000000 --- a/docs/content/reference/types/interfaces/PlainTextElement.md +++ /dev/null @@ -1,57 +0,0 @@ -# Interface: PlainTextElement - -## Description - -Defines an object containing some text. - -## See - -[Text object reference](https://api.slack.com/reference/block-kit/composition-objects#text). - -## Properties - -### emoji? - -```ts -optional emoji: boolean; -``` - -#### Description - -Indicates whether emojis in a text field should be escaped into the colon emoji format. - -#### Defined in - -[block-kit/composition-objects.ts:150](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L150) - -*** - -### text - -```ts -text: string; -``` - -#### Description - -The text for the block. The minimum length is 1 and maximum length is 3000 characters. - -#### Defined in - -[block-kit/composition-objects.ts:146](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L146) - -*** - -### type - -```ts -type: "plain_text"; -``` - -#### Description - -The formatting to use for this text object. - -#### Defined in - -[block-kit/composition-objects.ts:142](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L142) diff --git a/docs/content/reference/types/interfaces/PlainTextInput.md b/docs/content/reference/types/interfaces/PlainTextInput.md deleted file mode 100644 index e8c6db86c..000000000 --- a/docs/content/reference/types/interfaces/PlainTextInput.md +++ /dev/null @@ -1,185 +0,0 @@ -# Interface: PlainTextInput - -## Description - -Allows users to enter freeform text data into a single-line or multi-line field. - -## See - - - [Plain-text input element reference](https://api.slack.com/reference/block-kit/block-elements#input). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Inherited from - -[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) - -#### Defined in - -[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_value? - -```ts -optional initial_value: string; -``` - -#### Description - -The initial value in the plain-text input when it is loaded. - -#### Defined in - -[block-kit/block-elements.ts:606](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L606) - -*** - -### max\_length? - -```ts -optional max_length: number; -``` - -#### Description - -The maximum length of input that the user can provide. If the user provides more, -they will receive an error. - -#### Defined in - -[block-kit/block-elements.ts:621](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L621) - -*** - -### min\_length? - -```ts -optional min_length: number; -``` - -#### Description - -The minimum length of input that the user must provide. If the user provides less, they will receive -an error. Maximum value is 3000. - -#### Defined in - -[block-kit/block-elements.ts:616](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L616) - -*** - -### multiline? - -```ts -optional multiline: boolean; -``` - -#### Description - -Indicates whether the input will be a single line (`false`) or a larger textarea (`true`). -Defaults to `false`. - -#### Defined in - -[block-kit/block-elements.ts:611](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L611) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "plain_text_input"; -``` - -#### Description - -The type of element. In this case `type` is always `plain_text_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:602](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L602) diff --git a/docs/content/reference/types/interfaces/PlainTextOption.md b/docs/content/reference/types/interfaces/PlainTextOption.md deleted file mode 100644 index ecc70d12c..000000000 --- a/docs/content/reference/types/interfaces/PlainTextOption.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: PlainTextOption - -## Extends - -- `OptionDescriptor` - -## Properties - -### description? - -```ts -optional description: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) that defines a line of descriptive text shown below the `text` field. -Maximum length for the `text` within this field is 75 characters. - -#### Inherited from - -`OptionDescriptor.description` - -#### Defined in - -[block-kit/composition-objects.ts:85](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L85) - -*** - -### text - -```ts -text: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) that defines the text shown in the option on the menu. To be used with -overflow, select and multi-select menus. Maximum length for the `text` in this field is 75 characters. - -#### Defined in - -[block-kit/composition-objects.ts:101](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L101) - -*** - -### url? - -```ts -optional url: string; -``` - -#### Description - -Only available in overflow menus! A URL to load in the user's browser when the option is clicked. -Maximum length for this field is 3000 characters. - -#### Inherited from - -`OptionDescriptor.url` - -#### Defined in - -[block-kit/composition-objects.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L80) - -*** - -### value? - -```ts -optional value: string; -``` - -#### Description - -A unique string value that will be passed to your app when this option is chosen. -Maximum length for this field is 75 characters. - -#### Inherited from - -`OptionDescriptor.value` - -#### Defined in - -[block-kit/composition-objects.ts:75](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L75) diff --git a/docs/content/reference/types/interfaces/RadioButtons.md b/docs/content/reference/types/interfaces/RadioButtons.md deleted file mode 100644 index 97337de49..000000000 --- a/docs/content/reference/types/interfaces/RadioButtons.md +++ /dev/null @@ -1,130 +0,0 @@ -# Interface: RadioButtons - -## Description - -Allows users to choose one item from a list of possible options. - -## See - - - [Radio button group element reference](https://api.slack.com/reference/block-kit/block-elements#radio). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_option? - -```ts -optional initial_option: Option; -``` - -#### Description - -An [Option](../type-aliases/Option.md) object that exactly matches one of the options within `options`. This option will -be selected when the radio button group initially loads. - -#### Defined in - -[block-kit/block-elements.ts:638](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L638) - -*** - -### options - -```ts -options: Option[]; -``` - -#### Description - -An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options are allowed. - -#### Defined in - -[block-kit/block-elements.ts:642](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L642) - -*** - -### type - -```ts -type: "radio_buttons"; -``` - -#### Description - -The type of element. In this case `type` is always `radio_buttons`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:633](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L633) diff --git a/docs/content/reference/types/interfaces/RichTextBlock.md b/docs/content/reference/types/interfaces/RichTextBlock.md deleted file mode 100644 index efa0149cb..000000000 --- a/docs/content/reference/types/interfaces/RichTextBlock.md +++ /dev/null @@ -1,74 +0,0 @@ -# Interface: RichTextBlock - -## Description - -Displays formatted, structured representation of text. It is also the output of the Slack client's -WYSIWYG message composer, so all messages sent by end-users will have this format. Use this block to include -user-defined formatted text in your Block Kit payload. While it is possible to format text with `mrkdwn`, -`rich_text` is strongly preferred and allows greater flexibility. -You might encounter a `rich_text` block in a message payload, as a built-in type in workflow apps, or as output of -the [RichTextInput](RichTextInput.md). - -## See - -[Rich text block reference](https://api.slack.com/reference/block-kit/blocks#rich_text). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) - -*** - -### elements - -```ts -elements: RichTextBlockElement[]; -``` - -#### Defined in - -[block-kit/blocks.ts:241](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L241) - -*** - -### type - -```ts -type: "rich_text"; -``` - -#### Description - -The type of block. For a rich text block, `type` is always `rich_text`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -[block-kit/blocks.ts:240](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L240) diff --git a/docs/content/reference/types/interfaces/RichTextBorderable.md b/docs/content/reference/types/interfaces/RichTextBorderable.md deleted file mode 100644 index 835f7cec9..000000000 --- a/docs/content/reference/types/interfaces/RichTextBorderable.md +++ /dev/null @@ -1,26 +0,0 @@ -# Interface: RichTextBorderable - -For use in setting border style details on certain Rich Text elements. - -## Extended by - -- [`RichTextList`](RichTextList.md) -- [`RichTextQuote`](RichTextQuote.md) -- [`RichTextPreformatted`](RichTextPreformatted.md) - -## Properties - -### border? - -```ts -optional border: 0 | 1; -``` - -#### Description - -Whether to render a quote-block-like border on the inline side of the list. `0` renders no border -while `1` renders a border. - -#### Defined in - -[block-kit/extensions.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L76) diff --git a/docs/content/reference/types/interfaces/RichTextBroadcastMention.md b/docs/content/reference/types/interfaces/RichTextBroadcastMention.md deleted file mode 100644 index 109544c31..000000000 --- a/docs/content/reference/types/interfaces/RichTextBroadcastMention.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextBroadcastMention - -## Description - -A broadcast mention element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### range - -```ts -range: "here" | "channel" | "everyone"; -``` - -#### Description - -The range of the broadcast; can be one of `here`, `channel` and `everyone`. - -#### Defined in - -[block-kit/block-elements.ts:766](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L766) - -*** - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) - -*** - -### type - -```ts -type: "broadcast"; -``` - -#### Description - -The type of element. In this case `type` is always `broadcast`. - -#### Defined in - -[block-kit/block-elements.ts:762](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L762) diff --git a/docs/content/reference/types/interfaces/RichTextChannelMention.md b/docs/content/reference/types/interfaces/RichTextChannelMention.md deleted file mode 100644 index 2cf45b6b1..000000000 --- a/docs/content/reference/types/interfaces/RichTextChannelMention.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextChannelMention - -## Description - -A channel mention element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -The encoded channel ID, e.g. C1234ABCD. - -#### Defined in - -[block-kit/block-elements.ts:794](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L794) - -*** - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) - -*** - -### type - -```ts -type: "channel"; -``` - -#### Description - -The type of element. In this case `type` is always `channel`. - -#### Defined in - -[block-kit/block-elements.ts:790](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L790) diff --git a/docs/content/reference/types/interfaces/RichTextColor.md b/docs/content/reference/types/interfaces/RichTextColor.md deleted file mode 100644 index 993d3930d..000000000 --- a/docs/content/reference/types/interfaces/RichTextColor.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextColor - -## Description - -A hex color element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) - -*** - -### type - -```ts -type: "color"; -``` - -#### Description - -The type of element. In this case `type` is always `color`. - -#### Defined in - -[block-kit/block-elements.ts:776](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L776) - -*** - -### value - -```ts -value: string; -``` - -#### Description - -The hex value for the color. - -#### Defined in - -[block-kit/block-elements.ts:780](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L780) diff --git a/docs/content/reference/types/interfaces/RichTextDate.md b/docs/content/reference/types/interfaces/RichTextDate.md deleted file mode 100644 index 1fbdde726..000000000 --- a/docs/content/reference/types/interfaces/RichTextDate.md +++ /dev/null @@ -1,169 +0,0 @@ -# Interface: RichTextDate - -## Description - -A date element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### fallback? - -```ts -optional fallback: string; -``` - -#### Description - -Text to display in place of the date should parsing, formatting or displaying fails. - -#### Defined in - -[block-kit/block-elements.ts:840](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L840) - -*** - -### format - -```ts -format: string; -``` - -#### Description - -A template string containing curly-brace-enclosed tokens to substitute your provided `timestamp` -in a particularly-formatted way. For example: `Posted at {date_long}`. The available date formatting tokens are: -- `{day_divider_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable. Otherwise, if the date is in - current year, uses the `{date_long}` format without the year. Otherwise, falls back to using the `{date_long}` - format. -- `{date_num}`: Shows date as YYYY-MM-DD. -- `{date_slash}`: Shows date as DD/MM/YYYY (subject to locale preferences). -- `{date_long}`: Shows date as a long-form sentence including day-of-week, e.g. `Monday, December 23rd, 2013`. -- `{date_long_full}`: Shows date as a long-form sentence without day-of-week, e.g. `August 9, 2020`. -- `{date_long_pretty}`: Shows `yesterday`, `today` or `tomorrow`, otherwise uses the `{date_long}` format. -- `{date}`: Same as `{date_long_full}` but without the year. -- `{date_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable, otherwise uses the `{date}` format. -- `{date_short}`: Shows date using short month names without day-of-week, e.g. `Aug 9, 2020`. -- `{date_short_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable, otherwise uses the `{date_short}` - format. -- `{time}`: Depending on user preferences, shows just the time-of-day portion of the timestamp using either 12 or - 24 hour clock formats, e.g. `2:34 PM` or `14:34`. -- `{time_secs}`: Depending on user preferences, shows just the time-of-day portion of the timestamp using either 12 - or 24 hour clock formats, including seconds, e.g. `2:34:56 PM` or `14:34:56`. -- `{ago}`: A human-readable period of time, e.g. `3 minutes ago`, `4 hours ago`, `2 days ago`. -TODO: test/document `{member_local_time}`, `{status_expiration}` and `{calendar_header}` - -#### Defined in - -[block-kit/block-elements.ts:832](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L832) - -*** - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) - -*** - -### timestamp - -```ts -timestamp: number; -``` - -#### Description - -A UNIX timestamp for the date to be displayed in seconds. - -#### Defined in - -[block-kit/block-elements.ts:808](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L808) - -*** - -### type - -```ts -type: "date"; -``` - -#### Description - -The type of element. In this case `type` is always `date`. - -#### Defined in - -[block-kit/block-elements.ts:804](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L804) - -*** - -### url? - -```ts -optional url: string; -``` - -#### Description - -URL to link the entire `format` string to. - -#### Defined in - -[block-kit/block-elements.ts:836](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L836) diff --git a/docs/content/reference/types/interfaces/RichTextEmoji.md b/docs/content/reference/types/interfaces/RichTextEmoji.md deleted file mode 100644 index d514b4db9..000000000 --- a/docs/content/reference/types/interfaces/RichTextEmoji.md +++ /dev/null @@ -1,133 +0,0 @@ -# Interface: RichTextEmoji - -## Description - -An emoji element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### name - -```ts -name: string; -``` - -#### Description - -Name of emoji, without colons or skin tones, e.g. `wave` - -#### Defined in - -[block-kit/block-elements.ts:854](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L854) - -*** - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) - -*** - -### type - -```ts -type: "emoji"; -``` - -#### Description - -The type of element. In this case `type` is always `emoji`. - -#### Defined in - -[block-kit/block-elements.ts:850](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L850) - -*** - -### unicode? - -```ts -optional unicode: string; -``` - -#### Description - -Lowercase hexadecimal Unicode representation of a standard emoji (not for use with custom emoji). - -#### Defined in - -[block-kit/block-elements.ts:858](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L858) - -*** - -### url? - -```ts -optional url: string; -``` - -#### Description - -URL of emoji asset. Only used when sharing custom emoji across workspaces. - -#### Defined in - -[block-kit/block-elements.ts:862](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L862) diff --git a/docs/content/reference/types/interfaces/RichTextInput.md b/docs/content/reference/types/interfaces/RichTextInput.md deleted file mode 100644 index c200dac14..000000000 --- a/docs/content/reference/types/interfaces/RichTextInput.md +++ /dev/null @@ -1,135 +0,0 @@ -# Interface: RichTextInput - -## Description - -A rich text input creates a composer/WYSIWYG editor for entering formatted text, offering nearly the -same experience you have writing messages in Slack. - -## See - - - [Rich-text input element reference](https://api.slack.com/reference/block-kit/block-elements#rich_text_input). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Inherited from - -[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) - -#### Defined in - -[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_value? - -```ts -optional initial_value: RichTextBlock; -``` - -#### Description - -Initial contents of the input when it is loaded. - -#### Defined in - -[block-kit/block-elements.ts:1039](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1039) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "rich_text_input"; -``` - -#### Description - -The type of element. In this case `type` is always `rich_text_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:1035](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1035) diff --git a/docs/content/reference/types/interfaces/RichTextLink.md b/docs/content/reference/types/interfaces/RichTextLink.md deleted file mode 100644 index 14b8b96aa..000000000 --- a/docs/content/reference/types/interfaces/RichTextLink.md +++ /dev/null @@ -1,133 +0,0 @@ -# Interface: RichTextLink - -## Description - -A link element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) - -*** - -### text? - -```ts -optional text: string; -``` - -#### Description - -The text to link. - -#### Defined in - -[block-kit/block-elements.ts:876](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L876) - -*** - -### type - -```ts -type: "link"; -``` - -#### Description - -The type of element. In this case `type` is always `link`. - -#### Defined in - -[block-kit/block-elements.ts:872](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L872) - -*** - -### unsafe? - -```ts -optional unsafe: boolean; -``` - -#### Description - -TODO: ? - -#### Defined in - -[block-kit/block-elements.ts:880](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L880) - -*** - -### url - -```ts -url: string; -``` - -#### Description - -URL to link to. - -#### Defined in - -[block-kit/block-elements.ts:884](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L884) diff --git a/docs/content/reference/types/interfaces/RichTextList.md b/docs/content/reference/types/interfaces/RichTextList.md deleted file mode 100644 index a88882d2a..000000000 --- a/docs/content/reference/types/interfaces/RichTextList.md +++ /dev/null @@ -1,96 +0,0 @@ -# Interface: RichTextList - -## Description - -A list block within a rich text field. - -## Extends - -- [`RichTextBorderable`](RichTextBorderable.md) - -## Properties - -### border? - -```ts -optional border: 0 | 1; -``` - -#### Description - -Whether to render a quote-block-like border on the inline side of the list. `0` renders no border -while `1` renders a border. - -#### Inherited from - -[`RichTextBorderable`](RichTextBorderable.md).[`border`](RichTextBorderable.md#border) - -#### Defined in - -[block-kit/extensions.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L76) - -*** - -### elements - -```ts -elements: RichTextSection[]; -``` - -#### Description - -An array of [RichTextSection](RichTextSection.md) elements comprising each list item. - -#### Defined in - -[block-kit/block-elements.ts:980](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L980) - -*** - -### indent? - -```ts -optional indent: number; -``` - -#### Description - -The style of the list points. Can be a number from `0` (default) to `8`. Yields a different character -or characters rendered as the list points. Also affected by the `style` property. - -#### Defined in - -[block-kit/block-elements.ts:990](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L990) - -*** - -### style - -```ts -style: "bullet" | "ordered"; -``` - -#### Description - -The type of list. Can be either `bullet` (the list points are all rendered the same way) or `ordered` -(the list points increase numerically from 1). - -#### Defined in - -[block-kit/block-elements.ts:985](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L985) - -*** - -### type - -```ts -type: "rich_text_list"; -``` - -#### Description - -The type of element. In this case `type` is always `rich_text_list`. - -#### Defined in - -[block-kit/block-elements.ts:976](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L976) diff --git a/docs/content/reference/types/interfaces/RichTextPreformatted.md b/docs/content/reference/types/interfaces/RichTextPreformatted.md deleted file mode 100644 index e191e4b4a..000000000 --- a/docs/content/reference/types/interfaces/RichTextPreformatted.md +++ /dev/null @@ -1,62 +0,0 @@ -# Interface: RichTextPreformatted - -## Description - -A block of preformatted text within a rich text field. - -## Extends - -- [`RichTextBorderable`](RichTextBorderable.md) - -## Properties - -### border? - -```ts -optional border: 0 | 1; -``` - -#### Description - -Whether to render a quote-block-like border on the inline side of the list. `0` renders no border -while `1` renders a border. - -#### Inherited from - -[`RichTextBorderable`](RichTextBorderable.md).[`border`](RichTextBorderable.md#border) - -#### Defined in - -[block-kit/extensions.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L76) - -*** - -### elements - -```ts -elements: (RichTextLink | RichTextText)[]; -``` - -#### Description - -An array of either [RichTextLink](RichTextLink.md) or [RichTextText](RichTextText.md) comprising the preformatted text. - -#### Defined in - -[block-kit/block-elements.ts:1018](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1018) - -*** - -### type - -```ts -type: "rich_text_preformatted"; -``` - -#### Description - -The type of element. In this case `type` is always `rich_text_preformatted`. - -#### Defined in - -[block-kit/block-elements.ts:1014](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1014) diff --git a/docs/content/reference/types/interfaces/RichTextQuote.md b/docs/content/reference/types/interfaces/RichTextQuote.md deleted file mode 100644 index 2826392f8..000000000 --- a/docs/content/reference/types/interfaces/RichTextQuote.md +++ /dev/null @@ -1,62 +0,0 @@ -# Interface: RichTextQuote - -## Description - -A quote block within a rich text field. - -## Extends - -- [`RichTextBorderable`](RichTextBorderable.md) - -## Properties - -### border? - -```ts -optional border: 0 | 1; -``` - -#### Description - -Whether to render a quote-block-like border on the inline side of the list. `0` renders no border -while `1` renders a border. - -#### Inherited from - -[`RichTextBorderable`](RichTextBorderable.md).[`border`](RichTextBorderable.md#border) - -#### Defined in - -[block-kit/extensions.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L76) - -*** - -### elements - -```ts -elements: RichTextElement[]; -``` - -#### Description - -An array of [RichTextElement](../type-aliases/RichTextElement.md) comprising the quote block. - -#### Defined in - -[block-kit/block-elements.ts:1004](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1004) - -*** - -### type - -```ts -type: "rich_text_quote"; -``` - -#### Description - -The type of element. In this case `type` is always `rich_text_quote`. - -#### Defined in - -[block-kit/block-elements.ts:1000](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1000) diff --git a/docs/content/reference/types/interfaces/RichTextSection.md b/docs/content/reference/types/interfaces/RichTextSection.md deleted file mode 100644 index e91c88245..000000000 --- a/docs/content/reference/types/interfaces/RichTextSection.md +++ /dev/null @@ -1,33 +0,0 @@ -# Interface: RichTextSection - -## Description - -A section block within a rich text field. - -## Properties - -### elements - -```ts -elements: RichTextElement[]; -``` - -#### Defined in - -[block-kit/block-elements.ts:966](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L966) - -*** - -### type - -```ts -type: "rich_text_section"; -``` - -#### Description - -The type of element. In this case `type` is always `rich_text_section`. - -#### Defined in - -[block-kit/block-elements.ts:965](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L965) diff --git a/docs/content/reference/types/interfaces/RichTextStyleable.md b/docs/content/reference/types/interfaces/RichTextStyleable.md deleted file mode 100644 index 6187e75d1..000000000 --- a/docs/content/reference/types/interfaces/RichTextStyleable.md +++ /dev/null @@ -1,74 +0,0 @@ -# Interface: RichTextStyleable - -## Description - -For use styling Rich Text sub-elements. - -## Extended by - -- [`RichTextBroadcastMention`](RichTextBroadcastMention.md) -- [`RichTextColor`](RichTextColor.md) -- [`RichTextChannelMention`](RichTextChannelMention.md) -- [`RichTextDate`](RichTextDate.md) -- [`RichTextEmoji`](RichTextEmoji.md) -- [`RichTextLink`](RichTextLink.md) -- [`RichTextTeamMention`](RichTextTeamMention.md) -- [`RichTextText`](RichTextText.md) -- [`RichTextUserMention`](RichTextUserMention.md) -- [`RichTextUsergroupMention`](RichTextUsergroupMention.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Defined in - -[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) diff --git a/docs/content/reference/types/interfaces/RichTextTeamMention.md b/docs/content/reference/types/interfaces/RichTextTeamMention.md deleted file mode 100644 index 7c267b5bd..000000000 --- a/docs/content/reference/types/interfaces/RichTextTeamMention.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextTeamMention - -## Description - -A workspace or team mention element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID, e.g. T1234ABCD. - -#### Defined in - -[block-kit/block-elements.ts:898](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L898) - -*** - -### type - -```ts -type: "team"; -``` - -#### Description - -The type of element. In this case `type` is always `team`. - -#### Defined in - -[block-kit/block-elements.ts:894](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L894) diff --git a/docs/content/reference/types/interfaces/RichTextText.md b/docs/content/reference/types/interfaces/RichTextText.md deleted file mode 100644 index 5bd3aa1c1..000000000 --- a/docs/content/reference/types/interfaces/RichTextText.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextText - -## Description - -A generic text element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) - -*** - -### text - -```ts -text: string; -``` - -#### Description - -The text to render. - -#### Defined in - -[block-kit/block-elements.ts:912](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L912) - -*** - -### type - -```ts -type: "text"; -``` - -#### Description - -The type of element. In this case `type` is always `text`. - -#### Defined in - -[block-kit/block-elements.ts:908](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L908) diff --git a/docs/content/reference/types/interfaces/RichTextUserMention.md b/docs/content/reference/types/interfaces/RichTextUserMention.md deleted file mode 100644 index 871730ca7..000000000 --- a/docs/content/reference/types/interfaces/RichTextUserMention.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextUserMention - -## Description - -A user mention element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) - -*** - -### type - -```ts -type: "user"; -``` - -#### Description - -The type of element. In this case `type` is always `user`. - -#### Defined in - -[block-kit/block-elements.ts:922](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L922) - -*** - -### user\_id - -```ts -user_id: string; -``` - -#### Description - -The encoded user ID, e.g. U1234ABCD. - -#### Defined in - -[block-kit/block-elements.ts:926](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L926) diff --git a/docs/content/reference/types/interfaces/RichTextUsergroupMention.md b/docs/content/reference/types/interfaces/RichTextUsergroupMention.md deleted file mode 100644 index 9fb288be7..000000000 --- a/docs/content/reference/types/interfaces/RichTextUsergroupMention.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextUsergroupMention - -## Description - -A usergroup mention element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -[block-kit/extensions.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L86) - -*** - -### type - -```ts -type: "usergroup"; -``` - -#### Description - -The type of element. In this case `type` is always `usergroup`. - -#### Defined in - -[block-kit/block-elements.ts:936](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L936) - -*** - -### usergroup\_id - -```ts -usergroup_id: string; -``` - -#### Description - -The encoded usergroup ID, e.g. S1234ABCD. - -#### Defined in - -[block-kit/block-elements.ts:940](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L940) diff --git a/docs/content/reference/types/interfaces/SectionBlock.md b/docs/content/reference/types/interfaces/SectionBlock.md deleted file mode 100644 index c9450f139..000000000 --- a/docs/content/reference/types/interfaces/SectionBlock.md +++ /dev/null @@ -1,112 +0,0 @@ -# Interface: SectionBlock - -## Description - -Displays text, possibly alongside block elements. A section can be used as a simple text block, in -combination with text fields, or side-by-side with certain -[block elements](https://api.slack.com/reference/messaging/block-elements). - -## See - -[Section block reference](https://api.slack.com/reference/block-kit/blocks#section). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### accessory? - -```ts -optional accessory: SectionBlockAccessory; -``` - -#### Description - -One of the compatible element objects. - -#### Defined in - -[block-kit/blocks.ts:280](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L280) - -*** - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) - -*** - -### fields? - -```ts -optional fields: TextObject[]; -``` - -#### Description - -Required if no `text` is provided. An array of text objects. Any text objects included with `fields` -will be rendered in a compact format that allows for 2 columns of side-by-side text. Maximum number of items is 10. -Maximum length for the text in each item is 2000 characters. -[Click here for an example](https://app.slack.com/block-kit-builder/#%7B%22blocks%22:%5B%7B%22type%22:%22section%22,%22text%22:%7B%22text%22:%22A%20message%20*with%20some%20bold%20text*%20and%20_some%20italicized%20text_.%22,%22type%22:%22mrkdwn%22%7D,%22fields%22:%5B%7B%22type%22:%22mrkdwn%22,%22text%22:%22*Priority*%22%7D,%7B%22type%22:%22mrkdwn%22,%22text%22:%22*Type*%22%7D,%7B%22type%22:%22plain_text%22,%22text%22:%22High%22%7D,%7B%22type%22:%22plain_text%22,%22text%22:%22String%22%7D%5D%7D%5D%7D). - -#### Defined in - -[block-kit/blocks.ts:276](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L276) - -*** - -### text? - -```ts -optional text: TextObject; -``` - -#### Description - -The text for the block, in the form of a [TextObject](../type-aliases/TextObject.md). Minimum length for the `text` in this -field is 1 and maximum length is 3000 characters. This field is not required if a valid array of `fields` objects -is provided instead. - -#### Defined in - -[block-kit/blocks.ts:269](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L269) - -*** - -### type - -```ts -type: "section"; -``` - -#### Description - -The type of block. For a section block, `type` is always `section`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -[block-kit/blocks.ts:263](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L263) diff --git a/docs/content/reference/types/interfaces/SelectOption.md b/docs/content/reference/types/interfaces/SelectOption.md deleted file mode 100644 index 5ca594dc7..000000000 --- a/docs/content/reference/types/interfaces/SelectOption.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: SelectOption - -## Properties - -### label - -```ts -label: string; -``` - -#### Defined in - -[dialog.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L36) - -*** - -### value - -```ts -value: string; -``` - -#### Defined in - -[dialog.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/dialog.ts#L37) diff --git a/docs/content/reference/types/interfaces/SlackFileImageObject.md b/docs/content/reference/types/interfaces/SlackFileImageObject.md deleted file mode 100644 index 85ad463b6..000000000 --- a/docs/content/reference/types/interfaces/SlackFileImageObject.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: SlackFileImageObject - -## Description - -Object for image which contains a slack_file. - -## Properties - -### slack\_file - -```ts -slack_file: SlackFile; -``` - -#### Description - -The slack file of the image to be displayed. - -#### Defined in - -[block-kit/composition-objects.ts:217](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L217) diff --git a/docs/content/reference/types/interfaces/StaticSelect.md b/docs/content/reference/types/interfaces/StaticSelect.md deleted file mode 100644 index 20efaa05b..000000000 --- a/docs/content/reference/types/interfaces/StaticSelect.md +++ /dev/null @@ -1,170 +0,0 @@ -# Interface: StaticSelect - -## Description - -This is the simplest form of select menu, with a static list of options passed in when defining the -element. - -## See - - - [Select menu of static options reference](https://api.slack.com/reference/block-kit/block-elements#static_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_option? - -```ts -optional initial_option: PlainTextOption; -``` - -#### Description - -A single option that exactly matches one of the options within `options` or `option_groups`. -This option will be selected when the menu initially loads. - -#### Defined in - -[block-kit/block-elements.ts:289](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L289) - -*** - -### option\_groups? - -```ts -optional option_groups: object[]; -``` - -#### Description - -An array of option group objects. Maximum number of option groups is 100. If `options` is specified, -this field should not be. - -#### Defined in - -[block-kit/block-elements.ts:304](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L304) - -*** - -### options? - -```ts -optional options: PlainTextOption[]; -``` - -#### Description - -An array of [PlainTextOption](PlainTextOption.md). Maximum number of options is 100. If `option_groups` is -specified, this field should not be. - -#### Defined in - -[block-kit/block-elements.ts:296](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L296) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "static_select"; -``` - -#### Description - -The type of element. In this case `type` is always `static_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:283](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L283) diff --git a/docs/content/reference/types/interfaces/Timepicker.md b/docs/content/reference/types/interfaces/Timepicker.md deleted file mode 100644 index 7c399dbf4..000000000 --- a/docs/content/reference/types/interfaces/Timepicker.md +++ /dev/null @@ -1,155 +0,0 @@ -# Interface: Timepicker - -## Description - -Allows users to choose a time from a rich dropdown UI. On desktop clients, this time picker will take -the form of a dropdown list with free-text entry for precise choices. On mobile clients, the time picker will use -native time picker UIs. - -## See - - - [Time picker element reference](https://api.slack.com/reference/block-kit/block-elements#timepicker). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_time? - -```ts -optional initial_time: string; -``` - -#### Description - -The initial time that is selected when the element is loaded. This should be in the format `HH:mm`, -where `HH` is the 24-hour format of an hour (00 to 23) and `mm` is minutes with leading zeros (00 to 59), -for example 22:25 for 10:25pm. - -#### Defined in - -[block-kit/block-elements.ts:666](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L666) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### timezone? - -```ts -optional timezone: string; -``` - -#### Description - -A string in the IANA format, e.g. 'America/Chicago'. The timezone is displayed to end users as hint -text underneath the time picker. It is also passed to the app upon certain interactions, such as view_submission. - -#### Defined in - -[block-kit/block-elements.ts:671](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L671) - -*** - -### type - -```ts -type: "timepicker"; -``` - -#### Description - -The type of element. In this case `type` is always `timepicker`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:660](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L660) diff --git a/docs/content/reference/types/interfaces/URLInput.md b/docs/content/reference/types/interfaces/URLInput.md deleted file mode 100644 index 92be3d720..000000000 --- a/docs/content/reference/types/interfaces/URLInput.md +++ /dev/null @@ -1,134 +0,0 @@ -# Interface: URLInput - -## Description - -Allows user to enter a URL into a single-line field. - -## See - - - [URL input element reference](https://api.slack.com/reference/block-kit/block-elements#url). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Inherited from - -[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) - -#### Defined in - -[block-kit/extensions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L33) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_value? - -```ts -optional initial_value: string; -``` - -#### Description - -The initial value in the URL input when it is loaded. - -#### Defined in - -[block-kit/block-elements.ts:691](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L691) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "url_text_input"; -``` - -#### Description - -The type of element. In this case `type` is always `url_text_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:687](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L687) diff --git a/docs/content/reference/types/interfaces/URLRespondable.md b/docs/content/reference/types/interfaces/URLRespondable.md deleted file mode 100644 index 066a5eb50..000000000 --- a/docs/content/reference/types/interfaces/URLRespondable.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: URLRespondable - -## Extended by - -- [`ConversationsSelect`](ConversationsSelect.md) -- [`ChannelsSelect`](ChannelsSelect.md) - -## Properties - -### response\_url\_enabled? - -```ts -optional response_url_enabled: boolean; -``` - -#### Description - -When set to `true`, the [`view_submission` payload](https://api.slack.com/reference/interaction-payloads/views#view_submission) -from the menu's parent view will contain a `response_url`. This `response_url` can be used for -[message responses](https://api.slack.com/interactivity/handling#message_responses). The target conversation -for the message will be determined by the value of this select menu. - -#### Defined in - -[block-kit/extensions.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L67) diff --git a/docs/content/reference/types/interfaces/UrlImageObject.md b/docs/content/reference/types/interfaces/UrlImageObject.md deleted file mode 100644 index 503baa03b..000000000 --- a/docs/content/reference/types/interfaces/UrlImageObject.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: UrlImageObject - -## Description - -Object for image which contains a image_url. - -## Properties - -### image\_url - -```ts -image_url: string; -``` - -#### Description - -The URL of the image to be displayed. - -#### Defined in - -[block-kit/composition-objects.ts:207](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L207) diff --git a/docs/content/reference/types/interfaces/UsersSelect.md b/docs/content/reference/types/interfaces/UsersSelect.md deleted file mode 100644 index 2a4565247..000000000 --- a/docs/content/reference/types/interfaces/UsersSelect.md +++ /dev/null @@ -1,135 +0,0 @@ -# Interface: UsersSelect - -## Description - -This select menu will populate its options with a list of Slack users visible to the current user in the -active workspace. - -## See - - - [Select menu of users reference](https://api.slack.com/reference/block-kit/block-elements#users_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -[block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -[block-kit/extensions.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L42) - -*** - -### initial\_user? - -```ts -optional initial_user: string; -``` - -#### Description - -The user ID of any valid user to be pre-selected when the menu loads. - -#### Defined in - -[block-kit/block-elements.ts:244](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L244) - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -[block-kit/extensions.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L57) - -*** - -### type - -```ts -type: "users_select"; -``` - -#### Description - -The type of element. In this case `type` is always `users_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -[block-kit/block-elements.ts:240](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L240) diff --git a/docs/content/reference/types/interfaces/VideoBlock.md b/docs/content/reference/types/interfaces/VideoBlock.md deleted file mode 100644 index adff7cb4f..000000000 --- a/docs/content/reference/types/interfaces/VideoBlock.md +++ /dev/null @@ -1,206 +0,0 @@ -# Interface: VideoBlock - -## Description - -Displays an embedded video player. A video block is designed to embed videos in all app surfaces (e.g. -link unfurls, messages, modals, App Home) — anywhere you can put blocks! To use the video block within your app, you -must have the [`links.embed:write` scope](https://api.slack.com/scopes/links.embed:write). - -## See - -[Video block reference](https://api.slack.com/reference/block-kit/blocks#video). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### alt\_text - -```ts -alt_text: string; -``` - -#### Description - -A tooltip for the video. Required for accessibility. - -#### Defined in - -[block-kit/blocks.ts:307](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L307) - -*** - -### author\_name? - -```ts -optional author_name: string; -``` - -#### Description - -Author name to be displayed. Must be less than 50 characters. - -#### Defined in - -[block-kit/blocks.ts:320](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L320) - -*** - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -[block-kit/blocks.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L44) - -*** - -### description? - -```ts -optional description: PlainTextElement; -``` - -#### Description - -Description for video using a [PlainTextElement](PlainTextElement.md) object. - -#### Defined in - -[block-kit/blocks.ts:332](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L332) - -*** - -### provider\_icon\_url? - -```ts -optional provider_icon_url: string; -``` - -#### Description - -Icon for the video provider, e.g. YouTube icon. - -#### Defined in - -[block-kit/blocks.ts:328](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L328) - -*** - -### provider\_name? - -```ts -optional provider_name: string; -``` - -#### Description - -The originating application or domain of the video, e.g. YouTube. - -#### Defined in - -[block-kit/blocks.ts:324](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L324) - -*** - -### thumbnail\_url - -```ts -thumbnail_url: string; -``` - -#### Description - -The thumbnail image URL. - -#### Defined in - -[block-kit/blocks.ts:303](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L303) - -*** - -### title - -```ts -title: PlainTextElement; -``` - -#### Description - -Video title as a [PlainTextElement](PlainTextElement.md) object. `text` within must be less than 200 characters. - -#### Defined in - -[block-kit/blocks.ts:311](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L311) - -*** - -### title\_url? - -```ts -optional title_url: string; -``` - -#### Description - -Hyperlink for the title text. Must correspond to the non-embeddable URL for the video. -Must go to an HTTPS URL. - -#### Defined in - -[block-kit/blocks.ts:316](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L316) - -*** - -### type - -```ts -type: "video"; -``` - -#### Description - -The type of block. For a video block, `type` is always `video`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -[block-kit/blocks.ts:293](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L293) - -*** - -### video\_url - -```ts -video_url: string; -``` - -#### Description - -The URL to be embedded. Must match any existing -[unfurl domains](https://api.slack.com/reference/messaging/link-unfurling#configuring_domains) within the app -and point to a HTTPS URL. - -#### Defined in - -[block-kit/blocks.ts:299](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L299) diff --git a/docs/content/reference/types/interfaces/WorkflowButton.md b/docs/content/reference/types/interfaces/WorkflowButton.md deleted file mode 100644 index a22d255e6..000000000 --- a/docs/content/reference/types/interfaces/WorkflowButton.md +++ /dev/null @@ -1,153 +0,0 @@ -# Interface: WorkflowButton - -## Description - -Allows users to run a [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) with customizable inputs. - -## See - -[Workflow button element reference](https://api.slack.com/reference/block-kit/block-elements#workflow_button). - -## Extends - -- [`Confirmable`](Confirmable.md) - -## Properties - -### accessibility\_label? - -```ts -optional accessibility_label: string; -``` - -#### Description - -A label for longer descriptive text about a button element. This label will be read out by screen -readers instead of the button `text` object. Maximum length for this field is 75 characters. - -#### Defined in - -[block-kit/block-elements.ts:752](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L752) - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -[block-kit/extensions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L25) - -*** - -### style? - -```ts -optional style: ColorScheme; -``` - -#### Description - -Decorates buttons with alternative visual color schemes. Use this option with restraint. -`primary` gives buttons a green outline and text, ideal for affirmation or confirmation actions. `primary` should -only be used for one button within a set. -`danger` gives buttons a red outline and text, and should be used when the action is destructive. Use `danger` even -more sparingly than primary. -If you don't include this field, the default button style will be used. - -#### Defined in - -[block-kit/block-elements.ts:747](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L747) - -*** - -### text - -```ts -text: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) that defines the button's text. `text` may truncate with ~30 characters. -Maximum length for the `text` in this field is 75 characters. - -#### Defined in - -[block-kit/block-elements.ts:707](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L707) - -*** - -### type - -```ts -type: "workflow_button"; -``` - -#### Description - -The type of element. In this case `type` is always `workflow_button`. - -#### Defined in - -[block-kit/block-elements.ts:702](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L702) - -*** - -### workflow - -```ts -workflow: object; -``` - -#### trigger - -```ts -trigger: object; -``` - -##### Description - -Properties of the [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) -that will be invoked via this button. - -#### trigger.customizable\_input\_parameters? - -```ts -optional customizable_input_parameters: object[]; -``` - -##### Description - -List of customizable input parameters and their values. Should match input parameters specified on -the provided trigger. - -#### trigger.url - -```ts -url: string; -``` - -##### Description - -The trigger URL of the [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) - -#### Description - -A workflow object that contains details about the workflow that will run when the button is clicked. - -#### Defined in - -[block-kit/block-elements.ts:711](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L711) diff --git a/docs/content/reference/types/interfaces/WorkflowStepView.md b/docs/content/reference/types/interfaces/WorkflowStepView.md deleted file mode 100644 index 1c5d3487d..000000000 --- a/docs/content/reference/types/interfaces/WorkflowStepView.md +++ /dev/null @@ -1,128 +0,0 @@ -# Interface: ~~WorkflowStepView~~ - -[Configuration modal](https://api.slack.com/legacy/workflows/steps#handle_config_view) for [legacy Workflow Steps from Apps](https://api.slack.com/legacy/workflows/steps). - -## Deprecated - -Steps from Apps are deprecated and will no longer be executed starting September 12, 2024. For more information, see our [deprecation announcement](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). - -## Extends - -- `BaseView` - -## Properties - -### ~~blocks~~ - -```ts -blocks: AnyBlock[]; -``` - -#### Description - -An array of [AnyBlock](../type-aliases/AnyBlock.md) that defines the content of the view. Max of 100 blocks. - -#### Inherited from - -`BaseView.blocks` - -#### Defined in - -[views.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L6) - -*** - -### ~~callback\_id?~~ - -```ts -optional callback_id: string; -``` - -#### Description - -An identifier to recognize interactions and submissions of this particular view. Don't use this to -store sensitive information (use `private_metadata` instead). Maximum length of 255 characters. - -#### See - -[Handling and responding to interactions](https://api.slack.com/surfaces/modals#interactions). - -#### Inherited from - -`BaseView.callback_id` - -#### Defined in - -[views.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L19) - -*** - -### ~~external\_id?~~ - -```ts -optional external_id: string; -``` - -#### Description - -A custom identifier that must be unique for all views on a per-team basis. - -#### Inherited from - -`BaseView.external_id` - -#### Defined in - -[views.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L21) - -*** - -### ~~private\_metadata?~~ - -```ts -optional private_metadata: string; -``` - -#### Description - -String that will be sent to your app in -[`view_submission`](https://api.slack.com/reference/interaction-payloads/views#view_submission) and -[`block_actions`](https://api.slack.com/reference/interaction-payloads/block-actions) events. -Maximum length of 3000 characters. - -#### Inherited from - -`BaseView.private_metadata` - -#### Defined in - -[views.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L13) - -*** - -### ~~submit\_disabled?~~ - -```ts -optional submit_disabled: boolean; -``` - -#### Description - -When set to `true`, disables the submit button until the user has completed one or more inputs. -Defaults to `false`. - -#### Defined in - -[views.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L73) - -*** - -### ~~type~~ - -```ts -type: "workflow_step"; -``` - -#### Defined in - -[views.ts:68](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L68) diff --git a/docs/content/reference/types/type-aliases/ActionsBlockElement.md b/docs/content/reference/types/type-aliases/ActionsBlockElement.md deleted file mode 100644 index 039ea4da6..000000000 --- a/docs/content/reference/types/type-aliases/ActionsBlockElement.md +++ /dev/null @@ -1,26 +0,0 @@ -# Type Alias: ActionsBlockElement - -```ts -type ActionsBlockElement: - | Button - | Checkboxes - | Datepicker - | DateTimepicker - | MultiSelect - | Overflow - | RadioButtons - | Select - | Timepicker - | WorkflowButton - | RichTextInput; -``` - -A helper union type of all Block Elements that can be used in an [ActionsBlock](../interfaces/ActionsBlock.md). - -## See - -[Actions block reference](https://api.slack.com/reference/block-kit/blocks#actions). - -## Defined in - -[block-kit/blocks.ts:64](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L64) diff --git a/docs/content/reference/types/type-aliases/AnyBlock.md b/docs/content/reference/types/type-aliases/AnyBlock.md deleted file mode 100644 index 9239eef3c..000000000 --- a/docs/content/reference/types/type-aliases/AnyBlock.md +++ /dev/null @@ -1,12 +0,0 @@ -# Type Alias: AnyBlock - -```ts -type AnyBlock: KnownBlock | Block; -``` - -A helper union type of all known Blocks as well as the generic [Block](../interfaces/Block.md) interface. A full list of known blocks -is available here: [Blocks reference](https://api.slack.com/reference/block-kit/blocks). - -## Defined in - -[block-kit/blocks.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L58) diff --git a/docs/content/reference/types/type-aliases/CallUser.md b/docs/content/reference/types/type-aliases/CallUser.md deleted file mode 100644 index 724d33267..000000000 --- a/docs/content/reference/types/type-aliases/CallUser.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: CallUser - -```ts -type CallUser: CallUserSlack | CallUserExternal; -``` - -## Description - -For use in representing [users in a Slack Call](https://api.slack.com/apis/calls#users). - -## Defined in - -[calls.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/calls.ts#L8) diff --git a/docs/content/reference/types/type-aliases/ColorScheme.md b/docs/content/reference/types/type-aliases/ColorScheme.md deleted file mode 100644 index a23397a0c..000000000 --- a/docs/content/reference/types/type-aliases/ColorScheme.md +++ /dev/null @@ -1,12 +0,0 @@ -# Type Alias: ColorScheme - -```ts -type ColorScheme: "primary" | "danger"; -``` - -Re-usable labels for common color schemes present in Slack. `danger` displays with a red background (red text on -mobile), while `primary` displays with a green background (green text on mobile). - -## Defined in - -[block-kit/composition-objects.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L7) diff --git a/docs/content/reference/types/type-aliases/ContextBlockElement.md b/docs/content/reference/types/type-aliases/ContextBlockElement.md deleted file mode 100644 index 7c2f6f144..000000000 --- a/docs/content/reference/types/type-aliases/ContextBlockElement.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: ContextBlockElement - -```ts -type ContextBlockElement: ImageElement | TextObject; -``` - -A helper union type of all Block Elements that can be used in a [ContextBlock](../interfaces/ContextBlock.md). - -## See - -[Context block reference](https://api.slack.com/reference/block-kit/blocks#context). - -## Defined in - -[block-kit/blocks.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L87) diff --git a/docs/content/reference/types/type-aliases/ConversationFilter.md b/docs/content/reference/types/type-aliases/ConversationFilter.md deleted file mode 100644 index 30bbeea5d..000000000 --- a/docs/content/reference/types/type-aliases/ConversationFilter.md +++ /dev/null @@ -1,18 +0,0 @@ -# Type Alias: ConversationFilter - -```ts -type ConversationFilter: BaseConversationFilter & Required> | BaseConversationFilter & Required> | BaseConversationFilter & Required>; -``` - -## Description - -Defines a filter for the list of options in a conversation selector menu. The menu can be either a -conversations select menu or a conversations multi-select menu. - -## See - -[Conversation filter object reference](https://api.slack.com/reference/block-kit/composition-objects#filter_conversations). - -## Defined in - -[block-kit/composition-objects.ts:199](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L199) diff --git a/docs/content/reference/types/type-aliases/ConversationType.md b/docs/content/reference/types/type-aliases/ConversationType.md deleted file mode 100644 index 5d09b5698..000000000 --- a/docs/content/reference/types/type-aliases/ConversationType.md +++ /dev/null @@ -1,11 +0,0 @@ -# Type Alias: ConversationType - -```ts -type ConversationType: "im" | "mpim" | "private" | "public"; -``` - -The conversation type as available within the Slack UI. - -## Defined in - -[block-kit/composition-objects.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L10) diff --git a/docs/content/reference/types/type-aliases/ImageBlock.md b/docs/content/reference/types/type-aliases/ImageBlock.md deleted file mode 100644 index e45c98b4b..000000000 --- a/docs/content/reference/types/type-aliases/ImageBlock.md +++ /dev/null @@ -1,51 +0,0 @@ -# Type Alias: ImageBlock - -```ts -type ImageBlock: object & Block & UrlImageObject | SlackFileImageObject; -``` - -## Type declaration - -### alt\_text - -```ts -alt_text: string; -``` - -#### Description - -A plain-text summary of the image. This should not contain any markup. -Maximum length for this field is 2000 characters. - -### title? - -```ts -optional title: PlainTextElement; -``` - -#### Description - -An optional title for the image in the form of a [PlainTextElement](../interfaces/PlainTextElement.md) object. -Maximum length for the text in this field is 2000 characters. - -### type - -```ts -type: "image"; -``` - -#### Description - -The type of block. For an image block, `type` is always `image`. - -## Description - -Displays an image. A simple image block, designed to make those cat photos really pop. - -## See - -[Image block reference](https://api.slack.com/reference/block-kit/blocks#image). - -## Defined in - -[block-kit/blocks.ts:160](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L160) diff --git a/docs/content/reference/types/type-aliases/ImageElement.md b/docs/content/reference/types/type-aliases/ImageElement.md deleted file mode 100644 index 09634fe96..000000000 --- a/docs/content/reference/types/type-aliases/ImageElement.md +++ /dev/null @@ -1,40 +0,0 @@ -# Type Alias: ImageElement - -```ts -type ImageElement: object & UrlImageObject | SlackFileImageObject; -``` - -## Type declaration - -### alt\_text - -```ts -alt_text: string; -``` - -#### Description - -A plain-text summary of the image. This should not contain any markup. - -### type - -```ts -type: "image"; -``` - -#### Description - -The type of element. In this case `type` is always `image`. - -## Description - -Displays an image as part of a larger block of content. Use this `image` block if you want a block with -only an image in it. - -## See - -[Image element reference](https://api.slack.com/reference/block-kit/block-elements#image). - -## Defined in - -[block-kit/block-elements.ts:177](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L177) diff --git a/docs/content/reference/types/type-aliases/InputBlockElement.md b/docs/content/reference/types/type-aliases/InputBlockElement.md deleted file mode 100644 index 5fcf50d79..000000000 --- a/docs/content/reference/types/type-aliases/InputBlockElement.md +++ /dev/null @@ -1,28 +0,0 @@ -# Type Alias: InputBlockElement - -```ts -type InputBlockElement: - | Checkboxes - | Datepicker - | DateTimepicker - | EmailInput - | FileInput - | MultiSelect - | NumberInput - | PlainTextInput - | RadioButtons - | RichTextInput - | Select - | Timepicker - | URLInput; -``` - -A helper union type of all Block Elements that can be used in an [InputBlock](../interfaces/InputBlock.md). - -## See - -[Input block reference](https://api.slack.com/reference/block-kit/blocks#input). - -## Defined in - -[block-kit/blocks.ts:181](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L181) diff --git a/docs/content/reference/types/type-aliases/KnownBlock.md b/docs/content/reference/types/type-aliases/KnownBlock.md deleted file mode 100644 index 3a5dcfe4c..000000000 --- a/docs/content/reference/types/type-aliases/KnownBlock.md +++ /dev/null @@ -1,22 +0,0 @@ -# Type Alias: KnownBlock - -```ts -type KnownBlock: - | ImageBlock - | ContextBlock - | ActionsBlock - | DividerBlock - | SectionBlock - | InputBlock - | FileBlock - | HeaderBlock - | VideoBlock - | RichTextBlock; -``` - -A helper union type of all known Blocks, as listed out on the -[Blocks reference](https://api.slack.com/reference/block-kit/blocks). - -## Defined in - -[block-kit/blocks.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L51) diff --git a/docs/content/reference/types/type-aliases/MultiSelect.md b/docs/content/reference/types/type-aliases/MultiSelect.md deleted file mode 100644 index 9349dd299..000000000 --- a/docs/content/reference/types/type-aliases/MultiSelect.md +++ /dev/null @@ -1,28 +0,0 @@ -# Type Alias: MultiSelect - -```ts -type MultiSelect: - | MultiUsersSelect - | MultiStaticSelect - | MultiConversationsSelect - | MultiChannelsSelect - | MultiExternalSelect; -``` - -## Description - -Allows users to select multiple items from a list of options. -Just like regular [Select](Select.md), multi-select menus also include type-ahead functionality, where a user can type a -part or all of an option string to filter the list. -There are different types of multi-select menu that depend on different data sources for their lists of options: -[MultiStaticSelect](../interfaces/MultiStaticSelect.md), [MultiExternalSelect](../interfaces/MultiExternalSelect.md), [MultiUsersSelect](../interfaces/MultiUsersSelect.md), [MultiConversationsSelect](../interfaces/MultiConversationsSelect.md), -[MultiChannelsSelect](../interfaces/MultiChannelsSelect.md). - -## See - - - [Multi-select menu element reference](https://api.slack.com/reference/block-kit/block-elements#multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Defined in - -[block-kit/block-elements.ts:219](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L219) diff --git a/docs/content/reference/types/type-aliases/Option.md b/docs/content/reference/types/type-aliases/Option.md deleted file mode 100644 index 39e635be1..000000000 --- a/docs/content/reference/types/type-aliases/Option.md +++ /dev/null @@ -1,18 +0,0 @@ -# Type Alias: Option - -```ts -type Option: MrkdwnOption | PlainTextOption; -``` - -## Description - -Defines a single item in a number of item selection elements. An object that represents a single -selectable item in a select menu, multi-select menu, checkbox group, radio button group, or overflow menu. - -## See - -[Option object reference](https://api.slack.com/reference/block-kit/composition-objects#option). - -## Defined in - -[block-kit/composition-objects.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L109) diff --git a/docs/content/reference/types/type-aliases/RichTextBlockElement.md b/docs/content/reference/types/type-aliases/RichTextBlockElement.md deleted file mode 100644 index be2858fbf..000000000 --- a/docs/content/reference/types/type-aliases/RichTextBlockElement.md +++ /dev/null @@ -1,15 +0,0 @@ -# Type Alias: RichTextBlockElement - -```ts -type RichTextBlockElement: RichTextSection | RichTextList | RichTextQuote | RichTextPreformatted; -``` - -A helper union type of all Block Elements that can be used in a [RichTextBlock](../interfaces/RichTextBlock.md). - -## See - -[Rich text block reference](https://api.slack.com/reference/block-kit/blocks#rich_text). - -## Defined in - -[block-kit/blocks.ts:225](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L225) diff --git a/docs/content/reference/types/type-aliases/RichTextElement.md b/docs/content/reference/types/type-aliases/RichTextElement.md deleted file mode 100644 index 55615e02d..000000000 --- a/docs/content/reference/types/type-aliases/RichTextElement.md +++ /dev/null @@ -1,23 +0,0 @@ -# Type Alias: RichTextElement - -```ts -type RichTextElement: - | RichTextBroadcastMention - | RichTextColor - | RichTextChannelMention - | RichTextDate - | RichTextEmoji - | RichTextLink - | RichTextTeamMention - | RichTextText - | RichTextUserMention - | RichTextUsergroupMention; -``` - -## Description - -Union of rich text sub-elements for use within rich text blocks. - -## Defined in - -[block-kit/block-elements.ts:946](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L946) diff --git a/docs/content/reference/types/type-aliases/SectionBlockAccessory.md b/docs/content/reference/types/type-aliases/SectionBlockAccessory.md deleted file mode 100644 index 8be75659f..000000000 --- a/docs/content/reference/types/type-aliases/SectionBlockAccessory.md +++ /dev/null @@ -1,25 +0,0 @@ -# Type Alias: SectionBlockAccessory - -```ts -type SectionBlockAccessory: - | Button - | Checkboxes - | Datepicker - | ImageElement - | MultiSelect - | Overflow - | RadioButtons - | Select - | Timepicker - | WorkflowButton; -``` - -A helper union type of all Block Elements that can be used as an accessory in a [SectionBlock](../interfaces/SectionBlock.md). - -## See - -[Section block reference](https://api.slack.com/reference/block-kit/blocks#section). - -## Defined in - -[block-kit/blocks.ts:248](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L248) diff --git a/docs/content/reference/types/type-aliases/Select.md b/docs/content/reference/types/type-aliases/Select.md deleted file mode 100644 index a273bb517..000000000 --- a/docs/content/reference/types/type-aliases/Select.md +++ /dev/null @@ -1,27 +0,0 @@ -# Type Alias: Select - -```ts -type Select: - | UsersSelect - | StaticSelect - | ConversationsSelect - | ChannelsSelect - | ExternalSelect; -``` - -## Description - -Allows users to choose an option from a drop down menu. -The select menu also includes type-ahead functionality, where a user can type a part or all of an option string to -filter the list. There are different types of select menu elements that depend on different data sources for their -lists of options: [StaticSelect](../interfaces/StaticSelect.md), [ExternalSelect](../interfaces/ExternalSelect.md), [UsersSelect](../interfaces/UsersSelect.md), [ConversationsSelect](../interfaces/ConversationsSelect.md), -[ChannelsSelect](../interfaces/ChannelsSelect.md). - -## See - - - [Select menu element reference](https://api.slack.com/reference/block-kit/block-elements#select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Defined in - -[block-kit/block-elements.ts:202](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L202) diff --git a/docs/content/reference/types/type-aliases/SlackFile.md b/docs/content/reference/types/type-aliases/SlackFile.md deleted file mode 100644 index a10524f10..000000000 --- a/docs/content/reference/types/type-aliases/SlackFile.md +++ /dev/null @@ -1,20 +0,0 @@ -# Type Alias: SlackFile - -```ts -type SlackFile: SlackFileViaUrl | SlackFileViaId; -``` - -## Description - -Defines an object containing Slack file information to be used in an image block or image element. -This file https://api.slack.com/types/file must be an image and you must provide either the URL or ID. In addition, -the user posting these blocks must have access to this file. If both are provided then the payload will be rejected. -Currently only `png`, `jpg`, `jpeg`, and `gif` Slack image files are supported. - -## See - -[Slack File object reference](https://api.slack.com/reference/block-kit/composition-objects#slack_file). - -## Defined in - -[block-kit/composition-objects.ts:241](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L241) diff --git a/docs/content/reference/types/type-aliases/TextObject.md b/docs/content/reference/types/type-aliases/TextObject.md deleted file mode 100644 index 4272bcf77..000000000 --- a/docs/content/reference/types/type-aliases/TextObject.md +++ /dev/null @@ -1,18 +0,0 @@ -# Type Alias: TextObject - -```ts -type TextObject: PlainTextElement | MrkdwnElement; -``` - -## Description - -Defines an object containing some text. Can be either a [PlainTextElement](../interfaces/PlainTextElement.md) or a -[MrkdwnElement](../interfaces/MrkdwnElement.md). - -## See - -[Text object reference](https://api.slack.com/reference/block-kit/composition-objects#text). - -## Defined in - -[block-kit/composition-objects.ts:132](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L132) diff --git a/docs/content/reference/types/type-aliases/View.md b/docs/content/reference/types/type-aliases/View.md deleted file mode 100644 index ae64f48b1..000000000 --- a/docs/content/reference/types/type-aliases/View.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: View - -```ts -type View: HomeView | ModalView | WorkflowStepView; -``` - -## Defined in - -[views.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/views.ts#L76) diff --git a/docs/content/reference/types/typedoc-sidebar.cjs b/docs/content/reference/types/typedoc-sidebar.cjs deleted file mode 100644 index b80315b65..000000000 --- a/docs/content/reference/types/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/types/interfaces/Action","label":"Action"},{"type":"doc","id":"reference/types/interfaces/Actionable","label":"Actionable"},{"type":"doc","id":"reference/types/interfaces/ActionsBlock","label":"ActionsBlock"},{"type":"doc","id":"reference/types/interfaces/Block","label":"Block"},{"type":"doc","id":"reference/types/interfaces/Button","label":"Button"},{"type":"doc","id":"reference/types/interfaces/CallUserExternal","label":"CallUserExternal"},{"type":"doc","id":"reference/types/interfaces/CallUserSlack","label":"CallUserSlack"},{"type":"doc","id":"reference/types/interfaces/ChannelsSelect","label":"ChannelsSelect"},{"type":"doc","id":"reference/types/interfaces/Checkboxes","label":"Checkboxes"},{"type":"doc","id":"reference/types/interfaces/Confirm","label":"Confirm"},{"type":"doc","id":"reference/types/interfaces/Confirmable","label":"Confirmable"},{"type":"doc","id":"reference/types/interfaces/Confirmation","label":"Confirmation"},{"type":"doc","id":"reference/types/interfaces/ConfirmationDialog","label":"ConfirmationDialog"},{"type":"doc","id":"reference/types/interfaces/ContextBlock","label":"ContextBlock"},{"type":"doc","id":"reference/types/interfaces/ConversationsSelect","label":"ConversationsSelect"},{"type":"doc","id":"reference/types/interfaces/DateTimepicker","label":"DateTimepicker"},{"type":"doc","id":"reference/types/interfaces/Datepicker","label":"Datepicker"},{"type":"doc","id":"reference/types/interfaces/Dialog","label":"Dialog"},{"type":"doc","id":"reference/types/interfaces/DispatchActionConfig","label":"DispatchActionConfig"},{"type":"doc","id":"reference/types/interfaces/Dispatchable","label":"Dispatchable"},{"type":"doc","id":"reference/types/interfaces/DividerBlock","label":"DividerBlock"},{"type":"doc","id":"reference/types/interfaces/EmailInput","label":"EmailInput"},{"type":"doc","id":"reference/types/interfaces/ExternalSelect","label":"ExternalSelect"},{"type":"doc","id":"reference/types/interfaces/FileBlock","label":"FileBlock"},{"type":"doc","id":"reference/types/interfaces/FileInput","label":"FileInput"},{"type":"doc","id":"reference/types/interfaces/Focusable","label":"Focusable"},{"type":"doc","id":"reference/types/interfaces/HeaderBlock","label":"HeaderBlock"},{"type":"doc","id":"reference/types/interfaces/HomeView","label":"HomeView"},{"type":"doc","id":"reference/types/interfaces/InputBlock","label":"InputBlock"},{"type":"doc","id":"reference/types/interfaces/LinkUnfurls","label":"LinkUnfurls"},{"type":"doc","id":"reference/types/interfaces/MaxItemsSelectable","label":"MaxItemsSelectable"},{"type":"doc","id":"reference/types/interfaces/MessageAttachment","label":"MessageAttachment"},{"type":"doc","id":"reference/types/interfaces/MessageAttachmentField","label":"MessageAttachmentField"},{"type":"doc","id":"reference/types/interfaces/MessageMetadata","label":"MessageMetadata"},{"type":"doc","id":"reference/types/interfaces/MessageMetadataEventPayloadObject","label":"MessageMetadataEventPayloadObject"},{"type":"doc","id":"reference/types/interfaces/ModalView","label":"ModalView"},{"type":"doc","id":"reference/types/interfaces/MrkdwnElement","label":"MrkdwnElement"},{"type":"doc","id":"reference/types/interfaces/MrkdwnOption","label":"MrkdwnOption"},{"type":"doc","id":"reference/types/interfaces/MultiChannelsSelect","label":"MultiChannelsSelect"},{"type":"doc","id":"reference/types/interfaces/MultiConversationsSelect","label":"MultiConversationsSelect"},{"type":"doc","id":"reference/types/interfaces/MultiExternalSelect","label":"MultiExternalSelect"},{"type":"doc","id":"reference/types/interfaces/MultiStaticSelect","label":"MultiStaticSelect"},{"type":"doc","id":"reference/types/interfaces/MultiUsersSelect","label":"MultiUsersSelect"},{"type":"doc","id":"reference/types/interfaces/NumberInput","label":"NumberInput"},{"type":"doc","id":"reference/types/interfaces/OptionGroup","label":"OptionGroup"},{"type":"doc","id":"reference/types/interfaces/Overflow","label":"Overflow"},{"type":"doc","id":"reference/types/interfaces/Placeholdable","label":"Placeholdable"},{"type":"doc","id":"reference/types/interfaces/PlainTextElement","label":"PlainTextElement"},{"type":"doc","id":"reference/types/interfaces/PlainTextInput","label":"PlainTextInput"},{"type":"doc","id":"reference/types/interfaces/PlainTextOption","label":"PlainTextOption"},{"type":"doc","id":"reference/types/interfaces/RadioButtons","label":"RadioButtons"},{"type":"doc","id":"reference/types/interfaces/RichTextBlock","label":"RichTextBlock"},{"type":"doc","id":"reference/types/interfaces/RichTextBorderable","label":"RichTextBorderable"},{"type":"doc","id":"reference/types/interfaces/RichTextBroadcastMention","label":"RichTextBroadcastMention"},{"type":"doc","id":"reference/types/interfaces/RichTextChannelMention","label":"RichTextChannelMention"},{"type":"doc","id":"reference/types/interfaces/RichTextColor","label":"RichTextColor"},{"type":"doc","id":"reference/types/interfaces/RichTextDate","label":"RichTextDate"},{"type":"doc","id":"reference/types/interfaces/RichTextEmoji","label":"RichTextEmoji"},{"type":"doc","id":"reference/types/interfaces/RichTextInput","label":"RichTextInput"},{"type":"doc","id":"reference/types/interfaces/RichTextLink","label":"RichTextLink"},{"type":"doc","id":"reference/types/interfaces/RichTextList","label":"RichTextList"},{"type":"doc","id":"reference/types/interfaces/RichTextPreformatted","label":"RichTextPreformatted"},{"type":"doc","id":"reference/types/interfaces/RichTextQuote","label":"RichTextQuote"},{"type":"doc","id":"reference/types/interfaces/RichTextSection","label":"RichTextSection"},{"type":"doc","id":"reference/types/interfaces/RichTextStyleable","label":"RichTextStyleable"},{"type":"doc","id":"reference/types/interfaces/RichTextTeamMention","label":"RichTextTeamMention"},{"type":"doc","id":"reference/types/interfaces/RichTextText","label":"RichTextText"},{"type":"doc","id":"reference/types/interfaces/RichTextUserMention","label":"RichTextUserMention"},{"type":"doc","id":"reference/types/interfaces/RichTextUsergroupMention","label":"RichTextUsergroupMention"},{"type":"doc","id":"reference/types/interfaces/SectionBlock","label":"SectionBlock"},{"type":"doc","id":"reference/types/interfaces/SelectOption","label":"SelectOption"},{"type":"doc","id":"reference/types/interfaces/SlackFileImageObject","label":"SlackFileImageObject"},{"type":"doc","id":"reference/types/interfaces/StaticSelect","label":"StaticSelect"},{"type":"doc","id":"reference/types/interfaces/Timepicker","label":"Timepicker"},{"type":"doc","id":"reference/types/interfaces/URLInput","label":"URLInput"},{"type":"doc","id":"reference/types/interfaces/URLRespondable","label":"URLRespondable"},{"type":"doc","id":"reference/types/interfaces/UrlImageObject","label":"UrlImageObject"},{"type":"doc","id":"reference/types/interfaces/UsersSelect","label":"UsersSelect"},{"type":"doc","id":"reference/types/interfaces/VideoBlock","label":"VideoBlock"},{"type":"doc","id":"reference/types/interfaces/WorkflowButton","label":"WorkflowButton"},{"type":"doc","id":"reference/types/interfaces/WorkflowStepView","label":"WorkflowStepView"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/types/type-aliases/ActionsBlockElement","label":"ActionsBlockElement"},{"type":"doc","id":"reference/types/type-aliases/AnyBlock","label":"AnyBlock"},{"type":"doc","id":"reference/types/type-aliases/CallUser","label":"CallUser"},{"type":"doc","id":"reference/types/type-aliases/ColorScheme","label":"ColorScheme"},{"type":"doc","id":"reference/types/type-aliases/ContextBlockElement","label":"ContextBlockElement"},{"type":"doc","id":"reference/types/type-aliases/ConversationFilter","label":"ConversationFilter"},{"type":"doc","id":"reference/types/type-aliases/ConversationType","label":"ConversationType"},{"type":"doc","id":"reference/types/type-aliases/ImageBlock","label":"ImageBlock"},{"type":"doc","id":"reference/types/type-aliases/ImageElement","label":"ImageElement"},{"type":"doc","id":"reference/types/type-aliases/InputBlockElement","label":"InputBlockElement"},{"type":"doc","id":"reference/types/type-aliases/KnownBlock","label":"KnownBlock"},{"type":"doc","id":"reference/types/type-aliases/MultiSelect","label":"MultiSelect"},{"type":"doc","id":"reference/types/type-aliases/Option","label":"Option"},{"type":"doc","id":"reference/types/type-aliases/RichTextBlockElement","label":"RichTextBlockElement"},{"type":"doc","id":"reference/types/type-aliases/RichTextElement","label":"RichTextElement"},{"type":"doc","id":"reference/types/type-aliases/SectionBlockAccessory","label":"SectionBlockAccessory"},{"type":"doc","id":"reference/types/type-aliases/Select","label":"Select"},{"type":"doc","id":"reference/types/type-aliases/SlackFile","label":"SlackFile"},{"type":"doc","id":"reference/types/type-aliases/TextObject","label":"TextObject"},{"type":"doc","id":"reference/types/type-aliases/View","label":"View"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/web-api/classes/Methods.md b/docs/content/reference/web-api/classes/Methods.md deleted file mode 100644 index d97471ed3..000000000 --- a/docs/content/reference/web-api/classes/Methods.md +++ /dev/null @@ -1,4593 +0,0 @@ -# Class: `abstract` Methods - -A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the -`apiCall` class method. - -## Extends - -- `EventEmitter`\<[`WebClientEvent`](../enumerations/WebClientEvent.md)\> - -## Extended by - -- [`WebClient`](WebClient.md) - -## Constructors - -### new Methods() - -```ts -protected new Methods(): Methods -``` - -#### Returns - -[`Methods`](Methods.md) - -#### Overrides - -`EventEmitter.constructor` - -#### Defined in - -[packages/web-api/src/methods.ts:534](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L534) - -## Properties - -### admin - -```ts -readonly admin: object; -``` - -#### analytics - -```ts -analytics: object; -``` - -#### analytics.getFile - -```ts -getFile: Method; -``` - -##### Description - -Retrieve analytics data for a given date, presented as a compressed JSON file. - -##### See - -[`api.test` API reference](https://api.slack.com/methods/api.test). - -#### apps - -```ts -apps: object; -``` - -#### apps.activities - -```ts -activities: object; -``` - -#### apps.activities.list - -```ts -list: Method; -``` - -##### Description - -Get logs for a specified team/org. - -##### See - -[`admin.apps.activities.list` API reference](https://api.slack.com/methods/admin.apps.activities.list). - -#### apps.approve - -```ts -approve: Method; -``` - -##### Description - -Approve an app for installation on a workspace. - -##### See - -[`admin.apps.approve` API reference](https://api.slack.com/methods/admin.apps.approve). - -#### apps.approved - -```ts -approved: object; -``` - -#### apps.approved.list - -```ts -list: Method; -``` - -##### Description - -List approved apps for an org or workspace. - -##### See - -[`admin.apps.approved.list` API reference](https://api.slack.com/methods/admin.apps.approved.list). - -#### apps.clearResolution - -```ts -clearResolution: Method; -``` - -##### Description - -Clear an app resolution. - -##### See - -[`admin.apps.clearResolution` API reference](https://api.slack.com/methods/admin.apps.clearResolution). - -#### apps.config - -```ts -config: object; -``` - -#### apps.config.lookup - -```ts -lookup: Method; -``` - -##### Description - -Look up the app config for connectors by their IDs. - -##### See - -[`admin.apps.config.lookup` API reference](https://api.slack.com/methods/admin.apps.config.lookup). - -#### apps.config.set - -```ts -set: Method; -``` - -##### Description - -Set the app config for a connector. - -##### See - -[`admin.apps.config.set` API reference](https://api.slack.com/methods/admin.apps.config.set). - -#### apps.requests - -```ts -requests: object; -``` - -#### apps.requests.cancel - -```ts -cancel: Method; -``` - -##### Description - -Cancel app request for team. - -##### See - -[`admin.apps.requests.cancel` API reference](https://api.slack.com/methods/admin.apps.requests.cancel). - -#### apps.requests.list - -```ts -list: Method; -``` - -##### Description - -List app requests for a team/workspace. - -##### See - -[`admin.apps.requests.list` API reference](https://api.slack.com/methods/admin.apps.requests.list). - -#### apps.restrict - -```ts -restrict: Method; -``` - -##### Description - -Restrict an app for installation on a workspace. - -##### See - -[`admin.apps.restrict` API reference](https://api.slack.com/methods/admin.apps.restrict). - -#### apps.restricted - -```ts -restricted: object; -``` - -#### apps.restricted.list - -```ts -list: Method; -``` - -##### Description - -List restricted apps for an org or workspace. - -##### See - -[`admin.apps.restricted.list` API reference](https://api.slack.com/methods/admin.apps.restricted.list). - -#### apps.uninstall - -```ts -uninstall: Method; -``` - -##### Description - -Uninstall an app from one or many workspaces, or an entire enterprise organization. - -##### See - -[`admin.apps.uninstall` API reference](https://api.slack.com/methods/admin.apps.uninstall). - -#### auth - -```ts -auth: object; -``` - -#### auth.policy - -```ts -policy: object; -``` - -#### auth.policy.assignEntities - -```ts -assignEntities: Method; -``` - -##### Description - -Assign entities to a particular authentication policy. - -##### See - -[`admin.auth.policy.assignEntities` API reference](https://api.slack.com/methods/admin.auth.policy.assignEntities). - -#### auth.policy.getEntities - -```ts -getEntities: Method; -``` - -##### Description - -Fetch all the entities assigned to a particular authentication policy by name. - -##### See - -[`admin.auth.policy.getEntities` API reference](https://api.slack.com/methods/admin.auth.policy.getEntities). - -#### auth.policy.removeEntities - -```ts -removeEntities: Method; -``` - -##### Description - -Remove specified entities from a specified authentication policy. - -##### See - -[`admin.auth.policy.removeEntities` API reference](https://api.slack.com/methods/admin.auth.policy.removeEntities). - -#### barriers - -```ts -barriers: object; -``` - -#### barriers.create - -```ts -create: Method; -``` - -##### Description - -Create an Information Barrier. - -##### See - -[`admin.barriers.create` API reference](https://api.slack.com/methods/admin.barriers.create). - -#### barriers.delete - -```ts -delete: Method; -``` - -##### Description - -Delete an existing Information Barrier. - -##### See - -[`admin.barriers.delete` API reference](https://api.slack.com/methods/admin.barriers.delete). - -#### barriers.list - -```ts -list: Method; -``` - -##### Description - -Get all Information Barriers for your organization. - -##### See - -[`admin.barriers.list` API reference](https://api.slack.com/methods/admin.barriers.list). - -#### barriers.update - -```ts -update: Method; -``` - -##### Description - -Update an existing Information Barrier. - -##### See - -[`admin.barriers.update` API reference](https://api.slack.com/methods/admin.barriers.update). - -#### conversations - -```ts -conversations: object; -``` - -#### conversations.archive - -```ts -archive: Method; -``` - -##### Description - -Archive a public or private channel. - -##### See - -[`admin.conversations.archive` API reference](https://api.slack.com/methods/admin.conversations.archive). - -#### conversations.bulkArchive - -```ts -bulkArchive: Method; -``` - -##### Description - -Archive public or private channels in bulk. - -##### See - -[`admin.conversations.bulkArchive` API reference](https://api.slack.com/methods/admin.conversations.bulkArchive). - -#### conversations.bulkDelete - -```ts -bulkDelete: Method; -``` - -##### Description - -Delete public or private channels in bulk. - -##### See - -[`admin.conversations.bulkDelete` API reference](https://api.slack.com/methods/admin.conversations.bulkDelet). - -#### conversations.bulkMove - -```ts -bulkMove: Method; -``` - -##### Description - -Move public or private channels in bulk. - -##### See - -[`admin.conversations.bulkMove` API reference](https://api.slack.com/methods/admin.conversations.bulkMove). - -#### conversations.convertToPrivate - -```ts -convertToPrivate: Method; -``` - -##### Description - -Convert a public channel to a private channel. - -##### See - -[`admin.conversations.convertToPrivate` API reference](https://api.slack.com/methods/admin.conversations.convertToPrivate). - -#### conversations.convertToPublic - -```ts -convertToPublic: Method; -``` - -##### Description - -Convert a private channel to a public channel. - -##### See - -[`admin.conversations.convertToPublic` API reference](https://api.slack.com/methods/admin.conversations.convertToPublic). - -#### conversations.create - -```ts -create: Method; -``` - -##### Description - -Create a public or private channel-based conversation. - -##### See - -[`admin.conversations.create` API reference](https://api.slack.com/methods/admin.conversations.create). - -#### conversations.delete - -```ts -delete: Method; -``` - -##### Description - -Delete a public or private channel. - -##### See - -[`admin.conversations.delete` API reference](https://api.slack.com/methods/admin.conversations.delete). - -#### conversations.disconnectShared - -```ts -disconnectShared: Method; -``` - -##### Description - -Disconnect a connected channel from one or more workspaces. - -##### See - -[`admin.conversations.disconnectShared` API reference](https://api.slack.com/methods/admin.conversations.disconnectShared). - -#### conversations.ekm - -```ts -ekm: object; -``` - -#### conversations.ekm.listOriginalConnectedChannelInfo - -```ts -listOriginalConnectedChannelInfo: Method; -``` - -##### Description - -List all disconnected channels — i.e., channels that were once connected to other workspaces -and then disconnected — and the corresponding original channel IDs for key revocation with EKM. - -##### See - -[`admin.conversations.ekm.listOriginalConnectedChannelInfo` API reference](https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo). - -#### conversations.getConversationPrefs - -```ts -getConversationPrefs: Method; -``` - -##### Description - -Get conversation preferences for a public or private channel. - -##### See - -[`admin.conversations.getConversationPrefs` API reference](https://api.slack.com/methods/admin.conversations.getConversationPrefs). - -#### conversations.getCustomRetention - -```ts -getCustomRetention: Method; -``` - -##### Description - -Get a conversation's retention policy. - -##### See - -[`admin.conversations.getCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.getCustomRetention). - -#### conversations.getTeams - -```ts -getTeams: Method; -``` - -##### Description - -Get all the workspaces a given public or private channel is connected to within -this Enterprise org. - -##### See - -[`admin.conversations.getTeams` API reference](https://api.slack.com/methods/admin.conversations.getTeams). - -#### conversations.invite - -```ts -invite: Method; -``` - -##### Description - -Invite a user to a public or private channel. - -##### See - -[`admin.conversations.invite` API reference](https://api.slack.com/methods/admin.conversations.invite). - -#### conversations.lookup - -```ts -lookup: Method; -``` - -##### Description - -Returns channels on the given team using the filters. - -##### See - -[`admin.conversations.lookup` API reference](https://api.slack.com/methods/admin.conversations.lookup). - -#### conversations.removeCustomRetention - -```ts -removeCustomRetention: Method; -``` - -##### Description - -Remove a conversation's retention policy. - -##### See - -[`admin.conversations.removeCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.removeCustomRetention). - -#### conversations.rename - -```ts -rename: Method; -``` - -##### Description - -Rename a public or private channel. - -##### See - -[`admin.conversations.rename` API reference](https://api.slack.com/methods/admin.conversations.rename). - -#### conversations.restrictAccess - -```ts -restrictAccess: object; -``` - -#### conversations.restrictAccess.addGroup - -```ts -addGroup: Method; -``` - -##### Description - -Add an allowlist of IDP groups for accessing a channel. - -##### See - -[`admin.conversations.restrictAccess.addGroup` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup). - -#### conversations.restrictAccess.listGroups - -```ts -listGroups: Method; -``` - -##### Description - -List all IDP Groups linked to a channel. - -##### See - -[`admin.conversations.restrictAccess.listGroups` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups). - -#### conversations.restrictAccess.removeGroup - -```ts -removeGroup: Method; -``` - -##### Description - -Remove a linked IDP group linked from a private channel. - -##### See - -[`admin.conversations.restrictAccess.removeGroup` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup). - -#### conversations.search - -```ts -search: Method; -``` - -##### Description - -Search for public or private channels in an Enterprise organization. - -##### See - -[`admin.conversations.search` API reference](https://api.slack.com/methods/admin.conversations.search). - -#### conversations.setConversationPrefs - -```ts -setConversationPrefs: Method; -``` - -##### Description - -Set the posting permissions for a public or private channel. - -##### See - -[`admin.conversations.setConversationPrefs` API reference](https://api.slack.com/methods/admin.conversations.setConversationPrefs). - -#### conversations.setCustomRetention - -```ts -setCustomRetention: Method; -``` - -##### Description - -Set a conversation's retention policy. - -##### See - -[`admin.conversations.setCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.setCustomRetention). - -#### conversations.setTeams - -```ts -setTeams: Method; -``` - -##### Description - -Set the workspaces in an Enterprise grid org that connect to a public or private channel. - -##### See - -[`admin.conversations.setTeams` API reference](https://api.slack.com/methods/admin.conversations.setTeams). - -#### conversations.unarchive - -```ts -unarchive: Method; -``` - -##### Description - -Unarchive a public or private channel. - -##### See - -[`admin.conversations.unarchive` API reference](https://api.slack.com/methods/admin.conversations.unarchive). - -#### emoji - -```ts -emoji: object; -``` - -#### emoji.add - -```ts -add: Method; -``` - -##### Description - -Add an emoji. - -##### See - -[`admin.emoji.add` API reference](https://api.slack.com/methods/admin.emoji.add). - -#### emoji.addAlias - -```ts -addAlias: Method; -``` - -##### Description - -Add an emoji alias. - -##### See - -[`admin.emoji.addAlias` API reference](https://api.slack.com/methods/admin.emoji.addAlias). - -#### emoji.list - -```ts -list: Method; -``` - -##### Description - -List emoji for an Enterprise Grid organization. - -##### See - -[`admin.emoji.list` API reference](https://api.slack.com/methods/admin.emoji.list). - -#### emoji.remove - -```ts -remove: Method; -``` - -##### Description - -Remove an emoji across an Enterprise Grid organization. - -##### See - -[`admin.emoji.remove` API reference](https://api.slack.com/methods/admin.emoji.remove). - -#### emoji.rename - -```ts -rename: Method; -``` - -##### Description - -Rename an emoji. - -##### See - -[`admin.emoji.rename` API reference](https://api.slack.com/methods/admin.emoji.rename). - -#### functions - -```ts -functions: object; -``` - -#### functions.list - -```ts -list: Method; -``` - -##### Description - -Look up functions by a set of apps. - -##### See - -[`admin.functions.list` API reference](https://api.slack.com/methods/admin.functions.list). - -#### functions.permissions - -```ts -permissions: object; -``` - -#### functions.permissions.lookup - -```ts -lookup: Method; -``` - -##### Description - -Lookup the visibility of multiple Slack functions and include the users if -it is limited to particular named entities. - -##### See - -[`admin.functions.permissions.lookup` API reference](https://api.slack.com/methods/admin.functions.permissions.lookup). - -#### functions.permissions.set - -```ts -set: Method; -``` - -##### Description - -Set the visibility of a Slack function and define the users or workspaces if -it is set to named_entities. - -##### See - -[`admin.functions.permissions.set` API reference](https://api.slack.com/methods/admin.functions.permissions.set). - -#### inviteRequests - -```ts -inviteRequests: object; -``` - -#### inviteRequests.approve - -```ts -approve: Method; -``` - -##### Description - -Approve a workspace invite request. - -##### See - -[`admin.inviteRequests.approve` API reference](https://api.slack.com/methods/admin.inviteRequests.approve). - -#### inviteRequests.approved - -```ts -approved: object; -``` - -#### inviteRequests.approved.list - -```ts -list: Method; -``` - -##### Description - -List all approved workspace invite requests. - -##### See - -[`admin.inviteRequests.approved.list` API reference](https://api.slack.com/methods/admin.inviteRequests.approved.list). - -#### inviteRequests.denied - -```ts -denied: object; -``` - -#### inviteRequests.denied.list - -```ts -list: Method; -``` - -##### Description - -List all denied workspace invite requests. - -##### See - -[`admin.inviteRequests.denied.list` API reference](https://api.slack.com/methods/admin.inviteRequests.denied.list). - -#### inviteRequests.deny - -```ts -deny: Method; -``` - -##### Description - -Deny a workspace invite request. - -##### See - -[`admin.inviteRequests.deny` API reference](https://api.slack.com/methods/admin.inviteRequests.deny). - -#### inviteRequests.list - -```ts -list: Method; -``` - -##### Description - -List all pending workspace invite requests. - -##### See - -[`admin.inviteRequests.list` API reference](https://api.slack.com/methods/admin.inviteRequests.list). - -#### roles - -```ts -roles: object; -``` - -#### roles.addAssignments - -```ts -addAssignments: Method; -``` - -##### Description - -Adds members to the specified role with the specified scopes. - -##### See - -[`admin.roles.addAssignments` API reference](https://api.slack.com/methods/admin.roles.addAssignments). - -#### roles.listAssignments - -```ts -listAssignments: Method; -``` - -##### Description - -Lists assignments for all roles across entities. -Options to scope results by any combination of roles or entities. - -##### See - -[`admin.roles.listAssignments` API reference](https://api.slack.com/methods/admin.roles.listAssignments). - -#### roles.removeAssignments - -```ts -removeAssignments: Method; -``` - -##### Description - -Removes a set of users from a role for the given scopes and entities. - -##### See - -[`admin.roles.removeAssignments` API reference](https://api.slack.com/methods/admin.roles.removeAssignments). - -#### teams - -```ts -teams: object; -``` - -#### teams.admins - -```ts -admins: object; -``` - -#### teams.admins.list - -```ts -list: Method; -``` - -##### Description - -List all of the admins on a given workspace. - -##### See - -[`admin.teams.admins.list` API reference](https://api.slack.com/methods/admin.teams.admins.list). - -#### teams.create - -```ts -create: Method; -``` - -##### Description - -Create an Enterprise team. - -##### See - -[`admin.teams.create` API reference](https://api.slack.com/methods/admin.teams.create). - -#### teams.list - -```ts -list: Method; -``` - -##### Description - -List all teams on an Enterprise organization. - -##### See - -[`admin.teams.list` API reference](https://api.slack.com/methods/admin.teams.list). - -#### teams.owners - -```ts -owners: object; -``` - -#### teams.owners.list - -```ts -list: Method; -``` - -##### Description - -List all of the owners on a given workspace. - -##### See - -[`admin.teams.owners.list` API reference](https://api.slack.com/methods/admin.teams.owners.list). - -#### teams.settings - -```ts -settings: object; -``` - -#### teams.settings.info - -```ts -info: Method; -``` - -##### Description - -Fetch information about settings in a workspace. - -##### See - -[`admin.teams.owners.list` API reference](https://api.slack.com/methods/admin.teams.owners.list). - -#### teams.settings.setDefaultChannels - -```ts -setDefaultChannels: Method; -``` - -##### Description - -Set the default channels of a workspace. - -##### See - -[`admin.teams.settings.setDefaultChannels` API reference](https://api.slack.com/methods/admin.teams.settings.setDefaultChannels). - -#### teams.settings.setDescription - -```ts -setDescription: Method; -``` - -##### Description - -Set the description of a given workspace. - -##### See - -[`admin.teams.settings.setDescription` API reference](https://api.slack.com/methods/admin.teams.settings.setDescription). - -#### teams.settings.setDiscoverability - -```ts -setDiscoverability: Method; -``` - -##### Description - -Set the discoverability of a given workspace. - -##### See - -[`admin.teams.settings.setDiscoverability` API reference](https://api.slack.com/methods/admin.teams.settings.setDiscoverability). - -#### teams.settings.setIcon - -```ts -setIcon: Method; -``` - -##### Description - -Sets the icon of a workspace. - -##### See - -[`admin.teams.settings.setIcon` API reference](https://api.slack.com/methods/admin.teams.settings.setIcon). - -#### teams.settings.setName - -```ts -setName: Method; -``` - -##### Description - -Set the name of a given workspace. - -##### See - -[`admin.teams.settings.setName` API reference](https://api.slack.com/methods/admin.teams.settings.setName). - -#### usergroups - -```ts -usergroups: object; -``` - -#### usergroups.addChannels - -```ts -addChannels: Method; -``` - -##### Description - -Add up to one hundred default channels to an IDP group. - -##### See - -[`admin.teams.usergroups.addChannels` API reference](https://api.slack.com/methods/admin.usergroups.addChannels). - -#### usergroups.addTeams - -```ts -addTeams: Method; -``` - -##### Description - -Associate one or more default workspaces with an organization-wide IDP group. - -##### See - -[`admin.teams.usergroups.addTeams` API reference](https://api.slack.com/methods/admin.usergroups.addTeams). - -#### usergroups.listChannels - -```ts -listChannels: Method; -``` - -##### Description - -List the channels linked to an org-level IDP group (user group). - -##### See - -[`admin.teams.usergroups.listChannels` API reference](https://api.slack.com/methods/admin.usergroups.listChannels). - -#### usergroups.removeChannels - -```ts -removeChannels: Method; -``` - -##### Description - -Remove one or more default channels from an org-level IDP group (user group). - -##### See - -[`admin.teams.usergroups.removeChannels` API reference](https://api.slack.com/methods/admin.usergroups.removeChannels). - -#### users - -```ts -users: object; -``` - -#### users.assign - -```ts -assign: Method; -``` - -##### Description - -Add an Enterprise user to a workspace. - -##### See - -[`admin.users.assign` API reference](https://api.slack.com/methods/admin.users.assign). - -#### users.invite - -```ts -invite: Method; -``` - -##### Description - -Invite a user to a workspace. - -##### See - -[`admin.users.invite` API reference](https://api.slack.com/methods/admin.users.invite). - -#### users.list - -```ts -list: Method; -``` - -##### Description - -List users on a workspace. - -##### See - -[`admin.users.list` API reference](https://api.slack.com/methods/admin.users.list). - -#### users.remove - -```ts -remove: Method; -``` - -##### Description - -Remove a user from a workspace. - -##### See - -[`admin.users.remove` API reference](https://api.slack.com/methods/admin.users.remove). - -#### users.session - -```ts -session: object; -``` - -#### users.session.clearSettings - -```ts -clearSettings: Method; -``` - -##### Description - -Clear user-specific session settings—the session duration and what happens when the client -closes—for a list of users. - -##### See - -[`admin.users.session.clearSettings` API reference](https://api.slack.com/methods/admin.users.session.clearSettings). - -#### users.session.getSettings - -```ts -getSettings: Method; -``` - -##### Description - -Get user-specific session settings—the session duration and what happens when the client -closes—given a list of users. - -##### See - -[`admin.users.session.getSettings` API reference](https://api.slack.com/methods/admin.users.session.getSettings). - -#### users.session.invalidate - -```ts -invalidate: Method; -``` - -##### Description - -Revoke a single session for a user. The user will be forced to login to Slack. - -##### See - -[`admin.users.session.invalidate` API reference](https://api.slack.com/methods/admin.users.session.invalidate). - -#### users.session.list - -```ts -list: Method; -``` - -##### Description - -List active user sessions for an organization. - -##### See - -[`admin.users.session.list` API reference](https://api.slack.com/methods/admin.users.session.list). - -#### users.session.reset - -```ts -reset: Method; -``` - -##### Description - -Wipes all valid sessions on all devices for a given user. - -##### See - -[`admin.users.session.reset` API reference](https://api.slack.com/methods/admin.users.session.reset). - -#### users.session.resetBulk - -```ts -resetBulk: Method; -``` - -##### Description - -Enqueues an asynchronous job to wipe all valid sessions on all devices for a given user list. - -##### See - -[`admin.users.session.resetBulk` API reference](https://api.slack.com/methods/admin.users.session.resetBulk). - -#### users.session.setSettings - -```ts -setSettings: Method; -``` - -##### Description - -Configure the user-level session settings—the session duration and what happens when the client -closes—for one or more users. - -##### See - -[`admin.users.session.setSettings` API reference](https://api.slack.com/methods/admin.users.session.setSettings). - -#### users.setAdmin - -```ts -setAdmin: Method; -``` - -##### Description - -Set an existing guest, regular user, or owner to be an admin user. - -##### See - -[`admin.users.setAdmin` API reference](https://api.slack.com/methods/admin.users.setAdmin). - -#### users.setExpiration - -```ts -setExpiration: Method; -``` - -##### Description - -Set an expiration for a guest user. - -##### See - -[`admin.users.setExpiration` API reference](https://api.slack.com/methods/admin.users.setExpiration). - -#### users.setOwner - -```ts -setOwner: Method; -``` - -##### Description - -Set an existing guest, regular user, or admin user to be a workspace owner. - -##### See - -[`admin.users.setOwner` API reference](https://api.slack.com/methods/admin.users.setOwner). - -#### users.setRegular - -```ts -setRegular: Method; -``` - -##### Description - -Set an existing guest user, admin user, or owner to be a regular user. - -##### See - -[`admin.users.setRegular` API reference](https://api.slack.com/methods/admin.users.setRegular). - -#### users.unsupportedVersions - -```ts -unsupportedVersions: object; -``` - -#### users.unsupportedVersions.export - -```ts -export: Method; -``` - -##### Description - -Ask Slackbot to send you an export listing all workspace members using unsupported software, -presented as a zipped CSV file. - -##### See - -[`admin.users.unsupportedVersions.export` API reference](https://api.slack.com/methods/admin.users.unsupportedVersions.export). - -#### workflows - -```ts -workflows: object; -``` - -#### workflows.collaborators - -```ts -collaborators: object; -``` - -#### workflows.collaborators.add - -```ts -add: Method; -``` - -##### Description - -Add collaborators to workflows within the team or enterprise. - -##### See - -[`admin.workflows.collaborators.add` API reference](https://api.slack.com/methods/admin.workflows.collaborators.add). - -#### workflows.collaborators.remove - -```ts -remove: Method; -``` - -##### Description - -Remove collaborators from workflows within the team or enterprise. - -##### See - -[`admin.workflows.collaborators.remove` API reference](https://api.slack.com/methods/admin.workflows.collaborators.remove). - -#### workflows.permissions - -```ts -permissions: object; -``` - -#### workflows.permissions.lookup - -```ts -lookup: Method; -``` - -##### Description - -Look up the permissions for a set of workflows. - -##### See - -[`admin.workflows.permissions.lookup` API reference](https://api.slack.com/methods/admin.workflows.permissions.lookup). - -#### workflows.search - -```ts -search: Method; -``` - -##### Description - -Search workflows within the team or enterprise. - -##### See - -[`admin.workflows.search` API reference](https://api.slack.com/methods/admin.workflows.search). - -#### workflows.unpublish - -```ts -unpublish: Method; -``` - -##### Description - -Unpublish workflows within the team or enterprise. - -##### See - -[`admin.workflows.unpublish` API reference](https://api.slack.com/methods/admin.workflows.unpublish). - -#### Defined in - -[packages/web-api/src/methods.ts:546](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L546) - -*** - -### api - -```ts -readonly api: object; -``` - -#### test - -```ts -test: Method; -``` - -##### Description - -Checks API calling code. - -##### See - -[`api.test` API reference](https://api.slack.com/methods/api.test). - -#### Defined in - -[packages/web-api/src/methods.ts:1221](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1221) - -*** - -### apps - -```ts -readonly apps: object; -``` - -#### connections - -```ts -connections: object; -``` - -#### connections.open - -```ts -open: Method; -``` - -##### Description - -Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive -events and interactive payloads over. - -##### See - -[`apps.connections.open` API reference](https://api.slack.com/methods/apps.connections.open). - -#### event - -```ts -event: object; -``` - -#### event.authorizations - -```ts -authorizations: object; -``` - -#### event.authorizations.list - -```ts -list: Method; -``` - -##### Description - -Get a list of authorizations for the given event context. -Each authorization represents an app installation that the event is visible to. - -##### See - -[`apps.event.authorizations.list` API reference](https://api.slack.com/methods/apps.event.authorizations.list). - -#### manifest - -```ts -manifest: object; -``` - -#### manifest.create - -```ts -create: Method; -``` - -##### Description - -Create an app from an app manifest. - -##### See - -[`apps.manifest.create` API reference](https://api.slack.com/methods/apps.manifest.create). - -#### manifest.delete - -```ts -delete: Method; -``` - -##### Description - -Permanently deletes an app created through app manifests. - -##### See - -[`apps.manifest.delete` API reference](https://api.slack.com/methods/apps.manifest.delete). - -#### manifest.export - -```ts -export: Method; -``` - -##### Description - -Export an app manifest from an existing app. - -##### See - -[`apps.manifest.export` API reference](https://api.slack.com/methods/apps.manifest.export). - -#### manifest.update - -```ts -update: Method; -``` - -##### Description - -Update an app from an app manifest. - -##### See - -[`apps.manifest.update` API reference](https://api.slack.com/methods/apps.manifest.update). - -#### manifest.validate - -```ts -validate: Method; -``` - -##### Description - -Validate an app manifest. - -##### See - -[`apps.manifest.validate` API reference](https://api.slack.com/methods/apps.manifest.validate). - -#### uninstall - -```ts -uninstall: Method; -``` - -##### Description - -Uninstalls your app from a workspace. - -##### See - -[`apps.uninstall` API reference](https://api.slack.com/methods/apps.uninstall). - -#### Defined in - -[packages/web-api/src/methods.ts:1229](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1229) - -*** - -### auth - -```ts -readonly auth: object; -``` - -#### revoke - -```ts -revoke: Method; -``` - -##### Description - -Revokes a token. - -##### See - -[`auth.revoke` API reference](https://api.slack.com/methods/auth.revoke). - -#### teams - -```ts -teams: object; -``` - -#### teams.list - -```ts -list: Method; -``` - -##### Description - -Obtain a full list of workspaces your org-wide app has been approved for. - -##### See - -[`auth.teams.list` API reference](https://api.slack.com/methods/auth.teams.list). - -#### test - -```ts -test: Method; -``` - -#### Defined in - -[packages/web-api/src/methods.ts:1285](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1285) - -*** - -### bookmarks - -```ts -readonly bookmarks: object; -``` - -#### add - -```ts -add: Method; -``` - -##### Description - -Add bookmark to a channel. - -##### See - -[`bookmarks.add` API reference](https://api.slack.com/methods/bookmarks.add). - -#### edit - -```ts -edit: Method; -``` - -##### Description - -Edit bookmark. - -##### See - -[`bookmarks.edit` API reference](https://api.slack.com/methods/bookmarks.edit). - -#### list - -```ts -list: Method; -``` - -##### Description - -List bookmarks for a channel. - -##### See - -[`bookmarks.list` API reference](https://api.slack.com/methods/bookmarks.list). - -#### remove - -```ts -remove: Method; -``` - -##### Description - -Remove bookmark from a channel. - -##### See - -[`bookmarks.remove` API reference](https://api.slack.com/methods/bookmarks.remove). - -#### Defined in - -[packages/web-api/src/methods.ts:1301](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1301) - -*** - -### bots - -```ts -readonly bots: object; -``` - -#### info - -```ts -info: Method; -``` - -##### Description - -Gets information about a bot user. - -##### See - -[`bots.info` API reference](https://api.slack.com/methods/bots.info). - -#### Defined in - -[packages/web-api/src/methods.ts:1324](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1324) - -*** - -### calls - -```ts -readonly calls: object; -``` - -#### add - -```ts -add: Method; -``` - -##### Description - -Registers a new Call. - -##### See - -[`calls.add` API reference](https://api.slack.com/methods/calls.add). - -#### end - -```ts -end: Method; -``` - -##### Description - -Ends a Call. - -##### See - -[`calls.end` API reference](https://api.slack.com/methods/calls.end). - -#### info - -```ts -info: Method; -``` - -##### Description - -Returns information about a Call. - -##### See - -[`calls.info` API reference](https://api.slack.com/methods/calls.info). - -#### participants - -```ts -participants: object; -``` - -#### participants.add - -```ts -add: Method; -``` - -##### Description - -Registers new participants added to a Call. - -##### See - -[`calls.participants.add` API reference](https://api.slack.com/methods/calls.participants.add). - -#### participants.remove - -```ts -remove: Method; -``` - -#### update - -```ts -update: Method; -``` - -##### Description - -Updates information about a Call. - -##### See - -[`calls.info` API reference](https://api.slack.com/methods/calls.info). - -#### Defined in - -[packages/web-api/src/methods.ts:1332](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1332) - -*** - -### canvases - -```ts -readonly canvases: object; -``` - -#### access - -```ts -access: object; -``` - -#### access.delete - -```ts -delete: Method; -``` - -##### Description - -Remove access to a canvas for specified entities. - -##### See - -[`canvases.access.delete` API reference](https://api.slack.com/methods/canvases.access.delete). - -#### access.set - -```ts -set: Method; -``` - -##### Description - -Sets the access level to a canvas for specified entities. - -##### See - -[`canvases.access.set` API reference](https://api.slack.com/methods/canvases.access.set). - -#### create - -```ts -create: Method; -``` - -##### Description - -Create Canvas for a user. - -##### See - -[`canvases.create` API reference](https://api.slack.com/methods/canvases.create). - -#### delete - -```ts -delete: Method; -``` - -##### Description - -Deletes a canvas. - -##### See - -[`canvases.delete` API reference](https://api.slack.com/methods/canvases.delete). - -#### edit - -```ts -edit: Method; -``` - -##### Description - -Update an existing canvas. - -##### See - -[`canvases.edit` API reference](https://api.slack.com/methods/canvases.edit). - -#### sections - -```ts -sections: object; -``` - -#### sections.lookup - -```ts -lookup: Method; -``` - -##### Description - -Find sections matching the provided criteria. - -##### See - -[`canvases.sections.lookup` API reference](https://api.slack.com/methods/canvases.sections.lookup). - -#### Defined in - -[packages/web-api/src/methods.ts:1363](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1363) - -*** - -### chat - -```ts -readonly chat: object; -``` - -#### delete - -```ts -delete: Method; -``` - -##### Description - -Deletes a message. - -##### See - -[`chat.delete` API reference](https://api.slack.com/methods/chat.delete). - -#### deleteScheduledMessage - -```ts -deleteScheduledMessage: Method; -``` - -##### Description - -Deletes a pending scheduled message from the queue. - -##### See - -[`chat.deleteScheduledMessage` API reference](https://api.slack.com/methods/chat.deleteScheduledMessage). - -#### getPermalink - -```ts -getPermalink: Method; -``` - -##### Description - -Retrieve a permalink URL for a specific extant message. - -##### See - -[`chat.getPermalink` API reference](https://api.slack.com/methods/chat.getPermalink). - -#### meMessage - -```ts -meMessage: Method; -``` - -##### Description - -Share a me message into a channel. - -##### See - -[`chat.meMessage` API reference](https://api.slack.com/methods/chat.meMessage). - -#### postEphemeral - -```ts -postEphemeral: Method; -``` - -##### Description - -Sends an ephemeral message to a user in a channel. - -##### See - -[`chat.postEphemeral` API reference](https://api.slack.com/methods/chat.postEphemeral). - -#### postMessage - -```ts -postMessage: Method; -``` - -##### Description - -Sends a message to a channel. - -##### See - -[`chat.postMessage` API reference](https://api.slack.com/methods/chat.postMessage). - -#### scheduleMessage - -```ts -scheduleMessage: Method; -``` - -##### Description - -Schedules a message to be sent to a channel. - -##### See - -[`chat.scheduleMessage` API reference](https://api.slack.com/methods/chat.scheduleMessage). - -#### scheduledMessages - -```ts -scheduledMessages: object; -``` - -#### scheduledMessages.list - -```ts -list: Method; -``` - -##### Description - -Returns a list of scheduled messages. - -##### See - -[`chat.scheduledMessages.list` API reference](https://api.slack.com/methods/chat.scheduledMessages.list). - -#### unfurl - -```ts -unfurl: Method; -``` - -##### Description - -Provide custom unfurl behavior for user-posted URLs. - -##### See - -[`chat.unfurl` API reference](https://api.slack.com/methods/chat.unfurl). - -#### update - -```ts -update: Method; -``` - -##### Description - -Updates a message. - -##### See - -[`chat.update` API reference](https://api.slack.com/methods/chat.update). - -#### Defined in - -[packages/web-api/src/methods.ts:1400](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1400) - -*** - -### conversations - -```ts -readonly conversations: object; -``` - -#### acceptSharedInvite - -```ts -acceptSharedInvite: Method; -``` - -##### Description - -Accepts an invitation to a Slack Connect channel. - -##### See - -[`conversations.acceptSharedInvite` API reference](https://api.slack.com/methods/conversations.acceptSharedInvite). - -#### approveSharedInvite - -```ts -approveSharedInvite: Method; -``` - -##### Description - -Approves an invitation to a Slack Connect channel. - -##### See - -[`conversations.approveSharedInvite` API reference](https://api.slack.com/methods/conversations.approveSharedInvite). - -#### archive - -```ts -archive: Method; -``` - -##### Description - -Archives a conversation. - -##### See - -[`conversations.archive` API reference](https://api.slack.com/methods/conversations.archive). - -#### canvases - -```ts -canvases: object; -``` - -#### canvases.create - -```ts -create: Method; -``` - -##### Description - -Create a Channel Canvas for a channel. - -##### See - -[`conversations.canvases.create` API reference](https://api.slack.com/methods/conversations.canvases.create). - -#### close - -```ts -close: Method; -``` - -##### Description - -Closes a direct message or multi-person direct message. - -##### See - -[`conversations.close` API reference](https://api.slack.com/methods/conversations.close). - -#### create - -```ts -create: Method; -``` - -##### Description - -Initiates a public or private channel-based conversation. - -##### See - -[`conversations.create` API reference](https://api.slack.com/methods/conversations.create). - -#### declineSharedInvite - -```ts -declineSharedInvite: Method; -``` - -##### Description - -Declines an invitation to a Slack Connect channel. - -##### See - -[`conversations.declineSharedInvite` API reference](https://api.slack.com/methods/conversations.declineSharedInvite). - -#### externalInvitePermissions - -```ts -externalInvitePermissions: object; -``` - -#### externalInvitePermissions.set - -```ts -set: Method; -``` - -##### Description - -Convert a team in a shared channel from an External Limited channel to a fully shared Slack -Connect channel or vice versa. - -##### See - -[`conversations.externalInvitePermissions.set` API reference](https://api.slack.com/methods/conversations.externalInvitePermissions.set). - -#### history - -```ts -history: Method; -``` - -##### Description - -Fetches a conversation's history of messages and events. - -##### See - -[`conversations.history` API reference](https://api.slack.com/methods/conversations.history). - -#### info - -```ts -info: Method; -``` - -##### Description - -Retrieve information about a conversation. - -##### See - -[`conversations.info` API reference](https://api.slack.com/methods/conversations.info). - -#### invite - -```ts -invite: Method; -``` - -##### Description - -Invites users to a channel. - -##### See - -[`conversations.invite` API reference](https://api.slack.com/methods/conversations.invite). - -#### inviteShared - -```ts -inviteShared: Method; -``` - -##### Description - -Sends an invitation to a Slack Connect channel. - -##### See - -[`conversations.inviteShared` API reference](https://api.slack.com/methods/conversations.inviteShared). - -#### join - -```ts -join: Method; -``` - -##### Description - -Joins an existing conversation. - -##### See - -[`conversations.join` API reference](https://api.slack.com/methods/conversations.join). - -#### kick - -```ts -kick: Method; -``` - -##### Description - -Removes a user from a conversation. - -##### See - -[`conversations.kick` API reference](https://api.slack.com/methods/conversations.kick). - -#### leave - -```ts -leave: Method; -``` - -##### Description - -Leaves a conversation. - -##### See - -[`conversations.leave` API reference](https://api.slack.com/methods/conversations.leave). - -#### list - -```ts -list: Method; -``` - -##### Description - -List all channels in a Slack team. - -##### See - -[`conversations.list` API reference](https://api.slack.com/methods/conversations.list). - -#### listConnectInvites - -```ts -listConnectInvites: Method; -``` - -##### Description - -Lists shared channel invites that have been generated or received but have not been approved by -all parties. - -##### See - -[`conversations.listConnectInvites` API reference](https://api.slack.com/methods/conversations.listConnectInvites). - -#### mark - -```ts -mark: Method; -``` - -##### Description - -Sets the read cursor in a channel. - -##### See - -[`conversations.mark` API reference](https://api.slack.com/methods/conversations.mark). - -#### members - -```ts -members: Method; -``` - -##### Description - -Retrieve members of a conversation. - -##### See - -[`conversations.members` API reference](https://api.slack.com/methods/conversations.members). - -#### open - -```ts -open: Method; -``` - -##### Description - -Opens or resumes a direct message or multi-person direct message. - -##### See - -[`conversations.open` API reference](https://api.slack.com/methods/conversations.open). - -#### rename - -```ts -rename: Method; -``` - -##### Description - -Renames a conversation. - -##### See - -[`conversations.rename` API reference](https://api.slack.com/methods/conversations.rename). - -#### replies - -```ts -replies: Method; -``` - -##### Description - -Retrieve a thread of messages posted to a conversation. - -##### See - -[`conversations.replies` API reference](https://api.slack.com/methods/conversations.replies). - -#### setPurpose - -```ts -setPurpose: Method; -``` - -##### Description - -Sets the purpose for a conversation. - -##### See - -[`conversations.setPurpose` API reference](https://api.slack.com/methods/conversations.setPurpose). - -#### setTopic - -```ts -setTopic: Method; -``` - -##### Description - -Sets the topic for a conversation. - -##### See - -[`conversations.setTopic` API reference](https://api.slack.com/methods/conversations.setTopic). - -#### unarchive - -```ts -unarchive: Method; -``` - -##### Description - -Reverses conversation archival. - -##### See - -[`conversations.unarchive` API reference](https://api.slack.com/methods/conversations.unarchive). - -#### Defined in - -[packages/web-api/src/methods.ts:1463](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1463) - -*** - -### dialog - -```ts -readonly dialog: object; -``` - -#### open - -```ts -open: Method; -``` - -##### Description - -Open a dialog with a user. - -##### See - -[`dialog.open` API reference](https://api.slack.com/methods/dialog.open). - -#### Defined in - -[packages/web-api/src/methods.ts:1622](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1622) - -*** - -### dnd - -```ts -readonly dnd: object; -``` - -#### endDnd - -```ts -endDnd: Method; -``` - -##### Description - -Ends the current user's Do Not Disturb session immediately. - -##### See - -[`dnd.endDnd` API reference](https://api.slack.com/methods/dnd.endDnd). - -#### endSnooze - -```ts -endSnooze: Method; -``` - -##### Description - -Ends the current user's snooze mode immediately. - -##### See - -[`dnd.endSnooze` API reference](https://api.slack.com/methods/dnd.endSnooze). - -#### info - -```ts -info: Method; -``` - -##### Description - -Retrieves a user's current Do Not Disturb status. - -##### See - -[`dnd.info` API reference](https://api.slack.com/methods/dnd.info). - -#### setSnooze - -```ts -setSnooze: Method; -``` - -##### Description - -Turns on Do Not Disturb mode for the current user, or changes its duration. - -##### See - -[`dnd.setSnooze` API reference](https://api.slack.com/methods/dnd.setSnooze). - -#### teamInfo - -```ts -teamInfo: Method; -``` - -##### Description - -Retrieves the Do Not Disturb status for up to 50 users on a team. - -##### See - -[`dnd.teamInfo` API reference](https://api.slack.com/methods/dnd.teamInfo). - -#### Defined in - -[packages/web-api/src/methods.ts:1630](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1630) - -*** - -### emoji - -```ts -readonly emoji: object; -``` - -#### list - -```ts -list: Method; -``` - -##### Description - -Lists custom emoji for a team. - -##### See - -[`emoji.list` API reference](https://api.slack.com/methods/emoji.list). - -#### Defined in - -[packages/web-api/src/methods.ts:1658](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1658) - -*** - -### files - -```ts -readonly files: object; -``` - -#### comments - -```ts -comments: object; -``` - -#### comments.delete - -```ts -delete: Method; -``` - -##### Description - -Deletes an existing comment on a file. - -##### See - -[`files.comments.delete` API reference](https://api.slack.com/methods/files.comments.delete). - -#### completeUploadExternal - -```ts -completeUploadExternal: Method; -``` - -##### Description - -Finishes an upload started with [`files.getUploadURLExternal`](https://api.slack.com/methods/files.getUploadURLExternal). - -##### See - -[`files.completeUploadExternal` API reference](https://api.slack.com/methods/files.completeUploadExternal). - -#### delete - -```ts -delete: Method; -``` - -##### Description - -Deletes a file. - -##### See - -[`files.delete` API reference](https://api.slack.com/methods/files.delete). - -#### getUploadURLExternal - -```ts -getUploadURLExternal: Method; -``` - -##### Description - -Gets a URL for an edge external file upload. - -##### See - -[`files.getUploadURLExternal` API reference](https://api.slack.com/methods/files.getUploadURLExternal). - -#### info - -```ts -info: Method; -``` - -##### Description - -Gets information about a file. - -##### See - -[`files.info` API reference](https://api.slack.com/methods/files.info). - -#### list - -```ts -list: Method; -``` - -##### Description - -List files for a team, in a channel, or from a user with applied filters. - -##### See - -[`files.list` API reference](https://api.slack.com/methods/files.list). - -#### remote - -```ts -remote: object; -``` - -#### remote.add - -```ts -add: Method; -``` - -##### Description - -Adds a file from a remote service. - -##### See - -[`files.remote.add` API reference](https://api.slack.com/methods/files.remote.add). - -#### remote.info - -```ts -info: Method; -``` - -##### Description - -Retrieve information about a remote file added to Slack. - -##### See - -[`files.remote.info` API reference](https://api.slack.com/methods/files.remote.info). - -#### remote.list - -```ts -list: Method; -``` - -##### Description - -List remote files added to Slack. - -##### See - -[`files.remote.list` API reference](https://api.slack.com/methods/files.remote.list). - -#### remote.remove - -```ts -remove: Method; -``` - -##### Description - -Remove a remote file. - -##### See - -[`files.remote.remove` API reference](https://api.slack.com/methods/files.remote.remove). - -#### remote.share - -```ts -share: Method; -``` - -##### Description - -Share a remote file into a channel. - -##### See - -[`files.remote.share` API reference](https://api.slack.com/methods/files.remote.share). - -#### remote.update - -```ts -update: Method; -``` - -##### Description - -Updates an existing remote file. - -##### See - -[`files.remote.update` API reference](https://api.slack.com/methods/files.remote.update). - -#### revokePublicURL - -```ts -revokePublicURL: Method; -``` - -##### Description - -Revokes public/external sharing access for a file. - -##### See - -[`files.revokePublicURL` API reference](https://api.slack.com/methods/files.revokePublicURL). - -#### sharedPublicURL - -```ts -sharedPublicURL: Method; -``` - -##### Description - -Enables a file for public/external sharing. - -##### See - -[`files.revokePublicURL` API reference](https://api.slack.com/methods/files.revokePublicURL). - -#### ~~upload~~ - -```ts -upload: Method; -``` - -##### Description - -Uploads or creates a file. - -##### Deprecated - -Use `uploadV2` instead. See [our post on retiring `files.upload`](https://api.slack.com/changelog/2024-04-a-better-way-to-upload-files-is-here-to-stay). - -##### See - -[`files.upload` API reference](https://api.slack.com/methods/files.upload). - -#### uploadV2 - -```ts -uploadV2: Method; -``` - -##### Description - -Custom method to support a new way of uploading files to Slack. -Supports a single file upload -Supply: -- (required) single file or content -- (optional) channel, alt_text, snippet_type, -Supports multiple file uploads -Supply: -- multiple upload_files -Will try to honor both single file or content data supplied as well -as multiple file uploads property. - -##### See - -[`@slack/web-api` Upload a file documentation](https://slack.dev/node-slack-sdk/web-api#upload-a-file). - -#### Defined in - -[packages/web-api/src/methods.ts:1666](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1666) - -*** - -### functions - -```ts -readonly functions: object; -``` - -#### completeError - -```ts -completeError: Method; -``` - -##### Description - -Signal the failure to execute a Custom Function. - -##### See - -[`functions.completeError` API reference](https://api.slack.com/methods/functions.completeError). - -#### completeSuccess - -```ts -completeSuccess: Method; -``` - -##### Description - -Signal the successful completion of a Custom Function. - -##### See - -[`functions.completeSuccess` API reference](https://api.slack.com/methods/functions.completeSuccess). - -#### Defined in - -[packages/web-api/src/methods.ts:1767](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1767) - -*** - -### migration - -```ts -readonly migration: object; -``` - -#### exchange - -```ts -exchange: Method; -``` - -##### Description - -For Enterprise Grid workspaces, map local user IDs to global user IDs. - -##### See - -[`migration.exchange` API reference](https://api.slack.com/methods/migration.exchange). - -#### Defined in - -[packages/web-api/src/methods.ts:1783](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1783) - -*** - -### oauth - -```ts -readonly oauth: object; -``` - -#### ~~access~~ - -```ts -access: Method; -``` - -##### Description - -Exchanges a temporary OAuth verifier code for an access token. - -##### Deprecated - -This is a legacy method only used by classic Slack apps. Use `oauth.v2.access` for new Slack apps. - -##### See - -[`oauth.access` API reference](https://api.slack.com/methods/oauth.access). - -#### v2 - -```ts -v2: object; -``` - -#### v2.access - -```ts -access: Method; -``` - -##### Description - -Exchanges a temporary OAuth verifier code for an access token. - -##### See - -[`oauth.v2.access` API reference](https://api.slack.com/methods/oauth.v2.access). - -#### v2.exchange - -```ts -exchange: Method; -``` - -##### Description - -Exchanges a legacy access token for a new expiring access token and refresh token. - -##### See - -[`oauth.v2.exchange` API reference](https://api.slack.com/methods/oauth.v2.exchange). - -#### Defined in - -[packages/web-api/src/methods.ts:1791](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1791) - -*** - -### openid - -```ts -readonly openid: object; -``` - -#### connect - -```ts -connect: object; -``` - -#### connect.token - -```ts -token: Method; -``` - -##### Description - -Exchanges a temporary OAuth verifier code for an access token for [Sign in with Slack](https://api.slack.com/authentication/sign-in-with-slack). - -##### See - -[`openid.connect.token` API reference](https://api.slack.com/methods/openid.connect.token). - -#### connect.userInfo - -```ts -userInfo: Method; -``` - -##### Description - -Get the identity of a user who has authorized [Sign in with Slack](https://api.slack.com/authentication/sign-in-with-slack). - -##### See - -[`openid.connect.userInfo` API reference](https://api.slack.com/methods/openid.connect.userInfo). - -#### Defined in - -[packages/web-api/src/methods.ts:1812](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1812) - -*** - -### pins - -```ts -readonly pins: object; -``` - -#### add - -```ts -add: Method; -``` - -##### Description - -Pins an item to a channel. - -##### See - -[`pins.add` API reference](https://api.slack.com/methods/pins.add). - -#### list - -```ts -list: Method; -``` - -##### Description - -Lists items pinned to a channel. - -##### See - -[`pins.list` API reference](https://api.slack.com/methods/pins.list). - -#### remove - -```ts -remove: Method; -``` - -##### Description - -Un-pins an item from a channel. - -##### See - -[`pins.remove` API reference](https://api.slack.com/methods/pins.remove). - -#### Defined in - -[packages/web-api/src/methods.ts:1827](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1827) - -*** - -### reactions - -```ts -readonly reactions: object; -``` - -#### add - -```ts -add: Method; -``` - -##### Description - -Adds a reaction to an item. - -##### See - -[`reactions.add` API reference](https://api.slack.com/methods/reactions.add). - -#### get - -```ts -get: Method; -``` - -##### Description - -Gets reactions for an item. - -##### See - -[`reactions.get` API reference](https://api.slack.com/methods/reactions.get). - -#### list - -```ts -list: Method; -``` - -##### Description - -List reactions made by a user. - -##### See - -[`reactions.list` API reference](https://api.slack.com/methods/reactions.list). - -#### remove - -```ts -remove: Method; -``` - -##### Description - -Removes a reaction from an item. - -##### See - -[`reactions.remove` API reference](https://api.slack.com/methods/reactions.remove). - -#### Defined in - -[packages/web-api/src/methods.ts:1845](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1845) - -*** - -### reminders - -```ts -readonly reminders: object; -``` - -#### add - -```ts -add: Method; -``` - -##### Description - -Creates a reminder. - -##### See - -[`reminders.add` API reference](https://api.slack.com/methods/reminders.add). - -#### complete - -```ts -complete: Method; -``` - -##### Description - -Marks a reminder as complete. - -##### See - -[`reminders.complete` API reference](https://api.slack.com/methods/reminders.complete). - -#### delete - -```ts -delete: Method; -``` - -##### Description - -Deletes a reminder. - -##### See - -[`reminders.delete` API reference](https://api.slack.com/methods/reminders.delete). - -#### info - -```ts -info: Method; -``` - -##### Description - -Gets information about a reminder. - -##### See - -[`reminders.info` API reference](https://api.slack.com/methods/reminders.info). - -#### list - -```ts -list: Method; -``` - -##### Description - -Lists all reminders created by or for a given user. - -##### See - -[`reminders.list` API reference](https://api.slack.com/methods/reminders.list). - -#### Defined in - -[packages/web-api/src/methods.ts:1870](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1870) - -*** - -### rtm - -```ts -readonly rtm: object; -``` - -#### connect - -```ts -connect: Method; -``` - -##### Description - -Starts a Real Time Messaging session. - -##### See - -[`rtm.connect` API reference](https://api.slack.com/methods/rtm.connect). - -#### ~~start~~ - -```ts -start: Method; -``` - -##### Description - -Starts a Real Time Messaging session. - -##### Deprecated - -Use `rtm.connect` instead. See [our post on retiring `rtm.start`](https://api.slack.com/changelog/2021-10-rtm-start-to-stop). - -##### See - -[`rtm.start` API reference](https://api.slack.com/methods/rtm.start). - -#### Defined in - -[packages/web-api/src/methods.ts:1898](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1898) - -*** - -### search - -```ts -readonly search: object; -``` - -#### all - -```ts -all: Method; -``` - -##### Description - -Searches for messages and files matching a query. - -##### See - -[search.all` API reference](https://api.slack.com/methods/search.all). - -#### files - -```ts -files: Method; -``` - -##### Description - -Searches for files matching a query. - -##### See - -[search.files` API reference](https://api.slack.com/methods/search.files). - -#### messages - -```ts -messages: Method; -``` - -##### Description - -Searches for messages matching a query. - -##### See - -[search.messages` API reference](https://api.slack.com/methods/search.messages). - -#### Defined in - -[packages/web-api/src/methods.ts:1912](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1912) - -*** - -### stars - -```ts -readonly stars: object; -``` - -#### ~~add~~ - -```ts -add: Method; -``` - -##### Description - -Save an item for later. Formerly known as adding a star. - -##### Deprecated - -Stars can still be added but they can no longer be viewed or interacted with by end-users. -See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). - -##### See - -[`stars.add` API reference](https://api.slack.com/methods/stars.add). - -#### ~~list~~ - -```ts -list: Method; -``` - -##### Description - -List a user's saved items, formerly known as stars. - -##### Deprecated - -Stars can still be listed but they can no longer be viewed or interacted with by end-users. -See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). - -##### See - -[`stars.list` API reference](https://api.slack.com/methods/stars.list). - -#### ~~remove~~ - -```ts -remove: Method; -``` - -##### Description - -Remove a saved item from a user's saved items, formerly known as stars. - -##### Deprecated - -Stars can still be removed but they can no longer be viewed or interacted with by end-users. -See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). - -##### See - -[`stars.remove` API reference](https://api.slack.com/methods/stars.remove). - -#### Defined in - -[packages/web-api/src/methods.ts:2140](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2140) - -*** - -### team - -```ts -readonly team: object; -``` - -#### accessLogs - -```ts -accessLogs: Method; -``` - -##### Description - -Gets the access logs for the current team. - -##### See - -[`team.accessLogs` API reference](https://api.slack.com/methods/team.accessLogs). - -#### billableInfo - -```ts -billableInfo: Method; -``` - -##### Description - -Gets billable users information for the current team. - -##### See - -[`team.billableInfo` API reference](https://api.slack.com/methods/team.billableInfo). - -#### billing - -```ts -billing: object; -``` - -#### billing.info - -```ts -info: Method; -``` - -##### Description - -Reads a workspace's billing plan information. - -##### See - -[`team.billing.info` API reference](https://api.slack.com/methods/team.billing.info). - -#### externalTeams - -```ts -externalTeams: object; -``` - -#### externalTeams.disconnect - -```ts -disconnect: Method; -``` - -##### Description - -Disconnect an external organization. - -##### See - -[`team.externalTeams.disconnect` API reference](https://api.slack.com/methods/team.externalTeams.disconnect). - -#### externalTeams.list - -```ts -list: Method; -``` - -##### Description - -Returns a list of all the external teams connected and details about the connection. - -##### See - -[`team.externalTeams.list` API reference](https://api.slack.com/methods/team.externalTeams.list). - -#### info - -```ts -info: Method; -``` - -##### Description - -Gets information about the current team. - -##### See - -[`team.info` API reference](https://api.slack.com/methods/team.info). - -#### integrationLogs - -```ts -integrationLogs: Method; -``` - -##### Description - -Gets the integration logs for the current team. - -##### See - -[`team.integrationLogs` API reference](https://api.slack.com/methods/team.integrationLogs). - -#### preferences - -```ts -preferences: object; -``` - -#### preferences.list - -```ts -list: Method; -``` - -##### Description - -Retrieve a list of a workspace's team preferences. - -##### See - -[`team.preferences.list` API reference](https://api.slack.com/methods/team.preferences.list). - -#### profile - -```ts -profile: object; -``` - -#### profile.get - -```ts -get: Method; -``` - -##### Description - -Retrieve a team's profile. - -##### See - -[`team.profile.get` API reference](https://api.slack.com/methods/team.profile.get). - -#### Defined in - -[packages/web-api/src/methods.ts:1930](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1930) - -*** - -### tooling - -```ts -readonly tooling: object; -``` - -#### tokens - -```ts -tokens: object; -``` - -#### tokens.rotate - -```ts -rotate: Method; -``` - -##### Description - -Exchanges a refresh token for a new app configuration token. - -##### See - -[`tooling.tokens.rotate` API reference](https://api.slack.com/methods/tooling.tokens.rotate). - -#### Defined in - -[packages/web-api/src/methods.ts:1987](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1987) - -*** - -### usergroups - -```ts -readonly usergroups: object; -``` - -#### create - -```ts -create: Method; -``` - -##### Description - -Create a User Group. - -##### See - -[`usergroups.create` API reference](https://api.slack.com/methods/usergroups.create). - -#### disable - -```ts -disable: Method; -``` - -##### Description - -Disable an existing User Group. - -##### See - -[`usergroups.disable` API reference](https://api.slack.com/methods/usergroups.disable). - -#### enable - -```ts -enable: Method; -``` - -##### Description - -Enable an existing User Group. - -##### See - -[`usergroups.enable` API reference](https://api.slack.com/methods/usergroups.enable). - -#### list - -```ts -list: Method; -``` - -##### Description - -List all User Groups for a team. - -##### See - -[`usergroups.list` API reference](https://api.slack.com/methods/usergroups.list). - -#### update - -```ts -update: Method; -``` - -##### Description - -Update an existing User Group. - -##### See - -[`usergroups.update` API reference](https://api.slack.com/methods/usergroups.update). - -#### users - -```ts -users: object; -``` - -#### users.list - -```ts -list: Method; -``` - -##### Description - -List all users in a User Group. - -##### See - -[`usergroups.users.list` API reference](https://api.slack.com/methods/usergroups.users.list). - -#### users.update - -```ts -update: Method; -``` - -##### Description - -Update the list of users in a User Group. - -##### See - -[`usergroups.users.update` API reference](https://api.slack.com/methods/usergroups.users.update). - -#### Defined in - -[packages/web-api/src/methods.ts:1997](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1997) - -*** - -### users - -```ts -readonly users: object; -``` - -#### conversations - -```ts -conversations: Method; -``` - -##### Description - -List conversations the calling user may access. - -##### See - -[`users.conversations` API reference](https://api.slack.com/methods/users.conversations). - -#### deletePhoto - -```ts -deletePhoto: Method; -``` - -##### Description - -Delete the user profile photo. - -##### See - -[`users.deletePhoto` API reference](https://api.slack.com/methods/users.deletePhoto). - -#### discoverableContacts - -```ts -discoverableContacts: object; -``` - -#### discoverableContacts.lookup - -```ts -lookup: Method; -``` - -##### Description - -Lookup an email address to see if someone is on Slack. - -##### See - -[`users.discoverableContacts.lookup` API reference](https://api.slack.com/methods/users.discoverableContacts.lookup). - -#### getPresence - -```ts -getPresence: Method; -``` - -##### Description - -Gets user presence information. - -##### See - -[`users.getPresence` API reference](https://api.slack.com/methods/users.getPresence). - -#### identity - -```ts -identity: Method; -``` - -##### Description - -Get a user's identity. - -##### See - -[`users.identity` API reference](https://api.slack.com/methods/users.identity). - -#### info - -```ts -info: Method; -``` - -##### Description - -Gets information about a user. - -##### See - -[`users.info` API reference](https://api.slack.com/methods/users.info). - -#### list - -```ts -list: Method; -``` - -##### Description - -Lists all users in a Slack team. - -##### See - -[`users.list` API reference](https://api.slack.com/methods/users.list). - -#### lookupByEmail - -```ts -lookupByEmail: Method; -``` - -##### Description - -Find a user with an email address. - -##### See - -[`users.lookupByEmail` API reference](https://api.slack.com/methods/users.lookupByEmail). - -#### profile - -```ts -profile: object; -``` - -#### profile.get - -```ts -get: Method; -``` - -##### Description - -Retrieve a user's profile information, including their custom status. - -##### See - -[`users.profile.get` API reference](https://api.slack.com/methods/users.profile.get). - -#### profile.set - -```ts -set: Method; -``` - -##### Description - -Set a user's profile information, including custom status. - -##### See - -[`users.profile.set` API reference](https://api.slack.com/methods/users.profile.set). - -#### setPhoto - -```ts -setPhoto: Method; -``` - -##### Description - -Set the user profile photo. - -##### See - -[`users.setPhoto` API reference](https://api.slack.com/methods/users.setPhoto). - -#### setPresence - -```ts -setPresence: Method; -``` - -##### Description - -Manually sets user presence. - -##### See - -[`users.setPresence` API reference](https://api.slack.com/methods/users.setPresence). - -#### Defined in - -[packages/web-api/src/methods.ts:2043](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2043) - -*** - -### views - -```ts -readonly views: object; -``` - -#### open - -```ts -open: Method; -``` - -##### Description - -Open a view for a user. - -##### See - -[`views.open` API reference](https://api.slack.com/methods/views.open). - -#### publish - -```ts -publish: Method; -``` - -##### Description - -Publish a static view for a user. - -##### See - -[`views.publish` API reference](https://api.slack.com/methods/views.publish). - -#### push - -```ts -push: Method; -``` - -##### Description - -Push a view onto the stack of a root view. - -##### See - -[`views.push` API reference](https://api.slack.com/methods/views.push). - -#### update - -```ts -update: Method; -``` - -##### Description - -Update an existing view. - -##### See - -[`views.update` API reference](https://api.slack.com/methods/views.update). - -#### Defined in - -[packages/web-api/src/methods.ts:2110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2110) - -*** - -### workflows - -```ts -readonly workflows: object; -``` - -#### ~~stepCompleted~~ - -```ts -stepCompleted: Method; -``` - -##### Description - -Indicate that an app's step in a workflow completed execution. - -##### Deprecated - -Steps from Apps is deprecated. -We're retiring all Slack app functionality around Steps from Apps in September 2024. -See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). - -##### See - -[`workflows.stepCompleted` API reference](https://api.slack.com/methods/workflows.stepCompleted). - -#### ~~stepFailed~~ - -```ts -stepFailed: Method; -``` - -##### Description - -Indicate that an app's step in a workflow failed to execute. - -##### Deprecated - -Steps from Apps is deprecated. -We're retiring all Slack app functionality around Steps from Apps in September 2024. -See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). - -##### See - -[`workflows.stepFailed` API reference](https://api.slack.com/methods/workflows.stepFailed). - -#### ~~updateStep~~ - -```ts -updateStep: Method; -``` - -##### Description - -Update the configuration for a workflow step. - -##### Deprecated - -Steps from Apps is deprecated. -We're retiring all Slack app functionality around Steps from Apps in September 2024. -See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). - -##### See - -[`workflows.updateStep` API reference](https://api.slack.com/methods/workflows.updateStep). - -#### Defined in - -[packages/web-api/src/methods.ts:2164](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2164) - -*** - -### prefixed - -```ts -static prefixed: string | boolean; -``` - -#### Inherited from - -`EventEmitter.prefixed` - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:9 - -## Methods - -### addListener() - -```ts -addListener( - event, - fn, - context?): this -``` - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• **fn** - -• **context?**: `any` - -#### Returns - -`this` - -#### Inherited from - -`EventEmitter.addListener` - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:45 - -*** - -### apiCall() - -```ts -abstract apiCall(method, options?): Promise -``` - -#### Parameters - -• **method**: `string` - -• **options?**: `Record`\<`string`, `unknown`\> - -#### Returns - -`Promise`\<[`WebAPICallResult`](../interfaces/WebAPICallResult.md)\> - -#### Defined in - -[packages/web-api/src/methods.ts:543](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L543) - -*** - -### emit() - -```ts -emit(event, ...args): boolean -``` - -Calls each of the listeners registered for a given event. - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• ...**args**: `any`[] - -#### Returns - -`boolean` - -#### Inherited from - -`EventEmitter.emit` - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:32 - -*** - -### eventNames() - -```ts -eventNames(): RATE_LIMITED[] -``` - -Return an array listing the events for which the emitter has registered -listeners. - -#### Returns - -[`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited)[] - -#### Inherited from - -`EventEmitter.eventNames` - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:15 - -*** - -### filesUploadV2() - -```ts -abstract filesUploadV2(options): Promise -``` - -#### Parameters - -• **options**: [`FilesUploadV2Arguments`](../type-aliases/FilesUploadV2Arguments.md) - -#### Returns - -`Promise`\<[`WebAPICallResult`](../interfaces/WebAPICallResult.md)\> - -#### Defined in - -[packages/web-api/src/methods.ts:544](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L544) - -*** - -### listenerCount() - -```ts -listenerCount(event): number -``` - -Return the number of listeners listening to a given event. - -#### Parameters - -• **event**: [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Returns - -`number` - -#### Inherited from - -`EventEmitter.listenerCount` - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:27 - -*** - -### listeners() - -```ts -listeners(event): (...args) => void[] -``` - -Return the listeners registered for a given event. - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -#### Returns - -(...`args`) => `void`[] - -#### Inherited from - -`EventEmitter.listeners` - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:20 - -*** - -### off() - -```ts -off( - event, - fn?, - context?, - once?): this -``` - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• **fn?** - -• **context?**: `any` - -• **once?**: `boolean` - -#### Returns - -`this` - -#### Inherited from - -`EventEmitter.off` - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:69 - -*** - -### on() - -```ts -on( - event, - fn, - context?): this -``` - -Add a listener for a given event. - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• **fn** - -• **context?**: `any` - -#### Returns - -`this` - -#### Inherited from - -`EventEmitter.on` - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:40 - -*** - -### once() - -```ts -once( - event, - fn, - context?): this -``` - -Add a one-time listener for a given event. - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• **fn** - -• **context?**: `any` - -#### Returns - -`this` - -#### Inherited from - -`EventEmitter.once` - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:54 - -*** - -### removeAllListeners() - -```ts -removeAllListeners(event?): this -``` - -Remove all listeners, or those of the specified event. - -#### Parameters - -• **event?**: [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Returns - -`this` - -#### Inherited from - -`EventEmitter.removeAllListeners` - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:79 - -*** - -### removeListener() - -```ts -removeListener( - event, - fn?, - context?, - once?): this -``` - -Remove the listeners of a given event. - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• **fn?** - -• **context?**: `any` - -• **once?**: `boolean` - -#### Returns - -`this` - -#### Inherited from - -`EventEmitter.removeListener` - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:63 diff --git a/docs/content/reference/web-api/classes/WebClient.md b/docs/content/reference/web-api/classes/WebClient.md deleted file mode 100644 index d46aa416c..000000000 --- a/docs/content/reference/web-api/classes/WebClient.md +++ /dev/null @@ -1,4873 +0,0 @@ -# Class: WebClient - -A client for Slack's Web API - -This client provides an alias for each [API method](https://api.slack.com/methods|Web). Each method is -a convenience wrapper for calling the [WebClient#apiCall](WebClient.md#apicall) method using the method name as the first parameter. - -## Extends - -- [`Methods`](Methods.md) - -## Constructors - -### new WebClient() - -```ts -new WebClient(token?, __namedParameters?): WebClient -``` - -#### Parameters - -• **token?**: `string` - -An API token to authenticate/authorize with Slack (usually start with `xoxp`, `xoxb`) - -• **\_\_namedParameters?**: [`WebClientOptions`](../interfaces/WebClientOptions.md) = `{}` - -#### Returns - -[`WebClient`](WebClient.md) - -#### Overrides - -[`Methods`](Methods.md).[`constructor`](Methods.md#constructors) - -#### Defined in - -[packages/web-api/src/WebClient.ts:187](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L187) - -## Properties - -### admin - -```ts -readonly admin: object; -``` - -#### analytics - -```ts -analytics: object; -``` - -#### analytics.getFile - -```ts -getFile: Method; -``` - -##### Description - -Retrieve analytics data for a given date, presented as a compressed JSON file. - -##### See - -[`api.test` API reference](https://api.slack.com/methods/api.test). - -#### apps - -```ts -apps: object; -``` - -#### apps.activities - -```ts -activities: object; -``` - -#### apps.activities.list - -```ts -list: Method; -``` - -##### Description - -Get logs for a specified team/org. - -##### See - -[`admin.apps.activities.list` API reference](https://api.slack.com/methods/admin.apps.activities.list). - -#### apps.approve - -```ts -approve: Method; -``` - -##### Description - -Approve an app for installation on a workspace. - -##### See - -[`admin.apps.approve` API reference](https://api.slack.com/methods/admin.apps.approve). - -#### apps.approved - -```ts -approved: object; -``` - -#### apps.approved.list - -```ts -list: Method; -``` - -##### Description - -List approved apps for an org or workspace. - -##### See - -[`admin.apps.approved.list` API reference](https://api.slack.com/methods/admin.apps.approved.list). - -#### apps.clearResolution - -```ts -clearResolution: Method; -``` - -##### Description - -Clear an app resolution. - -##### See - -[`admin.apps.clearResolution` API reference](https://api.slack.com/methods/admin.apps.clearResolution). - -#### apps.config - -```ts -config: object; -``` - -#### apps.config.lookup - -```ts -lookup: Method; -``` - -##### Description - -Look up the app config for connectors by their IDs. - -##### See - -[`admin.apps.config.lookup` API reference](https://api.slack.com/methods/admin.apps.config.lookup). - -#### apps.config.set - -```ts -set: Method; -``` - -##### Description - -Set the app config for a connector. - -##### See - -[`admin.apps.config.set` API reference](https://api.slack.com/methods/admin.apps.config.set). - -#### apps.requests - -```ts -requests: object; -``` - -#### apps.requests.cancel - -```ts -cancel: Method; -``` - -##### Description - -Cancel app request for team. - -##### See - -[`admin.apps.requests.cancel` API reference](https://api.slack.com/methods/admin.apps.requests.cancel). - -#### apps.requests.list - -```ts -list: Method; -``` - -##### Description - -List app requests for a team/workspace. - -##### See - -[`admin.apps.requests.list` API reference](https://api.slack.com/methods/admin.apps.requests.list). - -#### apps.restrict - -```ts -restrict: Method; -``` - -##### Description - -Restrict an app for installation on a workspace. - -##### See - -[`admin.apps.restrict` API reference](https://api.slack.com/methods/admin.apps.restrict). - -#### apps.restricted - -```ts -restricted: object; -``` - -#### apps.restricted.list - -```ts -list: Method; -``` - -##### Description - -List restricted apps for an org or workspace. - -##### See - -[`admin.apps.restricted.list` API reference](https://api.slack.com/methods/admin.apps.restricted.list). - -#### apps.uninstall - -```ts -uninstall: Method; -``` - -##### Description - -Uninstall an app from one or many workspaces, or an entire enterprise organization. - -##### See - -[`admin.apps.uninstall` API reference](https://api.slack.com/methods/admin.apps.uninstall). - -#### auth - -```ts -auth: object; -``` - -#### auth.policy - -```ts -policy: object; -``` - -#### auth.policy.assignEntities - -```ts -assignEntities: Method; -``` - -##### Description - -Assign entities to a particular authentication policy. - -##### See - -[`admin.auth.policy.assignEntities` API reference](https://api.slack.com/methods/admin.auth.policy.assignEntities). - -#### auth.policy.getEntities - -```ts -getEntities: Method; -``` - -##### Description - -Fetch all the entities assigned to a particular authentication policy by name. - -##### See - -[`admin.auth.policy.getEntities` API reference](https://api.slack.com/methods/admin.auth.policy.getEntities). - -#### auth.policy.removeEntities - -```ts -removeEntities: Method; -``` - -##### Description - -Remove specified entities from a specified authentication policy. - -##### See - -[`admin.auth.policy.removeEntities` API reference](https://api.slack.com/methods/admin.auth.policy.removeEntities). - -#### barriers - -```ts -barriers: object; -``` - -#### barriers.create - -```ts -create: Method; -``` - -##### Description - -Create an Information Barrier. - -##### See - -[`admin.barriers.create` API reference](https://api.slack.com/methods/admin.barriers.create). - -#### barriers.delete - -```ts -delete: Method; -``` - -##### Description - -Delete an existing Information Barrier. - -##### See - -[`admin.barriers.delete` API reference](https://api.slack.com/methods/admin.barriers.delete). - -#### barriers.list - -```ts -list: Method; -``` - -##### Description - -Get all Information Barriers for your organization. - -##### See - -[`admin.barriers.list` API reference](https://api.slack.com/methods/admin.barriers.list). - -#### barriers.update - -```ts -update: Method; -``` - -##### Description - -Update an existing Information Barrier. - -##### See - -[`admin.barriers.update` API reference](https://api.slack.com/methods/admin.barriers.update). - -#### conversations - -```ts -conversations: object; -``` - -#### conversations.archive - -```ts -archive: Method; -``` - -##### Description - -Archive a public or private channel. - -##### See - -[`admin.conversations.archive` API reference](https://api.slack.com/methods/admin.conversations.archive). - -#### conversations.bulkArchive - -```ts -bulkArchive: Method; -``` - -##### Description - -Archive public or private channels in bulk. - -##### See - -[`admin.conversations.bulkArchive` API reference](https://api.slack.com/methods/admin.conversations.bulkArchive). - -#### conversations.bulkDelete - -```ts -bulkDelete: Method; -``` - -##### Description - -Delete public or private channels in bulk. - -##### See - -[`admin.conversations.bulkDelete` API reference](https://api.slack.com/methods/admin.conversations.bulkDelet). - -#### conversations.bulkMove - -```ts -bulkMove: Method; -``` - -##### Description - -Move public or private channels in bulk. - -##### See - -[`admin.conversations.bulkMove` API reference](https://api.slack.com/methods/admin.conversations.bulkMove). - -#### conversations.convertToPrivate - -```ts -convertToPrivate: Method; -``` - -##### Description - -Convert a public channel to a private channel. - -##### See - -[`admin.conversations.convertToPrivate` API reference](https://api.slack.com/methods/admin.conversations.convertToPrivate). - -#### conversations.convertToPublic - -```ts -convertToPublic: Method; -``` - -##### Description - -Convert a private channel to a public channel. - -##### See - -[`admin.conversations.convertToPublic` API reference](https://api.slack.com/methods/admin.conversations.convertToPublic). - -#### conversations.create - -```ts -create: Method; -``` - -##### Description - -Create a public or private channel-based conversation. - -##### See - -[`admin.conversations.create` API reference](https://api.slack.com/methods/admin.conversations.create). - -#### conversations.delete - -```ts -delete: Method; -``` - -##### Description - -Delete a public or private channel. - -##### See - -[`admin.conversations.delete` API reference](https://api.slack.com/methods/admin.conversations.delete). - -#### conversations.disconnectShared - -```ts -disconnectShared: Method; -``` - -##### Description - -Disconnect a connected channel from one or more workspaces. - -##### See - -[`admin.conversations.disconnectShared` API reference](https://api.slack.com/methods/admin.conversations.disconnectShared). - -#### conversations.ekm - -```ts -ekm: object; -``` - -#### conversations.ekm.listOriginalConnectedChannelInfo - -```ts -listOriginalConnectedChannelInfo: Method; -``` - -##### Description - -List all disconnected channels — i.e., channels that were once connected to other workspaces -and then disconnected — and the corresponding original channel IDs for key revocation with EKM. - -##### See - -[`admin.conversations.ekm.listOriginalConnectedChannelInfo` API reference](https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo). - -#### conversations.getConversationPrefs - -```ts -getConversationPrefs: Method; -``` - -##### Description - -Get conversation preferences for a public or private channel. - -##### See - -[`admin.conversations.getConversationPrefs` API reference](https://api.slack.com/methods/admin.conversations.getConversationPrefs). - -#### conversations.getCustomRetention - -```ts -getCustomRetention: Method; -``` - -##### Description - -Get a conversation's retention policy. - -##### See - -[`admin.conversations.getCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.getCustomRetention). - -#### conversations.getTeams - -```ts -getTeams: Method; -``` - -##### Description - -Get all the workspaces a given public or private channel is connected to within -this Enterprise org. - -##### See - -[`admin.conversations.getTeams` API reference](https://api.slack.com/methods/admin.conversations.getTeams). - -#### conversations.invite - -```ts -invite: Method; -``` - -##### Description - -Invite a user to a public or private channel. - -##### See - -[`admin.conversations.invite` API reference](https://api.slack.com/methods/admin.conversations.invite). - -#### conversations.lookup - -```ts -lookup: Method; -``` - -##### Description - -Returns channels on the given team using the filters. - -##### See - -[`admin.conversations.lookup` API reference](https://api.slack.com/methods/admin.conversations.lookup). - -#### conversations.removeCustomRetention - -```ts -removeCustomRetention: Method; -``` - -##### Description - -Remove a conversation's retention policy. - -##### See - -[`admin.conversations.removeCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.removeCustomRetention). - -#### conversations.rename - -```ts -rename: Method; -``` - -##### Description - -Rename a public or private channel. - -##### See - -[`admin.conversations.rename` API reference](https://api.slack.com/methods/admin.conversations.rename). - -#### conversations.restrictAccess - -```ts -restrictAccess: object; -``` - -#### conversations.restrictAccess.addGroup - -```ts -addGroup: Method; -``` - -##### Description - -Add an allowlist of IDP groups for accessing a channel. - -##### See - -[`admin.conversations.restrictAccess.addGroup` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup). - -#### conversations.restrictAccess.listGroups - -```ts -listGroups: Method; -``` - -##### Description - -List all IDP Groups linked to a channel. - -##### See - -[`admin.conversations.restrictAccess.listGroups` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups). - -#### conversations.restrictAccess.removeGroup - -```ts -removeGroup: Method; -``` - -##### Description - -Remove a linked IDP group linked from a private channel. - -##### See - -[`admin.conversations.restrictAccess.removeGroup` API reference](https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup). - -#### conversations.search - -```ts -search: Method; -``` - -##### Description - -Search for public or private channels in an Enterprise organization. - -##### See - -[`admin.conversations.search` API reference](https://api.slack.com/methods/admin.conversations.search). - -#### conversations.setConversationPrefs - -```ts -setConversationPrefs: Method; -``` - -##### Description - -Set the posting permissions for a public or private channel. - -##### See - -[`admin.conversations.setConversationPrefs` API reference](https://api.slack.com/methods/admin.conversations.setConversationPrefs). - -#### conversations.setCustomRetention - -```ts -setCustomRetention: Method; -``` - -##### Description - -Set a conversation's retention policy. - -##### See - -[`admin.conversations.setCustomRetention` API reference](https://api.slack.com/methods/admin.conversations.setCustomRetention). - -#### conversations.setTeams - -```ts -setTeams: Method; -``` - -##### Description - -Set the workspaces in an Enterprise grid org that connect to a public or private channel. - -##### See - -[`admin.conversations.setTeams` API reference](https://api.slack.com/methods/admin.conversations.setTeams). - -#### conversations.unarchive - -```ts -unarchive: Method; -``` - -##### Description - -Unarchive a public or private channel. - -##### See - -[`admin.conversations.unarchive` API reference](https://api.slack.com/methods/admin.conversations.unarchive). - -#### emoji - -```ts -emoji: object; -``` - -#### emoji.add - -```ts -add: Method; -``` - -##### Description - -Add an emoji. - -##### See - -[`admin.emoji.add` API reference](https://api.slack.com/methods/admin.emoji.add). - -#### emoji.addAlias - -```ts -addAlias: Method; -``` - -##### Description - -Add an emoji alias. - -##### See - -[`admin.emoji.addAlias` API reference](https://api.slack.com/methods/admin.emoji.addAlias). - -#### emoji.list - -```ts -list: Method; -``` - -##### Description - -List emoji for an Enterprise Grid organization. - -##### See - -[`admin.emoji.list` API reference](https://api.slack.com/methods/admin.emoji.list). - -#### emoji.remove - -```ts -remove: Method; -``` - -##### Description - -Remove an emoji across an Enterprise Grid organization. - -##### See - -[`admin.emoji.remove` API reference](https://api.slack.com/methods/admin.emoji.remove). - -#### emoji.rename - -```ts -rename: Method; -``` - -##### Description - -Rename an emoji. - -##### See - -[`admin.emoji.rename` API reference](https://api.slack.com/methods/admin.emoji.rename). - -#### functions - -```ts -functions: object; -``` - -#### functions.list - -```ts -list: Method; -``` - -##### Description - -Look up functions by a set of apps. - -##### See - -[`admin.functions.list` API reference](https://api.slack.com/methods/admin.functions.list). - -#### functions.permissions - -```ts -permissions: object; -``` - -#### functions.permissions.lookup - -```ts -lookup: Method; -``` - -##### Description - -Lookup the visibility of multiple Slack functions and include the users if -it is limited to particular named entities. - -##### See - -[`admin.functions.permissions.lookup` API reference](https://api.slack.com/methods/admin.functions.permissions.lookup). - -#### functions.permissions.set - -```ts -set: Method; -``` - -##### Description - -Set the visibility of a Slack function and define the users or workspaces if -it is set to named_entities. - -##### See - -[`admin.functions.permissions.set` API reference](https://api.slack.com/methods/admin.functions.permissions.set). - -#### inviteRequests - -```ts -inviteRequests: object; -``` - -#### inviteRequests.approve - -```ts -approve: Method; -``` - -##### Description - -Approve a workspace invite request. - -##### See - -[`admin.inviteRequests.approve` API reference](https://api.slack.com/methods/admin.inviteRequests.approve). - -#### inviteRequests.approved - -```ts -approved: object; -``` - -#### inviteRequests.approved.list - -```ts -list: Method; -``` - -##### Description - -List all approved workspace invite requests. - -##### See - -[`admin.inviteRequests.approved.list` API reference](https://api.slack.com/methods/admin.inviteRequests.approved.list). - -#### inviteRequests.denied - -```ts -denied: object; -``` - -#### inviteRequests.denied.list - -```ts -list: Method; -``` - -##### Description - -List all denied workspace invite requests. - -##### See - -[`admin.inviteRequests.denied.list` API reference](https://api.slack.com/methods/admin.inviteRequests.denied.list). - -#### inviteRequests.deny - -```ts -deny: Method; -``` - -##### Description - -Deny a workspace invite request. - -##### See - -[`admin.inviteRequests.deny` API reference](https://api.slack.com/methods/admin.inviteRequests.deny). - -#### inviteRequests.list - -```ts -list: Method; -``` - -##### Description - -List all pending workspace invite requests. - -##### See - -[`admin.inviteRequests.list` API reference](https://api.slack.com/methods/admin.inviteRequests.list). - -#### roles - -```ts -roles: object; -``` - -#### roles.addAssignments - -```ts -addAssignments: Method; -``` - -##### Description - -Adds members to the specified role with the specified scopes. - -##### See - -[`admin.roles.addAssignments` API reference](https://api.slack.com/methods/admin.roles.addAssignments). - -#### roles.listAssignments - -```ts -listAssignments: Method; -``` - -##### Description - -Lists assignments for all roles across entities. -Options to scope results by any combination of roles or entities. - -##### See - -[`admin.roles.listAssignments` API reference](https://api.slack.com/methods/admin.roles.listAssignments). - -#### roles.removeAssignments - -```ts -removeAssignments: Method; -``` - -##### Description - -Removes a set of users from a role for the given scopes and entities. - -##### See - -[`admin.roles.removeAssignments` API reference](https://api.slack.com/methods/admin.roles.removeAssignments). - -#### teams - -```ts -teams: object; -``` - -#### teams.admins - -```ts -admins: object; -``` - -#### teams.admins.list - -```ts -list: Method; -``` - -##### Description - -List all of the admins on a given workspace. - -##### See - -[`admin.teams.admins.list` API reference](https://api.slack.com/methods/admin.teams.admins.list). - -#### teams.create - -```ts -create: Method; -``` - -##### Description - -Create an Enterprise team. - -##### See - -[`admin.teams.create` API reference](https://api.slack.com/methods/admin.teams.create). - -#### teams.list - -```ts -list: Method; -``` - -##### Description - -List all teams on an Enterprise organization. - -##### See - -[`admin.teams.list` API reference](https://api.slack.com/methods/admin.teams.list). - -#### teams.owners - -```ts -owners: object; -``` - -#### teams.owners.list - -```ts -list: Method; -``` - -##### Description - -List all of the owners on a given workspace. - -##### See - -[`admin.teams.owners.list` API reference](https://api.slack.com/methods/admin.teams.owners.list). - -#### teams.settings - -```ts -settings: object; -``` - -#### teams.settings.info - -```ts -info: Method; -``` - -##### Description - -Fetch information about settings in a workspace. - -##### See - -[`admin.teams.owners.list` API reference](https://api.slack.com/methods/admin.teams.owners.list). - -#### teams.settings.setDefaultChannels - -```ts -setDefaultChannels: Method; -``` - -##### Description - -Set the default channels of a workspace. - -##### See - -[`admin.teams.settings.setDefaultChannels` API reference](https://api.slack.com/methods/admin.teams.settings.setDefaultChannels). - -#### teams.settings.setDescription - -```ts -setDescription: Method; -``` - -##### Description - -Set the description of a given workspace. - -##### See - -[`admin.teams.settings.setDescription` API reference](https://api.slack.com/methods/admin.teams.settings.setDescription). - -#### teams.settings.setDiscoverability - -```ts -setDiscoverability: Method; -``` - -##### Description - -Set the discoverability of a given workspace. - -##### See - -[`admin.teams.settings.setDiscoverability` API reference](https://api.slack.com/methods/admin.teams.settings.setDiscoverability). - -#### teams.settings.setIcon - -```ts -setIcon: Method; -``` - -##### Description - -Sets the icon of a workspace. - -##### See - -[`admin.teams.settings.setIcon` API reference](https://api.slack.com/methods/admin.teams.settings.setIcon). - -#### teams.settings.setName - -```ts -setName: Method; -``` - -##### Description - -Set the name of a given workspace. - -##### See - -[`admin.teams.settings.setName` API reference](https://api.slack.com/methods/admin.teams.settings.setName). - -#### usergroups - -```ts -usergroups: object; -``` - -#### usergroups.addChannels - -```ts -addChannels: Method; -``` - -##### Description - -Add up to one hundred default channels to an IDP group. - -##### See - -[`admin.teams.usergroups.addChannels` API reference](https://api.slack.com/methods/admin.usergroups.addChannels). - -#### usergroups.addTeams - -```ts -addTeams: Method; -``` - -##### Description - -Associate one or more default workspaces with an organization-wide IDP group. - -##### See - -[`admin.teams.usergroups.addTeams` API reference](https://api.slack.com/methods/admin.usergroups.addTeams). - -#### usergroups.listChannels - -```ts -listChannels: Method; -``` - -##### Description - -List the channels linked to an org-level IDP group (user group). - -##### See - -[`admin.teams.usergroups.listChannels` API reference](https://api.slack.com/methods/admin.usergroups.listChannels). - -#### usergroups.removeChannels - -```ts -removeChannels: Method; -``` - -##### Description - -Remove one or more default channels from an org-level IDP group (user group). - -##### See - -[`admin.teams.usergroups.removeChannels` API reference](https://api.slack.com/methods/admin.usergroups.removeChannels). - -#### users - -```ts -users: object; -``` - -#### users.assign - -```ts -assign: Method; -``` - -##### Description - -Add an Enterprise user to a workspace. - -##### See - -[`admin.users.assign` API reference](https://api.slack.com/methods/admin.users.assign). - -#### users.invite - -```ts -invite: Method; -``` - -##### Description - -Invite a user to a workspace. - -##### See - -[`admin.users.invite` API reference](https://api.slack.com/methods/admin.users.invite). - -#### users.list - -```ts -list: Method; -``` - -##### Description - -List users on a workspace. - -##### See - -[`admin.users.list` API reference](https://api.slack.com/methods/admin.users.list). - -#### users.remove - -```ts -remove: Method; -``` - -##### Description - -Remove a user from a workspace. - -##### See - -[`admin.users.remove` API reference](https://api.slack.com/methods/admin.users.remove). - -#### users.session - -```ts -session: object; -``` - -#### users.session.clearSettings - -```ts -clearSettings: Method; -``` - -##### Description - -Clear user-specific session settings—the session duration and what happens when the client -closes—for a list of users. - -##### See - -[`admin.users.session.clearSettings` API reference](https://api.slack.com/methods/admin.users.session.clearSettings). - -#### users.session.getSettings - -```ts -getSettings: Method; -``` - -##### Description - -Get user-specific session settings—the session duration and what happens when the client -closes—given a list of users. - -##### See - -[`admin.users.session.getSettings` API reference](https://api.slack.com/methods/admin.users.session.getSettings). - -#### users.session.invalidate - -```ts -invalidate: Method; -``` - -##### Description - -Revoke a single session for a user. The user will be forced to login to Slack. - -##### See - -[`admin.users.session.invalidate` API reference](https://api.slack.com/methods/admin.users.session.invalidate). - -#### users.session.list - -```ts -list: Method; -``` - -##### Description - -List active user sessions for an organization. - -##### See - -[`admin.users.session.list` API reference](https://api.slack.com/methods/admin.users.session.list). - -#### users.session.reset - -```ts -reset: Method; -``` - -##### Description - -Wipes all valid sessions on all devices for a given user. - -##### See - -[`admin.users.session.reset` API reference](https://api.slack.com/methods/admin.users.session.reset). - -#### users.session.resetBulk - -```ts -resetBulk: Method; -``` - -##### Description - -Enqueues an asynchronous job to wipe all valid sessions on all devices for a given user list. - -##### See - -[`admin.users.session.resetBulk` API reference](https://api.slack.com/methods/admin.users.session.resetBulk). - -#### users.session.setSettings - -```ts -setSettings: Method; -``` - -##### Description - -Configure the user-level session settings—the session duration and what happens when the client -closes—for one or more users. - -##### See - -[`admin.users.session.setSettings` API reference](https://api.slack.com/methods/admin.users.session.setSettings). - -#### users.setAdmin - -```ts -setAdmin: Method; -``` - -##### Description - -Set an existing guest, regular user, or owner to be an admin user. - -##### See - -[`admin.users.setAdmin` API reference](https://api.slack.com/methods/admin.users.setAdmin). - -#### users.setExpiration - -```ts -setExpiration: Method; -``` - -##### Description - -Set an expiration for a guest user. - -##### See - -[`admin.users.setExpiration` API reference](https://api.slack.com/methods/admin.users.setExpiration). - -#### users.setOwner - -```ts -setOwner: Method; -``` - -##### Description - -Set an existing guest, regular user, or admin user to be a workspace owner. - -##### See - -[`admin.users.setOwner` API reference](https://api.slack.com/methods/admin.users.setOwner). - -#### users.setRegular - -```ts -setRegular: Method; -``` - -##### Description - -Set an existing guest user, admin user, or owner to be a regular user. - -##### See - -[`admin.users.setRegular` API reference](https://api.slack.com/methods/admin.users.setRegular). - -#### users.unsupportedVersions - -```ts -unsupportedVersions: object; -``` - -#### users.unsupportedVersions.export - -```ts -export: Method; -``` - -##### Description - -Ask Slackbot to send you an export listing all workspace members using unsupported software, -presented as a zipped CSV file. - -##### See - -[`admin.users.unsupportedVersions.export` API reference](https://api.slack.com/methods/admin.users.unsupportedVersions.export). - -#### workflows - -```ts -workflows: object; -``` - -#### workflows.collaborators - -```ts -collaborators: object; -``` - -#### workflows.collaborators.add - -```ts -add: Method; -``` - -##### Description - -Add collaborators to workflows within the team or enterprise. - -##### See - -[`admin.workflows.collaborators.add` API reference](https://api.slack.com/methods/admin.workflows.collaborators.add). - -#### workflows.collaborators.remove - -```ts -remove: Method; -``` - -##### Description - -Remove collaborators from workflows within the team or enterprise. - -##### See - -[`admin.workflows.collaborators.remove` API reference](https://api.slack.com/methods/admin.workflows.collaborators.remove). - -#### workflows.permissions - -```ts -permissions: object; -``` - -#### workflows.permissions.lookup - -```ts -lookup: Method; -``` - -##### Description - -Look up the permissions for a set of workflows. - -##### See - -[`admin.workflows.permissions.lookup` API reference](https://api.slack.com/methods/admin.workflows.permissions.lookup). - -#### workflows.search - -```ts -search: Method; -``` - -##### Description - -Search workflows within the team or enterprise. - -##### See - -[`admin.workflows.search` API reference](https://api.slack.com/methods/admin.workflows.search). - -#### workflows.unpublish - -```ts -unpublish: Method; -``` - -##### Description - -Unpublish workflows within the team or enterprise. - -##### See - -[`admin.workflows.unpublish` API reference](https://api.slack.com/methods/admin.workflows.unpublish). - -#### Inherited from - -[`Methods`](Methods.md).[`admin`](Methods.md#admin) - -#### Defined in - -[packages/web-api/src/methods.ts:546](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L546) - -*** - -### api - -```ts -readonly api: object; -``` - -#### test - -```ts -test: Method; -``` - -##### Description - -Checks API calling code. - -##### See - -[`api.test` API reference](https://api.slack.com/methods/api.test). - -#### Inherited from - -[`Methods`](Methods.md).[`api`](Methods.md#api) - -#### Defined in - -[packages/web-api/src/methods.ts:1221](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1221) - -*** - -### apps - -```ts -readonly apps: object; -``` - -#### connections - -```ts -connections: object; -``` - -#### connections.open - -```ts -open: Method; -``` - -##### Description - -Generate a temporary Socket Mode WebSocket URL that your app can connect to in order to receive -events and interactive payloads over. - -##### See - -[`apps.connections.open` API reference](https://api.slack.com/methods/apps.connections.open). - -#### event - -```ts -event: object; -``` - -#### event.authorizations - -```ts -authorizations: object; -``` - -#### event.authorizations.list - -```ts -list: Method; -``` - -##### Description - -Get a list of authorizations for the given event context. -Each authorization represents an app installation that the event is visible to. - -##### See - -[`apps.event.authorizations.list` API reference](https://api.slack.com/methods/apps.event.authorizations.list). - -#### manifest - -```ts -manifest: object; -``` - -#### manifest.create - -```ts -create: Method; -``` - -##### Description - -Create an app from an app manifest. - -##### See - -[`apps.manifest.create` API reference](https://api.slack.com/methods/apps.manifest.create). - -#### manifest.delete - -```ts -delete: Method; -``` - -##### Description - -Permanently deletes an app created through app manifests. - -##### See - -[`apps.manifest.delete` API reference](https://api.slack.com/methods/apps.manifest.delete). - -#### manifest.export - -```ts -export: Method; -``` - -##### Description - -Export an app manifest from an existing app. - -##### See - -[`apps.manifest.export` API reference](https://api.slack.com/methods/apps.manifest.export). - -#### manifest.update - -```ts -update: Method; -``` - -##### Description - -Update an app from an app manifest. - -##### See - -[`apps.manifest.update` API reference](https://api.slack.com/methods/apps.manifest.update). - -#### manifest.validate - -```ts -validate: Method; -``` - -##### Description - -Validate an app manifest. - -##### See - -[`apps.manifest.validate` API reference](https://api.slack.com/methods/apps.manifest.validate). - -#### uninstall - -```ts -uninstall: Method; -``` - -##### Description - -Uninstalls your app from a workspace. - -##### See - -[`apps.uninstall` API reference](https://api.slack.com/methods/apps.uninstall). - -#### Inherited from - -[`Methods`](Methods.md).[`apps`](Methods.md#apps-1) - -#### Defined in - -[packages/web-api/src/methods.ts:1229](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1229) - -*** - -### auth - -```ts -readonly auth: object; -``` - -#### revoke - -```ts -revoke: Method; -``` - -##### Description - -Revokes a token. - -##### See - -[`auth.revoke` API reference](https://api.slack.com/methods/auth.revoke). - -#### teams - -```ts -teams: object; -``` - -#### teams.list - -```ts -list: Method; -``` - -##### Description - -Obtain a full list of workspaces your org-wide app has been approved for. - -##### See - -[`auth.teams.list` API reference](https://api.slack.com/methods/auth.teams.list). - -#### test - -```ts -test: Method; -``` - -#### Inherited from - -[`Methods`](Methods.md).[`auth`](Methods.md#auth-1) - -#### Defined in - -[packages/web-api/src/methods.ts:1285](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1285) - -*** - -### bookmarks - -```ts -readonly bookmarks: object; -``` - -#### add - -```ts -add: Method; -``` - -##### Description - -Add bookmark to a channel. - -##### See - -[`bookmarks.add` API reference](https://api.slack.com/methods/bookmarks.add). - -#### edit - -```ts -edit: Method; -``` - -##### Description - -Edit bookmark. - -##### See - -[`bookmarks.edit` API reference](https://api.slack.com/methods/bookmarks.edit). - -#### list - -```ts -list: Method; -``` - -##### Description - -List bookmarks for a channel. - -##### See - -[`bookmarks.list` API reference](https://api.slack.com/methods/bookmarks.list). - -#### remove - -```ts -remove: Method; -``` - -##### Description - -Remove bookmark from a channel. - -##### See - -[`bookmarks.remove` API reference](https://api.slack.com/methods/bookmarks.remove). - -#### Inherited from - -[`Methods`](Methods.md).[`bookmarks`](Methods.md#bookmarks) - -#### Defined in - -[packages/web-api/src/methods.ts:1301](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1301) - -*** - -### bots - -```ts -readonly bots: object; -``` - -#### info - -```ts -info: Method; -``` - -##### Description - -Gets information about a bot user. - -##### See - -[`bots.info` API reference](https://api.slack.com/methods/bots.info). - -#### Inherited from - -[`Methods`](Methods.md).[`bots`](Methods.md#bots) - -#### Defined in - -[packages/web-api/src/methods.ts:1324](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1324) - -*** - -### calls - -```ts -readonly calls: object; -``` - -#### add - -```ts -add: Method; -``` - -##### Description - -Registers a new Call. - -##### See - -[`calls.add` API reference](https://api.slack.com/methods/calls.add). - -#### end - -```ts -end: Method; -``` - -##### Description - -Ends a Call. - -##### See - -[`calls.end` API reference](https://api.slack.com/methods/calls.end). - -#### info - -```ts -info: Method; -``` - -##### Description - -Returns information about a Call. - -##### See - -[`calls.info` API reference](https://api.slack.com/methods/calls.info). - -#### participants - -```ts -participants: object; -``` - -#### participants.add - -```ts -add: Method; -``` - -##### Description - -Registers new participants added to a Call. - -##### See - -[`calls.participants.add` API reference](https://api.slack.com/methods/calls.participants.add). - -#### participants.remove - -```ts -remove: Method; -``` - -#### update - -```ts -update: Method; -``` - -##### Description - -Updates information about a Call. - -##### See - -[`calls.info` API reference](https://api.slack.com/methods/calls.info). - -#### Inherited from - -[`Methods`](Methods.md).[`calls`](Methods.md#calls) - -#### Defined in - -[packages/web-api/src/methods.ts:1332](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1332) - -*** - -### canvases - -```ts -readonly canvases: object; -``` - -#### access - -```ts -access: object; -``` - -#### access.delete - -```ts -delete: Method; -``` - -##### Description - -Remove access to a canvas for specified entities. - -##### See - -[`canvases.access.delete` API reference](https://api.slack.com/methods/canvases.access.delete). - -#### access.set - -```ts -set: Method; -``` - -##### Description - -Sets the access level to a canvas for specified entities. - -##### See - -[`canvases.access.set` API reference](https://api.slack.com/methods/canvases.access.set). - -#### create - -```ts -create: Method; -``` - -##### Description - -Create Canvas for a user. - -##### See - -[`canvases.create` API reference](https://api.slack.com/methods/canvases.create). - -#### delete - -```ts -delete: Method; -``` - -##### Description - -Deletes a canvas. - -##### See - -[`canvases.delete` API reference](https://api.slack.com/methods/canvases.delete). - -#### edit - -```ts -edit: Method; -``` - -##### Description - -Update an existing canvas. - -##### See - -[`canvases.edit` API reference](https://api.slack.com/methods/canvases.edit). - -#### sections - -```ts -sections: object; -``` - -#### sections.lookup - -```ts -lookup: Method; -``` - -##### Description - -Find sections matching the provided criteria. - -##### See - -[`canvases.sections.lookup` API reference](https://api.slack.com/methods/canvases.sections.lookup). - -#### Inherited from - -[`Methods`](Methods.md).[`canvases`](Methods.md#canvases) - -#### Defined in - -[packages/web-api/src/methods.ts:1363](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1363) - -*** - -### chat - -```ts -readonly chat: object; -``` - -#### delete - -```ts -delete: Method; -``` - -##### Description - -Deletes a message. - -##### See - -[`chat.delete` API reference](https://api.slack.com/methods/chat.delete). - -#### deleteScheduledMessage - -```ts -deleteScheduledMessage: Method; -``` - -##### Description - -Deletes a pending scheduled message from the queue. - -##### See - -[`chat.deleteScheduledMessage` API reference](https://api.slack.com/methods/chat.deleteScheduledMessage). - -#### getPermalink - -```ts -getPermalink: Method; -``` - -##### Description - -Retrieve a permalink URL for a specific extant message. - -##### See - -[`chat.getPermalink` API reference](https://api.slack.com/methods/chat.getPermalink). - -#### meMessage - -```ts -meMessage: Method; -``` - -##### Description - -Share a me message into a channel. - -##### See - -[`chat.meMessage` API reference](https://api.slack.com/methods/chat.meMessage). - -#### postEphemeral - -```ts -postEphemeral: Method; -``` - -##### Description - -Sends an ephemeral message to a user in a channel. - -##### See - -[`chat.postEphemeral` API reference](https://api.slack.com/methods/chat.postEphemeral). - -#### postMessage - -```ts -postMessage: Method; -``` - -##### Description - -Sends a message to a channel. - -##### See - -[`chat.postMessage` API reference](https://api.slack.com/methods/chat.postMessage). - -#### scheduleMessage - -```ts -scheduleMessage: Method; -``` - -##### Description - -Schedules a message to be sent to a channel. - -##### See - -[`chat.scheduleMessage` API reference](https://api.slack.com/methods/chat.scheduleMessage). - -#### scheduledMessages - -```ts -scheduledMessages: object; -``` - -#### scheduledMessages.list - -```ts -list: Method; -``` - -##### Description - -Returns a list of scheduled messages. - -##### See - -[`chat.scheduledMessages.list` API reference](https://api.slack.com/methods/chat.scheduledMessages.list). - -#### unfurl - -```ts -unfurl: Method; -``` - -##### Description - -Provide custom unfurl behavior for user-posted URLs. - -##### See - -[`chat.unfurl` API reference](https://api.slack.com/methods/chat.unfurl). - -#### update - -```ts -update: Method; -``` - -##### Description - -Updates a message. - -##### See - -[`chat.update` API reference](https://api.slack.com/methods/chat.update). - -#### Inherited from - -[`Methods`](Methods.md).[`chat`](Methods.md#chat) - -#### Defined in - -[packages/web-api/src/methods.ts:1400](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1400) - -*** - -### conversations - -```ts -readonly conversations: object; -``` - -#### acceptSharedInvite - -```ts -acceptSharedInvite: Method; -``` - -##### Description - -Accepts an invitation to a Slack Connect channel. - -##### See - -[`conversations.acceptSharedInvite` API reference](https://api.slack.com/methods/conversations.acceptSharedInvite). - -#### approveSharedInvite - -```ts -approveSharedInvite: Method; -``` - -##### Description - -Approves an invitation to a Slack Connect channel. - -##### See - -[`conversations.approveSharedInvite` API reference](https://api.slack.com/methods/conversations.approveSharedInvite). - -#### archive - -```ts -archive: Method; -``` - -##### Description - -Archives a conversation. - -##### See - -[`conversations.archive` API reference](https://api.slack.com/methods/conversations.archive). - -#### canvases - -```ts -canvases: object; -``` - -#### canvases.create - -```ts -create: Method; -``` - -##### Description - -Create a Channel Canvas for a channel. - -##### See - -[`conversations.canvases.create` API reference](https://api.slack.com/methods/conversations.canvases.create). - -#### close - -```ts -close: Method; -``` - -##### Description - -Closes a direct message or multi-person direct message. - -##### See - -[`conversations.close` API reference](https://api.slack.com/methods/conversations.close). - -#### create - -```ts -create: Method; -``` - -##### Description - -Initiates a public or private channel-based conversation. - -##### See - -[`conversations.create` API reference](https://api.slack.com/methods/conversations.create). - -#### declineSharedInvite - -```ts -declineSharedInvite: Method; -``` - -##### Description - -Declines an invitation to a Slack Connect channel. - -##### See - -[`conversations.declineSharedInvite` API reference](https://api.slack.com/methods/conversations.declineSharedInvite). - -#### externalInvitePermissions - -```ts -externalInvitePermissions: object; -``` - -#### externalInvitePermissions.set - -```ts -set: Method; -``` - -##### Description - -Convert a team in a shared channel from an External Limited channel to a fully shared Slack -Connect channel or vice versa. - -##### See - -[`conversations.externalInvitePermissions.set` API reference](https://api.slack.com/methods/conversations.externalInvitePermissions.set). - -#### history - -```ts -history: Method; -``` - -##### Description - -Fetches a conversation's history of messages and events. - -##### See - -[`conversations.history` API reference](https://api.slack.com/methods/conversations.history). - -#### info - -```ts -info: Method; -``` - -##### Description - -Retrieve information about a conversation. - -##### See - -[`conversations.info` API reference](https://api.slack.com/methods/conversations.info). - -#### invite - -```ts -invite: Method; -``` - -##### Description - -Invites users to a channel. - -##### See - -[`conversations.invite` API reference](https://api.slack.com/methods/conversations.invite). - -#### inviteShared - -```ts -inviteShared: Method; -``` - -##### Description - -Sends an invitation to a Slack Connect channel. - -##### See - -[`conversations.inviteShared` API reference](https://api.slack.com/methods/conversations.inviteShared). - -#### join - -```ts -join: Method; -``` - -##### Description - -Joins an existing conversation. - -##### See - -[`conversations.join` API reference](https://api.slack.com/methods/conversations.join). - -#### kick - -```ts -kick: Method; -``` - -##### Description - -Removes a user from a conversation. - -##### See - -[`conversations.kick` API reference](https://api.slack.com/methods/conversations.kick). - -#### leave - -```ts -leave: Method; -``` - -##### Description - -Leaves a conversation. - -##### See - -[`conversations.leave` API reference](https://api.slack.com/methods/conversations.leave). - -#### list - -```ts -list: Method; -``` - -##### Description - -List all channels in a Slack team. - -##### See - -[`conversations.list` API reference](https://api.slack.com/methods/conversations.list). - -#### listConnectInvites - -```ts -listConnectInvites: Method; -``` - -##### Description - -Lists shared channel invites that have been generated or received but have not been approved by -all parties. - -##### See - -[`conversations.listConnectInvites` API reference](https://api.slack.com/methods/conversations.listConnectInvites). - -#### mark - -```ts -mark: Method; -``` - -##### Description - -Sets the read cursor in a channel. - -##### See - -[`conversations.mark` API reference](https://api.slack.com/methods/conversations.mark). - -#### members - -```ts -members: Method; -``` - -##### Description - -Retrieve members of a conversation. - -##### See - -[`conversations.members` API reference](https://api.slack.com/methods/conversations.members). - -#### open - -```ts -open: Method; -``` - -##### Description - -Opens or resumes a direct message or multi-person direct message. - -##### See - -[`conversations.open` API reference](https://api.slack.com/methods/conversations.open). - -#### rename - -```ts -rename: Method; -``` - -##### Description - -Renames a conversation. - -##### See - -[`conversations.rename` API reference](https://api.slack.com/methods/conversations.rename). - -#### replies - -```ts -replies: Method; -``` - -##### Description - -Retrieve a thread of messages posted to a conversation. - -##### See - -[`conversations.replies` API reference](https://api.slack.com/methods/conversations.replies). - -#### setPurpose - -```ts -setPurpose: Method; -``` - -##### Description - -Sets the purpose for a conversation. - -##### See - -[`conversations.setPurpose` API reference](https://api.slack.com/methods/conversations.setPurpose). - -#### setTopic - -```ts -setTopic: Method; -``` - -##### Description - -Sets the topic for a conversation. - -##### See - -[`conversations.setTopic` API reference](https://api.slack.com/methods/conversations.setTopic). - -#### unarchive - -```ts -unarchive: Method; -``` - -##### Description - -Reverses conversation archival. - -##### See - -[`conversations.unarchive` API reference](https://api.slack.com/methods/conversations.unarchive). - -#### Inherited from - -[`Methods`](Methods.md).[`conversations`](Methods.md#conversations-1) - -#### Defined in - -[packages/web-api/src/methods.ts:1463](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1463) - -*** - -### dialog - -```ts -readonly dialog: object; -``` - -#### open - -```ts -open: Method; -``` - -##### Description - -Open a dialog with a user. - -##### See - -[`dialog.open` API reference](https://api.slack.com/methods/dialog.open). - -#### Inherited from - -[`Methods`](Methods.md).[`dialog`](Methods.md#dialog) - -#### Defined in - -[packages/web-api/src/methods.ts:1622](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1622) - -*** - -### dnd - -```ts -readonly dnd: object; -``` - -#### endDnd - -```ts -endDnd: Method; -``` - -##### Description - -Ends the current user's Do Not Disturb session immediately. - -##### See - -[`dnd.endDnd` API reference](https://api.slack.com/methods/dnd.endDnd). - -#### endSnooze - -```ts -endSnooze: Method; -``` - -##### Description - -Ends the current user's snooze mode immediately. - -##### See - -[`dnd.endSnooze` API reference](https://api.slack.com/methods/dnd.endSnooze). - -#### info - -```ts -info: Method; -``` - -##### Description - -Retrieves a user's current Do Not Disturb status. - -##### See - -[`dnd.info` API reference](https://api.slack.com/methods/dnd.info). - -#### setSnooze - -```ts -setSnooze: Method; -``` - -##### Description - -Turns on Do Not Disturb mode for the current user, or changes its duration. - -##### See - -[`dnd.setSnooze` API reference](https://api.slack.com/methods/dnd.setSnooze). - -#### teamInfo - -```ts -teamInfo: Method; -``` - -##### Description - -Retrieves the Do Not Disturb status for up to 50 users on a team. - -##### See - -[`dnd.teamInfo` API reference](https://api.slack.com/methods/dnd.teamInfo). - -#### Inherited from - -[`Methods`](Methods.md).[`dnd`](Methods.md#dnd) - -#### Defined in - -[packages/web-api/src/methods.ts:1630](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1630) - -*** - -### emoji - -```ts -readonly emoji: object; -``` - -#### list - -```ts -list: Method; -``` - -##### Description - -Lists custom emoji for a team. - -##### See - -[`emoji.list` API reference](https://api.slack.com/methods/emoji.list). - -#### Inherited from - -[`Methods`](Methods.md).[`emoji`](Methods.md#emoji-1) - -#### Defined in - -[packages/web-api/src/methods.ts:1658](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1658) - -*** - -### files - -```ts -readonly files: object; -``` - -#### comments - -```ts -comments: object; -``` - -#### comments.delete - -```ts -delete: Method; -``` - -##### Description - -Deletes an existing comment on a file. - -##### See - -[`files.comments.delete` API reference](https://api.slack.com/methods/files.comments.delete). - -#### completeUploadExternal - -```ts -completeUploadExternal: Method; -``` - -##### Description - -Finishes an upload started with [`files.getUploadURLExternal`](https://api.slack.com/methods/files.getUploadURLExternal). - -##### See - -[`files.completeUploadExternal` API reference](https://api.slack.com/methods/files.completeUploadExternal). - -#### delete - -```ts -delete: Method; -``` - -##### Description - -Deletes a file. - -##### See - -[`files.delete` API reference](https://api.slack.com/methods/files.delete). - -#### getUploadURLExternal - -```ts -getUploadURLExternal: Method; -``` - -##### Description - -Gets a URL for an edge external file upload. - -##### See - -[`files.getUploadURLExternal` API reference](https://api.slack.com/methods/files.getUploadURLExternal). - -#### info - -```ts -info: Method; -``` - -##### Description - -Gets information about a file. - -##### See - -[`files.info` API reference](https://api.slack.com/methods/files.info). - -#### list - -```ts -list: Method; -``` - -##### Description - -List files for a team, in a channel, or from a user with applied filters. - -##### See - -[`files.list` API reference](https://api.slack.com/methods/files.list). - -#### remote - -```ts -remote: object; -``` - -#### remote.add - -```ts -add: Method; -``` - -##### Description - -Adds a file from a remote service. - -##### See - -[`files.remote.add` API reference](https://api.slack.com/methods/files.remote.add). - -#### remote.info - -```ts -info: Method; -``` - -##### Description - -Retrieve information about a remote file added to Slack. - -##### See - -[`files.remote.info` API reference](https://api.slack.com/methods/files.remote.info). - -#### remote.list - -```ts -list: Method; -``` - -##### Description - -List remote files added to Slack. - -##### See - -[`files.remote.list` API reference](https://api.slack.com/methods/files.remote.list). - -#### remote.remove - -```ts -remove: Method; -``` - -##### Description - -Remove a remote file. - -##### See - -[`files.remote.remove` API reference](https://api.slack.com/methods/files.remote.remove). - -#### remote.share - -```ts -share: Method; -``` - -##### Description - -Share a remote file into a channel. - -##### See - -[`files.remote.share` API reference](https://api.slack.com/methods/files.remote.share). - -#### remote.update - -```ts -update: Method; -``` - -##### Description - -Updates an existing remote file. - -##### See - -[`files.remote.update` API reference](https://api.slack.com/methods/files.remote.update). - -#### revokePublicURL - -```ts -revokePublicURL: Method; -``` - -##### Description - -Revokes public/external sharing access for a file. - -##### See - -[`files.revokePublicURL` API reference](https://api.slack.com/methods/files.revokePublicURL). - -#### sharedPublicURL - -```ts -sharedPublicURL: Method; -``` - -##### Description - -Enables a file for public/external sharing. - -##### See - -[`files.revokePublicURL` API reference](https://api.slack.com/methods/files.revokePublicURL). - -#### ~~upload~~ - -```ts -upload: Method; -``` - -##### Description - -Uploads or creates a file. - -##### Deprecated - -Use `uploadV2` instead. See [our post on retiring `files.upload`](https://api.slack.com/changelog/2024-04-a-better-way-to-upload-files-is-here-to-stay). - -##### See - -[`files.upload` API reference](https://api.slack.com/methods/files.upload). - -#### uploadV2 - -```ts -uploadV2: Method; -``` - -##### Description - -Custom method to support a new way of uploading files to Slack. -Supports a single file upload -Supply: -- (required) single file or content -- (optional) channel, alt_text, snippet_type, -Supports multiple file uploads -Supply: -- multiple upload_files -Will try to honor both single file or content data supplied as well -as multiple file uploads property. - -##### See - -[`@slack/web-api` Upload a file documentation](https://slack.dev/node-slack-sdk/web-api#upload-a-file). - -#### Inherited from - -[`Methods`](Methods.md).[`files`](Methods.md#files) - -#### Defined in - -[packages/web-api/src/methods.ts:1666](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1666) - -*** - -### functions - -```ts -readonly functions: object; -``` - -#### completeError - -```ts -completeError: Method; -``` - -##### Description - -Signal the failure to execute a Custom Function. - -##### See - -[`functions.completeError` API reference](https://api.slack.com/methods/functions.completeError). - -#### completeSuccess - -```ts -completeSuccess: Method; -``` - -##### Description - -Signal the successful completion of a Custom Function. - -##### See - -[`functions.completeSuccess` API reference](https://api.slack.com/methods/functions.completeSuccess). - -#### Inherited from - -[`Methods`](Methods.md).[`functions`](Methods.md#functions-1) - -#### Defined in - -[packages/web-api/src/methods.ts:1767](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1767) - -*** - -### migration - -```ts -readonly migration: object; -``` - -#### exchange - -```ts -exchange: Method; -``` - -##### Description - -For Enterprise Grid workspaces, map local user IDs to global user IDs. - -##### See - -[`migration.exchange` API reference](https://api.slack.com/methods/migration.exchange). - -#### Inherited from - -[`Methods`](Methods.md).[`migration`](Methods.md#migration) - -#### Defined in - -[packages/web-api/src/methods.ts:1783](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1783) - -*** - -### oauth - -```ts -readonly oauth: object; -``` - -#### ~~access~~ - -```ts -access: Method; -``` - -##### Description - -Exchanges a temporary OAuth verifier code for an access token. - -##### Deprecated - -This is a legacy method only used by classic Slack apps. Use `oauth.v2.access` for new Slack apps. - -##### See - -[`oauth.access` API reference](https://api.slack.com/methods/oauth.access). - -#### v2 - -```ts -v2: object; -``` - -#### v2.access - -```ts -access: Method; -``` - -##### Description - -Exchanges a temporary OAuth verifier code for an access token. - -##### See - -[`oauth.v2.access` API reference](https://api.slack.com/methods/oauth.v2.access). - -#### v2.exchange - -```ts -exchange: Method; -``` - -##### Description - -Exchanges a legacy access token for a new expiring access token and refresh token. - -##### See - -[`oauth.v2.exchange` API reference](https://api.slack.com/methods/oauth.v2.exchange). - -#### Inherited from - -[`Methods`](Methods.md).[`oauth`](Methods.md#oauth) - -#### Defined in - -[packages/web-api/src/methods.ts:1791](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1791) - -*** - -### openid - -```ts -readonly openid: object; -``` - -#### connect - -```ts -connect: object; -``` - -#### connect.token - -```ts -token: Method; -``` - -##### Description - -Exchanges a temporary OAuth verifier code for an access token for [Sign in with Slack](https://api.slack.com/authentication/sign-in-with-slack). - -##### See - -[`openid.connect.token` API reference](https://api.slack.com/methods/openid.connect.token). - -#### connect.userInfo - -```ts -userInfo: Method; -``` - -##### Description - -Get the identity of a user who has authorized [Sign in with Slack](https://api.slack.com/authentication/sign-in-with-slack). - -##### See - -[`openid.connect.userInfo` API reference](https://api.slack.com/methods/openid.connect.userInfo). - -#### Inherited from - -[`Methods`](Methods.md).[`openid`](Methods.md#openid) - -#### Defined in - -[packages/web-api/src/methods.ts:1812](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1812) - -*** - -### pins - -```ts -readonly pins: object; -``` - -#### add - -```ts -add: Method; -``` - -##### Description - -Pins an item to a channel. - -##### See - -[`pins.add` API reference](https://api.slack.com/methods/pins.add). - -#### list - -```ts -list: Method; -``` - -##### Description - -Lists items pinned to a channel. - -##### See - -[`pins.list` API reference](https://api.slack.com/methods/pins.list). - -#### remove - -```ts -remove: Method; -``` - -##### Description - -Un-pins an item from a channel. - -##### See - -[`pins.remove` API reference](https://api.slack.com/methods/pins.remove). - -#### Inherited from - -[`Methods`](Methods.md).[`pins`](Methods.md#pins) - -#### Defined in - -[packages/web-api/src/methods.ts:1827](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1827) - -*** - -### reactions - -```ts -readonly reactions: object; -``` - -#### add - -```ts -add: Method; -``` - -##### Description - -Adds a reaction to an item. - -##### See - -[`reactions.add` API reference](https://api.slack.com/methods/reactions.add). - -#### get - -```ts -get: Method; -``` - -##### Description - -Gets reactions for an item. - -##### See - -[`reactions.get` API reference](https://api.slack.com/methods/reactions.get). - -#### list - -```ts -list: Method; -``` - -##### Description - -List reactions made by a user. - -##### See - -[`reactions.list` API reference](https://api.slack.com/methods/reactions.list). - -#### remove - -```ts -remove: Method; -``` - -##### Description - -Removes a reaction from an item. - -##### See - -[`reactions.remove` API reference](https://api.slack.com/methods/reactions.remove). - -#### Inherited from - -[`Methods`](Methods.md).[`reactions`](Methods.md#reactions) - -#### Defined in - -[packages/web-api/src/methods.ts:1845](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1845) - -*** - -### reminders - -```ts -readonly reminders: object; -``` - -#### add - -```ts -add: Method; -``` - -##### Description - -Creates a reminder. - -##### See - -[`reminders.add` API reference](https://api.slack.com/methods/reminders.add). - -#### complete - -```ts -complete: Method; -``` - -##### Description - -Marks a reminder as complete. - -##### See - -[`reminders.complete` API reference](https://api.slack.com/methods/reminders.complete). - -#### delete - -```ts -delete: Method; -``` - -##### Description - -Deletes a reminder. - -##### See - -[`reminders.delete` API reference](https://api.slack.com/methods/reminders.delete). - -#### info - -```ts -info: Method; -``` - -##### Description - -Gets information about a reminder. - -##### See - -[`reminders.info` API reference](https://api.slack.com/methods/reminders.info). - -#### list - -```ts -list: Method; -``` - -##### Description - -Lists all reminders created by or for a given user. - -##### See - -[`reminders.list` API reference](https://api.slack.com/methods/reminders.list). - -#### Inherited from - -[`Methods`](Methods.md).[`reminders`](Methods.md#reminders) - -#### Defined in - -[packages/web-api/src/methods.ts:1870](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1870) - -*** - -### rtm - -```ts -readonly rtm: object; -``` - -#### connect - -```ts -connect: Method; -``` - -##### Description - -Starts a Real Time Messaging session. - -##### See - -[`rtm.connect` API reference](https://api.slack.com/methods/rtm.connect). - -#### ~~start~~ - -```ts -start: Method; -``` - -##### Description - -Starts a Real Time Messaging session. - -##### Deprecated - -Use `rtm.connect` instead. See [our post on retiring `rtm.start`](https://api.slack.com/changelog/2021-10-rtm-start-to-stop). - -##### See - -[`rtm.start` API reference](https://api.slack.com/methods/rtm.start). - -#### Inherited from - -[`Methods`](Methods.md).[`rtm`](Methods.md#rtm) - -#### Defined in - -[packages/web-api/src/methods.ts:1898](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1898) - -*** - -### search - -```ts -readonly search: object; -``` - -#### all - -```ts -all: Method; -``` - -##### Description - -Searches for messages and files matching a query. - -##### See - -[search.all` API reference](https://api.slack.com/methods/search.all). - -#### files - -```ts -files: Method; -``` - -##### Description - -Searches for files matching a query. - -##### See - -[search.files` API reference](https://api.slack.com/methods/search.files). - -#### messages - -```ts -messages: Method; -``` - -##### Description - -Searches for messages matching a query. - -##### See - -[search.messages` API reference](https://api.slack.com/methods/search.messages). - -#### Inherited from - -[`Methods`](Methods.md).[`search`](Methods.md#search-2) - -#### Defined in - -[packages/web-api/src/methods.ts:1912](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1912) - -*** - -### slackApiUrl - -```ts -readonly slackApiUrl: string; -``` - -The base URL for reaching Slack's Web API. Consider changing this value for testing purposes. - -#### Defined in - -[packages/web-api/src/WebClient.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L130) - -*** - -### stars - -```ts -readonly stars: object; -``` - -#### ~~add~~ - -```ts -add: Method; -``` - -##### Description - -Save an item for later. Formerly known as adding a star. - -##### Deprecated - -Stars can still be added but they can no longer be viewed or interacted with by end-users. -See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). - -##### See - -[`stars.add` API reference](https://api.slack.com/methods/stars.add). - -#### ~~list~~ - -```ts -list: Method; -``` - -##### Description - -List a user's saved items, formerly known as stars. - -##### Deprecated - -Stars can still be listed but they can no longer be viewed or interacted with by end-users. -See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). - -##### See - -[`stars.list` API reference](https://api.slack.com/methods/stars.list). - -#### ~~remove~~ - -```ts -remove: Method; -``` - -##### Description - -Remove a saved item from a user's saved items, formerly known as stars. - -##### Deprecated - -Stars can still be removed but they can no longer be viewed or interacted with by end-users. -See [our post on stars and the Later list](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders). - -##### See - -[`stars.remove` API reference](https://api.slack.com/methods/stars.remove). - -#### Inherited from - -[`Methods`](Methods.md).[`stars`](Methods.md#stars) - -#### Defined in - -[packages/web-api/src/methods.ts:2140](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2140) - -*** - -### team - -```ts -readonly team: object; -``` - -#### accessLogs - -```ts -accessLogs: Method; -``` - -##### Description - -Gets the access logs for the current team. - -##### See - -[`team.accessLogs` API reference](https://api.slack.com/methods/team.accessLogs). - -#### billableInfo - -```ts -billableInfo: Method; -``` - -##### Description - -Gets billable users information for the current team. - -##### See - -[`team.billableInfo` API reference](https://api.slack.com/methods/team.billableInfo). - -#### billing - -```ts -billing: object; -``` - -#### billing.info - -```ts -info: Method; -``` - -##### Description - -Reads a workspace's billing plan information. - -##### See - -[`team.billing.info` API reference](https://api.slack.com/methods/team.billing.info). - -#### externalTeams - -```ts -externalTeams: object; -``` - -#### externalTeams.disconnect - -```ts -disconnect: Method; -``` - -##### Description - -Disconnect an external organization. - -##### See - -[`team.externalTeams.disconnect` API reference](https://api.slack.com/methods/team.externalTeams.disconnect). - -#### externalTeams.list - -```ts -list: Method; -``` - -##### Description - -Returns a list of all the external teams connected and details about the connection. - -##### See - -[`team.externalTeams.list` API reference](https://api.slack.com/methods/team.externalTeams.list). - -#### info - -```ts -info: Method; -``` - -##### Description - -Gets information about the current team. - -##### See - -[`team.info` API reference](https://api.slack.com/methods/team.info). - -#### integrationLogs - -```ts -integrationLogs: Method; -``` - -##### Description - -Gets the integration logs for the current team. - -##### See - -[`team.integrationLogs` API reference](https://api.slack.com/methods/team.integrationLogs). - -#### preferences - -```ts -preferences: object; -``` - -#### preferences.list - -```ts -list: Method; -``` - -##### Description - -Retrieve a list of a workspace's team preferences. - -##### See - -[`team.preferences.list` API reference](https://api.slack.com/methods/team.preferences.list). - -#### profile - -```ts -profile: object; -``` - -#### profile.get - -```ts -get: Method; -``` - -##### Description - -Retrieve a team's profile. - -##### See - -[`team.profile.get` API reference](https://api.slack.com/methods/team.profile.get). - -#### Inherited from - -[`Methods`](Methods.md).[`team`](Methods.md#team) - -#### Defined in - -[packages/web-api/src/methods.ts:1930](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1930) - -*** - -### token? - -```ts -readonly optional token: string; -``` - -Authentication and authorization token for accessing Slack Web API (usually begins with `xoxp` or `xoxb`) - -#### Defined in - -[packages/web-api/src/WebClient.ts:135](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L135) - -*** - -### tooling - -```ts -readonly tooling: object; -``` - -#### tokens - -```ts -tokens: object; -``` - -#### tokens.rotate - -```ts -rotate: Method; -``` - -##### Description - -Exchanges a refresh token for a new app configuration token. - -##### See - -[`tooling.tokens.rotate` API reference](https://api.slack.com/methods/tooling.tokens.rotate). - -#### Inherited from - -[`Methods`](Methods.md).[`tooling`](Methods.md#tooling) - -#### Defined in - -[packages/web-api/src/methods.ts:1987](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1987) - -*** - -### usergroups - -```ts -readonly usergroups: object; -``` - -#### create - -```ts -create: Method; -``` - -##### Description - -Create a User Group. - -##### See - -[`usergroups.create` API reference](https://api.slack.com/methods/usergroups.create). - -#### disable - -```ts -disable: Method; -``` - -##### Description - -Disable an existing User Group. - -##### See - -[`usergroups.disable` API reference](https://api.slack.com/methods/usergroups.disable). - -#### enable - -```ts -enable: Method; -``` - -##### Description - -Enable an existing User Group. - -##### See - -[`usergroups.enable` API reference](https://api.slack.com/methods/usergroups.enable). - -#### list - -```ts -list: Method; -``` - -##### Description - -List all User Groups for a team. - -##### See - -[`usergroups.list` API reference](https://api.slack.com/methods/usergroups.list). - -#### update - -```ts -update: Method; -``` - -##### Description - -Update an existing User Group. - -##### See - -[`usergroups.update` API reference](https://api.slack.com/methods/usergroups.update). - -#### users - -```ts -users: object; -``` - -#### users.list - -```ts -list: Method; -``` - -##### Description - -List all users in a User Group. - -##### See - -[`usergroups.users.list` API reference](https://api.slack.com/methods/usergroups.users.list). - -#### users.update - -```ts -update: Method; -``` - -##### Description - -Update the list of users in a User Group. - -##### See - -[`usergroups.users.update` API reference](https://api.slack.com/methods/usergroups.users.update). - -#### Inherited from - -[`Methods`](Methods.md).[`usergroups`](Methods.md#usergroups-1) - -#### Defined in - -[packages/web-api/src/methods.ts:1997](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1997) - -*** - -### users - -```ts -readonly users: object; -``` - -#### conversations - -```ts -conversations: Method; -``` - -##### Description - -List conversations the calling user may access. - -##### See - -[`users.conversations` API reference](https://api.slack.com/methods/users.conversations). - -#### deletePhoto - -```ts -deletePhoto: Method; -``` - -##### Description - -Delete the user profile photo. - -##### See - -[`users.deletePhoto` API reference](https://api.slack.com/methods/users.deletePhoto). - -#### discoverableContacts - -```ts -discoverableContacts: object; -``` - -#### discoverableContacts.lookup - -```ts -lookup: Method; -``` - -##### Description - -Lookup an email address to see if someone is on Slack. - -##### See - -[`users.discoverableContacts.lookup` API reference](https://api.slack.com/methods/users.discoverableContacts.lookup). - -#### getPresence - -```ts -getPresence: Method; -``` - -##### Description - -Gets user presence information. - -##### See - -[`users.getPresence` API reference](https://api.slack.com/methods/users.getPresence). - -#### identity - -```ts -identity: Method; -``` - -##### Description - -Get a user's identity. - -##### See - -[`users.identity` API reference](https://api.slack.com/methods/users.identity). - -#### info - -```ts -info: Method; -``` - -##### Description - -Gets information about a user. - -##### See - -[`users.info` API reference](https://api.slack.com/methods/users.info). - -#### list - -```ts -list: Method; -``` - -##### Description - -Lists all users in a Slack team. - -##### See - -[`users.list` API reference](https://api.slack.com/methods/users.list). - -#### lookupByEmail - -```ts -lookupByEmail: Method; -``` - -##### Description - -Find a user with an email address. - -##### See - -[`users.lookupByEmail` API reference](https://api.slack.com/methods/users.lookupByEmail). - -#### profile - -```ts -profile: object; -``` - -#### profile.get - -```ts -get: Method; -``` - -##### Description - -Retrieve a user's profile information, including their custom status. - -##### See - -[`users.profile.get` API reference](https://api.slack.com/methods/users.profile.get). - -#### profile.set - -```ts -set: Method; -``` - -##### Description - -Set a user's profile information, including custom status. - -##### See - -[`users.profile.set` API reference](https://api.slack.com/methods/users.profile.set). - -#### setPhoto - -```ts -setPhoto: Method; -``` - -##### Description - -Set the user profile photo. - -##### See - -[`users.setPhoto` API reference](https://api.slack.com/methods/users.setPhoto). - -#### setPresence - -```ts -setPresence: Method; -``` - -##### Description - -Manually sets user presence. - -##### See - -[`users.setPresence` API reference](https://api.slack.com/methods/users.setPresence). - -#### Inherited from - -[`Methods`](Methods.md).[`users`](Methods.md#users-2) - -#### Defined in - -[packages/web-api/src/methods.ts:2043](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2043) - -*** - -### views - -```ts -readonly views: object; -``` - -#### open - -```ts -open: Method; -``` - -##### Description - -Open a view for a user. - -##### See - -[`views.open` API reference](https://api.slack.com/methods/views.open). - -#### publish - -```ts -publish: Method; -``` - -##### Description - -Publish a static view for a user. - -##### See - -[`views.publish` API reference](https://api.slack.com/methods/views.publish). - -#### push - -```ts -push: Method; -``` - -##### Description - -Push a view onto the stack of a root view. - -##### See - -[`views.push` API reference](https://api.slack.com/methods/views.push). - -#### update - -```ts -update: Method; -``` - -##### Description - -Update an existing view. - -##### See - -[`views.update` API reference](https://api.slack.com/methods/views.update). - -#### Inherited from - -[`Methods`](Methods.md).[`views`](Methods.md#views) - -#### Defined in - -[packages/web-api/src/methods.ts:2110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2110) - -*** - -### workflows - -```ts -readonly workflows: object; -``` - -#### ~~stepCompleted~~ - -```ts -stepCompleted: Method; -``` - -##### Description - -Indicate that an app's step in a workflow completed execution. - -##### Deprecated - -Steps from Apps is deprecated. -We're retiring all Slack app functionality around Steps from Apps in September 2024. -See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). - -##### See - -[`workflows.stepCompleted` API reference](https://api.slack.com/methods/workflows.stepCompleted). - -#### ~~stepFailed~~ - -```ts -stepFailed: Method; -``` - -##### Description - -Indicate that an app's step in a workflow failed to execute. - -##### Deprecated - -Steps from Apps is deprecated. -We're retiring all Slack app functionality around Steps from Apps in September 2024. -See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). - -##### See - -[`workflows.stepFailed` API reference](https://api.slack.com/methods/workflows.stepFailed). - -#### ~~updateStep~~ - -```ts -updateStep: Method; -``` - -##### Description - -Update the configuration for a workflow step. - -##### Deprecated - -Steps from Apps is deprecated. -We're retiring all Slack app functionality around Steps from Apps in September 2024. -See [our post on deprecating Steps from Apps](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). - -##### See - -[`workflows.updateStep` API reference](https://api.slack.com/methods/workflows.updateStep). - -#### Inherited from - -[`Methods`](Methods.md).[`workflows`](Methods.md#workflows-1) - -#### Defined in - -[packages/web-api/src/methods.ts:2164](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2164) - -*** - -### prefixed - -```ts -static prefixed: string | boolean; -``` - -#### Inherited from - -[`Methods`](Methods.md).[`prefixed`](Methods.md#prefixed) - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:9 - -## Methods - -### addListener() - -```ts -addListener( - event, - fn, - context?): this -``` - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• **fn** - -• **context?**: `any` - -#### Returns - -`this` - -#### Inherited from - -[`Methods`](Methods.md).[`addListener`](Methods.md#addlistener) - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:45 - -*** - -### apiCall() - -```ts -apiCall(method, options): Promise -``` - -Generic method for calling a Web API method - -#### Parameters - -• **method**: `string` - -the Web API method to call [https://api.slack.com/methods](https://api.slack.com/methods) - -• **options**: `Record`\<`string`, `unknown`\> = `{}` - -options - -#### Returns - -`Promise`\<[`WebAPICallResult`](../interfaces/WebAPICallResult.md)\> - -#### Overrides - -[`Methods`](Methods.md).[`apiCall`](Methods.md#apicall) - -#### Defined in - -[packages/web-api/src/WebClient.ts:255](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L255) - -*** - -### emit() - -```ts -emit(event, ...args): boolean -``` - -Calls each of the listeners registered for a given event. - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• ...**args**: `any`[] - -#### Returns - -`boolean` - -#### Inherited from - -[`Methods`](Methods.md).[`emit`](Methods.md#emit) - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:32 - -*** - -### eventNames() - -```ts -eventNames(): RATE_LIMITED[] -``` - -Return an array listing the events for which the emitter has registered -listeners. - -#### Returns - -[`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited)[] - -#### Inherited from - -[`Methods`](Methods.md).[`eventNames`](Methods.md#eventnames) - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:15 - -*** - -### filesUploadV2() - -```ts -filesUploadV2(options): Promise -``` - -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 [files.getUploadURLExternal](https://api.slack.com/methods/files.getUploadURLExternal) 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 [files.completeUploadExternal](https://api.slack.com/methods/files.completeUploadExternal) - -#### Parameters - -• **options**: [`FilesUploadV2Arguments`](../type-aliases/FilesUploadV2Arguments.md) - -#### Returns - -`Promise`\<[`WebAPICallResult`](../interfaces/WebAPICallResult.md) & `object`\> - -#### Overrides - -[`Methods`](Methods.md).[`filesUploadV2`](Methods.md#filesuploadv2) - -#### Defined in - -[packages/web-api/src/WebClient.ts:436](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L436) - -*** - -### listenerCount() - -```ts -listenerCount(event): number -``` - -Return the number of listeners listening to a given event. - -#### Parameters - -• **event**: [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Returns - -`number` - -#### Inherited from - -[`Methods`](Methods.md).[`listenerCount`](Methods.md#listenercount) - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:27 - -*** - -### listeners() - -```ts -listeners(event): (...args) => void[] -``` - -Return the listeners registered for a given event. - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -#### Returns - -(...`args`) => `void`[] - -#### Inherited from - -[`Methods`](Methods.md).[`listeners`](Methods.md#listeners) - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:20 - -*** - -### off() - -```ts -off( - event, - fn?, - context?, - once?): this -``` - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• **fn?** - -• **context?**: `any` - -• **once?**: `boolean` - -#### Returns - -`this` - -#### Inherited from - -[`Methods`](Methods.md).[`off`](Methods.md#off) - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:69 - -*** - -### on() - -```ts -on( - event, - fn, - context?): this -``` - -Add a listener for a given event. - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• **fn** - -• **context?**: `any` - -#### Returns - -`this` - -#### Inherited from - -[`Methods`](Methods.md).[`on`](Methods.md#on) - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:40 - -*** - -### once() - -```ts -once( - event, - fn, - context?): this -``` - -Add a one-time listener for a given event. - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• **fn** - -• **context?**: `any` - -#### Returns - -`this` - -#### Inherited from - -[`Methods`](Methods.md).[`once`](Methods.md#once) - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:54 - -*** - -### paginate() - -#### paginate(method, options) - -```ts -paginate(method, options?): AsyncIterable -``` - -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. - -##### Parameters - -• **method**: `string` - -the cursor-paginated Web API method to call [https://api.slack.com/docs/pagination](https://api.slack.com/docs/pagination) - -• **options?**: `Record`\<`string`, `unknown`\> - -options - -##### Returns - -`AsyncIterable`\<[`WebAPICallResult`](../interfaces/WebAPICallResult.md)\> - -##### Defined in - -[packages/web-api/src/WebClient.ts:337](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L337) - -#### paginate(method, options, shouldStop) - -```ts -paginate( - method, - options, -shouldStop): Promise -``` - -##### Parameters - -• **method**: `string` - -• **options**: `Record`\<`string`, `unknown`\> - -• **shouldStop**: [`PaginatePredicate`](../interfaces/PaginatePredicate.md) - -##### Returns - -`Promise`\<`void`\> - -##### Defined in - -[packages/web-api/src/WebClient.ts:338](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L338) - -#### paginate(method, options, shouldStop, reduce) - -```ts -paginate( - method, - options, - shouldStop, -reduce?): Promise -``` - -##### Type Parameters - -• **R** *extends* [`PageReducer`](../interfaces/PageReducer.md)\<`any`\> - -• **A** *extends* `any` - -##### Parameters - -• **method**: `string` - -• **options**: `Record`\<`string`, `unknown`\> - -• **shouldStop**: [`PaginatePredicate`](../interfaces/PaginatePredicate.md) - -• **reduce?**: [`PageReducer`](../interfaces/PageReducer.md)\<`A`\> - -##### Returns - -`Promise`\<`A`\> - -##### Defined in - -[packages/web-api/src/WebClient.ts:343](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L343) - -*** - -### removeAllListeners() - -```ts -removeAllListeners(event?): this -``` - -Remove all listeners, or those of the specified event. - -#### Parameters - -• **event?**: [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Returns - -`this` - -#### Inherited from - -[`Methods`](Methods.md).[`removeAllListeners`](Methods.md#removealllisteners) - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:79 - -*** - -### removeListener() - -```ts -removeListener( - event, - fn?, - context?, - once?): this -``` - -Remove the listeners of a given event. - -#### Type Parameters - -• **T** *extends* [`RATE_LIMITED`](../enumerations/WebClientEvent.md#rate_limited) - -#### Parameters - -• **event**: `T` - -• **fn?** - -• **context?**: `any` - -• **once?**: `boolean` - -#### Returns - -`this` - -#### Inherited from - -[`Methods`](Methods.md).[`removeListener`](Methods.md#removelistener) - -#### Defined in - -packages/web-api/node\_modules/eventemitter3/index.d.ts:63 diff --git a/docs/content/reference/web-api/enumerations/ErrorCode.md b/docs/content/reference/web-api/enumerations/ErrorCode.md deleted file mode 100644 index e1def4210..000000000 --- a/docs/content/reference/web-api/enumerations/ErrorCode.md +++ /dev/null @@ -1,75 +0,0 @@ -# Enumeration: ErrorCode - -A dictionary of codes for errors produced by this package - -## Enumeration Members - -### FileUploadInvalidArgumentsError - -```ts -FileUploadInvalidArgumentsError: "slack_webapi_file_upload_invalid_args_error"; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L25) - -*** - -### FileUploadReadFileDataError - -```ts -FileUploadReadFileDataError: "slack_webapi_file_upload_read_file_data_error"; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L26) - -*** - -### HTTPError - -```ts -HTTPError: "slack_webapi_http_error"; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L20) - -*** - -### PlatformError - -```ts -PlatformError: "slack_webapi_platform_error"; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L21) - -*** - -### RateLimitedError - -```ts -RateLimitedError: "slack_webapi_rate_limited_error"; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L22) - -*** - -### RequestError - -```ts -RequestError: "slack_webapi_request_error"; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L19) diff --git a/docs/content/reference/web-api/enumerations/LogLevel.md b/docs/content/reference/web-api/enumerations/LogLevel.md deleted file mode 100644 index 17a5c7761..000000000 --- a/docs/content/reference/web-api/enumerations/LogLevel.md +++ /dev/null @@ -1,51 +0,0 @@ -# Enumeration: LogLevel - -Severity levels for log entries - -## Enumeration Members - -### DEBUG - -```ts -DEBUG: "debug"; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:8 - -*** - -### ERROR - -```ts -ERROR: "error"; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:5 - -*** - -### INFO - -```ts -INFO: "info"; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:7 - -*** - -### WARN - -```ts -WARN: "warn"; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:6 diff --git a/docs/content/reference/web-api/enumerations/WebClientEvent.md b/docs/content/reference/web-api/enumerations/WebClientEvent.md deleted file mode 100644 index 9b3394cab..000000000 --- a/docs/content/reference/web-api/enumerations/WebClientEvent.md +++ /dev/null @@ -1,13 +0,0 @@ -# Enumeration: WebClientEvent - -## Enumeration Members - -### RATE\_LIMITED - -```ts -RATE_LIMITED: "rate_limited"; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L88) diff --git a/docs/content/reference/web-api/functions/addAppMetadata.md b/docs/content/reference/web-api/functions/addAppMetadata.md deleted file mode 100644 index de58a5538..000000000 --- a/docs/content/reference/web-api/functions/addAppMetadata.md +++ /dev/null @@ -1,23 +0,0 @@ -# Function: addAppMetadata() - -```ts -function addAppMetadata(__namedParameters): void -``` - -Appends the app metadata into the User-Agent value - -## Parameters - -• **\_\_namedParameters** - -• **\_\_namedParameters.name**: `string` - -• **\_\_namedParameters.version**: `string` - -## Returns - -`void` - -## Defined in - -[packages/web-api/src/instrument.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/instrument.ts#L31) diff --git a/docs/content/reference/web-api/index.md b/docs/content/reference/web-api/index.md deleted file mode 100644 index 30b89547b..000000000 --- a/docs/content/reference/web-api/index.md +++ /dev/null @@ -1,683 +0,0 @@ -# @slack/web-api - -## Enumerations - -- [ErrorCode](enumerations/ErrorCode.md) -- [LogLevel](enumerations/LogLevel.md) -- [WebClientEvent](enumerations/WebClientEvent.md) - -## Classes - -- [Methods](classes/Methods.md) -- [WebClient](classes/WebClient.md) - -## Interfaces - -- [Action](interfaces/Action.md) -- [Actionable](interfaces/Actionable.md) -- [ActionsBlock](interfaces/ActionsBlock.md) -- [AdminAnalyticsMemberDetails](interfaces/AdminAnalyticsMemberDetails.md) -- [AdminAnalyticsPublicChannelDetails](interfaces/AdminAnalyticsPublicChannelDetails.md) -- [AdminAnalyticsPublicChannelMetadataDetails](interfaces/AdminAnalyticsPublicChannelMetadataDetails.md) -- [AdminAppsConfigLookupArguments](interfaces/AdminAppsConfigLookupArguments.md) -- [AdminAppsConfigSetArguments](interfaces/AdminAppsConfigSetArguments.md) -- [AdminAuthPolicyAssignEntitiesArguments](interfaces/AdminAuthPolicyAssignEntitiesArguments.md) -- [AdminAuthPolicyGetEntitiesArguments](interfaces/AdminAuthPolicyGetEntitiesArguments.md) -- [AdminAuthPolicyRemoveEntitiesArguments](interfaces/AdminAuthPolicyRemoveEntitiesArguments.md) -- [AdminBarriersCreateArguments](interfaces/AdminBarriersCreateArguments.md) -- [AdminBarriersDeleteArguments](interfaces/AdminBarriersDeleteArguments.md) -- [AdminBarriersUpdateArguments](interfaces/AdminBarriersUpdateArguments.md) -- [AdminConversationsArchiveArguments](interfaces/AdminConversationsArchiveArguments.md) -- [AdminConversationsBulkArchiveArguments](interfaces/AdminConversationsBulkArchiveArguments.md) -- [AdminConversationsBulkDeleteArguments](interfaces/AdminConversationsBulkDeleteArguments.md) -- [AdminConversationsBulkMoveArguments](interfaces/AdminConversationsBulkMoveArguments.md) -- [AdminConversationsConvertToPrivateArguments](interfaces/AdminConversationsConvertToPrivateArguments.md) -- [AdminConversationsConvertToPublicArguments](interfaces/AdminConversationsConvertToPublicArguments.md) -- [AdminConversationsDeleteArguments](interfaces/AdminConversationsDeleteArguments.md) -- [AdminConversationsDisconnectSharedArguments](interfaces/AdminConversationsDisconnectSharedArguments.md) -- [AdminConversationsGetConversationPrefsArguments](interfaces/AdminConversationsGetConversationPrefsArguments.md) -- [AdminConversationsGetCustomRetentionArguments](interfaces/AdminConversationsGetCustomRetentionArguments.md) -- [AdminConversationsGetTeamsArguments](interfaces/AdminConversationsGetTeamsArguments.md) -- [AdminConversationsInviteArguments](interfaces/AdminConversationsInviteArguments.md) -- [AdminConversationsLookupArguments](interfaces/AdminConversationsLookupArguments.md) -- [AdminConversationsRemoveCustomRetentionArguments](interfaces/AdminConversationsRemoveCustomRetentionArguments.md) -- [AdminConversationsRenameArguments](interfaces/AdminConversationsRenameArguments.md) -- [AdminConversationsRestrictAccessAddGroupArguments](interfaces/AdminConversationsRestrictAccessAddGroupArguments.md) -- [AdminConversationsRestrictAccessListGroupsArguments](interfaces/AdminConversationsRestrictAccessListGroupsArguments.md) -- [AdminConversationsRestrictAccessRemoveGroupArguments](interfaces/AdminConversationsRestrictAccessRemoveGroupArguments.md) -- [AdminConversationsSetConversationPrefsArguments](interfaces/AdminConversationsSetConversationPrefsArguments.md) -- [AdminConversationsSetCustomRetentionArguments](interfaces/AdminConversationsSetCustomRetentionArguments.md) -- [AdminConversationsSetTeamsArguments](interfaces/AdminConversationsSetTeamsArguments.md) -- [AdminConversationsUnarchiveArguments](interfaces/AdminConversationsUnarchiveArguments.md) -- [AdminEmojiAddAliasArguments](interfaces/AdminEmojiAddAliasArguments.md) -- [AdminEmojiAddArguments](interfaces/AdminEmojiAddArguments.md) -- [AdminEmojiRemoveArguments](interfaces/AdminEmojiRemoveArguments.md) -- [AdminEmojiRenameArguments](interfaces/AdminEmojiRenameArguments.md) -- [AdminFunctionsListArguments](interfaces/AdminFunctionsListArguments.md) -- [AdminFunctionsPermissionsLookupArguments](interfaces/AdminFunctionsPermissionsLookupArguments.md) -- [AdminFunctionsPermissionsSetArguments](interfaces/AdminFunctionsPermissionsSetArguments.md) -- [AdminInviteRequestsApproveArguments](interfaces/AdminInviteRequestsApproveArguments.md) -- [AdminInviteRequestsApprovedListArguments](interfaces/AdminInviteRequestsApprovedListArguments.md) -- [AdminInviteRequestsDeniedListArguments](interfaces/AdminInviteRequestsDeniedListArguments.md) -- [AdminInviteRequestsDenyArguments](interfaces/AdminInviteRequestsDenyArguments.md) -- [AdminInviteRequestsListArguments](interfaces/AdminInviteRequestsListArguments.md) -- [AdminRolesAddAssignmentsArguments](interfaces/AdminRolesAddAssignmentsArguments.md) -- [AdminRolesRemoveAssignmentsArguments](interfaces/AdminRolesRemoveAssignmentsArguments.md) -- [AdminTeamsAdminsListArguments](interfaces/AdminTeamsAdminsListArguments.md) -- [AdminTeamsCreateArguments](interfaces/AdminTeamsCreateArguments.md) -- [AdminTeamsOwnersListArguments](interfaces/AdminTeamsOwnersListArguments.md) -- [AdminTeamsSettingsInfoArguments](interfaces/AdminTeamsSettingsInfoArguments.md) -- [AdminTeamsSettingsSetDefaultChannelsArguments](interfaces/AdminTeamsSettingsSetDefaultChannelsArguments.md) -- [AdminTeamsSettingsSetDescriptionArguments](interfaces/AdminTeamsSettingsSetDescriptionArguments.md) -- [AdminTeamsSettingsSetDiscoverabilityArguments](interfaces/AdminTeamsSettingsSetDiscoverabilityArguments.md) -- [AdminTeamsSettingsSetIconArguments](interfaces/AdminTeamsSettingsSetIconArguments.md) -- [AdminTeamsSettingsSetNameArguments](interfaces/AdminTeamsSettingsSetNameArguments.md) -- [AdminUsergroupsAddChannelsArguments](interfaces/AdminUsergroupsAddChannelsArguments.md) -- [AdminUsergroupsAddTeamsArguments](interfaces/AdminUsergroupsAddTeamsArguments.md) -- [AdminUsergroupsListChannelsArguments](interfaces/AdminUsergroupsListChannelsArguments.md) -- [AdminUsergroupsRemoveChannelsArguments](interfaces/AdminUsergroupsRemoveChannelsArguments.md) -- [AdminUsersAssignArguments](interfaces/AdminUsersAssignArguments.md) -- [AdminUsersInviteArguments](interfaces/AdminUsersInviteArguments.md) -- [AdminUsersRemoveArguments](interfaces/AdminUsersRemoveArguments.md) -- [AdminUsersSessionClearSettingsArguments](interfaces/AdminUsersSessionClearSettingsArguments.md) -- [AdminUsersSessionGetSettingsArguments](interfaces/AdminUsersSessionGetSettingsArguments.md) -- [AdminUsersSessionInvalidateArguments](interfaces/AdminUsersSessionInvalidateArguments.md) -- [AdminUsersSessionResetArguments](interfaces/AdminUsersSessionResetArguments.md) -- [AdminUsersSessionResetBulkArguments](interfaces/AdminUsersSessionResetBulkArguments.md) -- [AdminUsersSessionSetSettingsArguments](interfaces/AdminUsersSessionSetSettingsArguments.md) -- [AdminUsersSetAdminArguments](interfaces/AdminUsersSetAdminArguments.md) -- [AdminUsersSetExpirationArguments](interfaces/AdminUsersSetExpirationArguments.md) -- [AdminUsersSetOwnerArguments](interfaces/AdminUsersSetOwnerArguments.md) -- [AdminUsersSetRegularArguments](interfaces/AdminUsersSetRegularArguments.md) -- [AdminUsersUnsupportedVersionsExportArguments](interfaces/AdminUsersUnsupportedVersionsExportArguments.md) -- [AdminWorkflowsCollaboratorsAddArguments](interfaces/AdminWorkflowsCollaboratorsAddArguments.md) -- [AdminWorkflowsCollaboratorsRemoveArguments](interfaces/AdminWorkflowsCollaboratorsRemoveArguments.md) -- [AdminWorkflowsPermissionsLookupArguments](interfaces/AdminWorkflowsPermissionsLookupArguments.md) -- [AdminWorkflowsUnpublishArguments](interfaces/AdminWorkflowsUnpublishArguments.md) -- [AppsEventAuthorizationsListArguments](interfaces/AppsEventAuthorizationsListArguments.md) -- [AppsManifestCreateArguments](interfaces/AppsManifestCreateArguments.md) -- [AppsManifestDeleteArguments](interfaces/AppsManifestDeleteArguments.md) -- [AppsManifestExportArguments](interfaces/AppsManifestExportArguments.md) -- [AppsManifestUpdateArguments](interfaces/AppsManifestUpdateArguments.md) -- [AppsManifestValidateArguments](interfaces/AppsManifestValidateArguments.md) -- [AppsUninstallArguments](interfaces/AppsUninstallArguments.md) -- [AttachmentAction](interfaces/AttachmentAction.md) -- [Block](interfaces/Block.md) -- [BookmarksAddArguments](interfaces/BookmarksAddArguments.md) -- [BookmarksEditArguments](interfaces/BookmarksEditArguments.md) -- [BookmarksListArguments](interfaces/BookmarksListArguments.md) -- [BookmarksRemoveArguments](interfaces/BookmarksRemoveArguments.md) -- [Button](interfaces/Button.md) -- [CallUserExternal](interfaces/CallUserExternal.md) -- [CallUserSlack](interfaces/CallUserSlack.md) -- [CallsAddArguments](interfaces/CallsAddArguments.md) -- [CallsEndArguments](interfaces/CallsEndArguments.md) -- [CallsInfoArguments](interfaces/CallsInfoArguments.md) -- [CallsParticipantsAddArguments](interfaces/CallsParticipantsAddArguments.md) -- [CallsParticipantsRemoveArguments](interfaces/CallsParticipantsRemoveArguments.md) -- [CallsUpdateArguments](interfaces/CallsUpdateArguments.md) -- [CanvasesAccessDeleteArguments](interfaces/CanvasesAccessDeleteArguments.md) -- [CanvasesAccessSetArguments](interfaces/CanvasesAccessSetArguments.md) -- [CanvasesDeleteArguments](interfaces/CanvasesDeleteArguments.md) -- [CanvasesEditArguments](interfaces/CanvasesEditArguments.md) -- [CanvasesSectionsLookupArguments](interfaces/CanvasesSectionsLookupArguments.md) -- [ChannelsSelect](interfaces/ChannelsSelect.md) -- [ChatDeleteArguments](interfaces/ChatDeleteArguments.md) -- [ChatDeleteScheduledMessageArguments](interfaces/ChatDeleteScheduledMessageArguments.md) -- [ChatGetPermalinkArguments](interfaces/ChatGetPermalinkArguments.md) -- [ChatMeMessageArguments](interfaces/ChatMeMessageArguments.md) -- [Checkboxes](interfaces/Checkboxes.md) -- [CodedError](interfaces/CodedError.md) -- [Confirm](interfaces/Confirm.md) -- [Confirmable](interfaces/Confirmable.md) -- [Confirmation](interfaces/Confirmation.md) -- [ConfirmationDialog](interfaces/ConfirmationDialog.md) -- [ContextBlock](interfaces/ContextBlock.md) -- [ConversationsApproveSharedInviteArguments](interfaces/ConversationsApproveSharedInviteArguments.md) -- [ConversationsArchiveArguments](interfaces/ConversationsArchiveArguments.md) -- [ConversationsCanvasesCreateArguments](interfaces/ConversationsCanvasesCreateArguments.md) -- [ConversationsCloseArguments](interfaces/ConversationsCloseArguments.md) -- [ConversationsCreateArguments](interfaces/ConversationsCreateArguments.md) -- [ConversationsDeclineSharedInviteArguments](interfaces/ConversationsDeclineSharedInviteArguments.md) -- [ConversationsExternalInvitePermissionsSetArguments](interfaces/ConversationsExternalInvitePermissionsSetArguments.md) -- [ConversationsHistoryArguments](interfaces/ConversationsHistoryArguments.md) -- [ConversationsInfoArguments](interfaces/ConversationsInfoArguments.md) -- [ConversationsInviteArguments](interfaces/ConversationsInviteArguments.md) -- [ConversationsJoinArguments](interfaces/ConversationsJoinArguments.md) -- [ConversationsKickArguments](interfaces/ConversationsKickArguments.md) -- [ConversationsLeaveArguments](interfaces/ConversationsLeaveArguments.md) -- [ConversationsMarkArguments](interfaces/ConversationsMarkArguments.md) -- [ConversationsMembersArguments](interfaces/ConversationsMembersArguments.md) -- [ConversationsRenameArguments](interfaces/ConversationsRenameArguments.md) -- [ConversationsRepliesArguments](interfaces/ConversationsRepliesArguments.md) -- [ConversationsSelect](interfaces/ConversationsSelect.md) -- [ConversationsSetPurposeArguments](interfaces/ConversationsSetPurposeArguments.md) -- [ConversationsSetTopicArguments](interfaces/ConversationsSetTopicArguments.md) -- [ConversationsUnarchiveArguments](interfaces/ConversationsUnarchiveArguments.md) -- [DateTimepicker](interfaces/DateTimepicker.md) -- [Datepicker](interfaces/Datepicker.md) -- [Dialog](interfaces/Dialog.md) -- [DialogOpenArguments](interfaces/DialogOpenArguments.md) -- [DispatchActionConfig](interfaces/DispatchActionConfig.md) -- [Dispatchable](interfaces/Dispatchable.md) -- [DividerBlock](interfaces/DividerBlock.md) -- [DndSetSnoozeArguments](interfaces/DndSetSnoozeArguments.md) -- [DndTeamInfoArguments](interfaces/DndTeamInfoArguments.md) -- [EmailInput](interfaces/EmailInput.md) -- [ExternalSelect](interfaces/ExternalSelect.md) -- [FileBlock](interfaces/FileBlock.md) -- [FileInput](interfaces/FileInput.md) -- [FilesCommentsDeleteArguments](interfaces/FilesCommentsDeleteArguments.md) -- [FilesDeleteArguments](interfaces/FilesDeleteArguments.md) -- [FilesGetUploadURLExternalArguments](interfaces/FilesGetUploadURLExternalArguments.md) -- [FilesInfoArguments](interfaces/FilesInfoArguments.md) -- [FilesListArguments](interfaces/FilesListArguments.md) -- [FilesRemoteAddArguments](interfaces/FilesRemoteAddArguments.md) -- [FilesRemoteListArguments](interfaces/FilesRemoteListArguments.md) -- [FilesRevokePublicURLArguments](interfaces/FilesRevokePublicURLArguments.md) -- [FilesSharedPublicURLArguments](interfaces/FilesSharedPublicURLArguments.md) -- [Focusable](interfaces/Focusable.md) -- [FunctionsCompleteErrorArguments](interfaces/FunctionsCompleteErrorArguments.md) -- [FunctionsCompleteSuccessArguments](interfaces/FunctionsCompleteSuccessArguments.md) -- [HeaderBlock](interfaces/HeaderBlock.md) -- [HomeView](interfaces/HomeView.md) -- [InputBlock](interfaces/InputBlock.md) -- [LinkUnfurls](interfaces/LinkUnfurls.md) -- [Logger](interfaces/Logger.md) -- [MessageAttachment](interfaces/MessageAttachment.md) -- [MessageAttachmentField](interfaces/MessageAttachmentField.md) -- [MessageAttachmentPreview](interfaces/MessageAttachmentPreview.md) -- [MessageMetadata](interfaces/MessageMetadata.md) -- [MessageMetadataEventPayloadObject](interfaces/MessageMetadataEventPayloadObject.md) -- [Method](interfaces/Method.md) -- [MigrationExchangeArguments](interfaces/MigrationExchangeArguments.md) -- [ModalView](interfaces/ModalView.md) -- [MrkdwnElement](interfaces/MrkdwnElement.md) -- [MrkdwnOption](interfaces/MrkdwnOption.md) -- [MultiChannelsSelect](interfaces/MultiChannelsSelect.md) -- [MultiConversationsSelect](interfaces/MultiConversationsSelect.md) -- [MultiExternalSelect](interfaces/MultiExternalSelect.md) -- [MultiStaticSelect](interfaces/MultiStaticSelect.md) -- [MultiUsersSelect](interfaces/MultiUsersSelect.md) -- [NumberInput](interfaces/NumberInput.md) -- [OAuthAccessArguments](interfaces/OAuthAccessArguments.md) -- [OAuthV2AccessArguments](interfaces/OAuthV2AccessArguments.md) -- [OAuthV2ExchangeArguments](interfaces/OAuthV2ExchangeArguments.md) -- [OpenIDConnectTokenArguments](interfaces/OpenIDConnectTokenArguments.md) -- [OptionField](interfaces/OptionField.md) -- [OptionGroup](interfaces/OptionGroup.md) -- [Overflow](interfaces/Overflow.md) -- [PageReducer](interfaces/PageReducer.md) -- [PaginatePredicate](interfaces/PaginatePredicate.md) -- [PinsAddArguments](interfaces/PinsAddArguments.md) -- [PinsListArguments](interfaces/PinsListArguments.md) -- [PinsRemoveArguments](interfaces/PinsRemoveArguments.md) -- [Placeholdable](interfaces/Placeholdable.md) -- [PlainTextElement](interfaces/PlainTextElement.md) -- [PlainTextInput](interfaces/PlainTextInput.md) -- [PlainTextOption](interfaces/PlainTextOption.md) -- [RadioButtons](interfaces/RadioButtons.md) -- [ReactionsAddArguments](interfaces/ReactionsAddArguments.md) -- [RemindersAddArguments](interfaces/RemindersAddArguments.md) -- [RemindersCompleteArguments](interfaces/RemindersCompleteArguments.md) -- [RemindersDeleteArguments](interfaces/RemindersDeleteArguments.md) -- [RemindersInfoArguments](interfaces/RemindersInfoArguments.md) -- [RetryOptions](interfaces/RetryOptions.md) -- [RichTextBlock](interfaces/RichTextBlock.md) -- [RichTextBroadcastMention](interfaces/RichTextBroadcastMention.md) -- [RichTextChannelMention](interfaces/RichTextChannelMention.md) -- [RichTextColor](interfaces/RichTextColor.md) -- [RichTextDate](interfaces/RichTextDate.md) -- [RichTextEmoji](interfaces/RichTextEmoji.md) -- [RichTextInput](interfaces/RichTextInput.md) -- [RichTextLink](interfaces/RichTextLink.md) -- [RichTextList](interfaces/RichTextList.md) -- [RichTextPreformatted](interfaces/RichTextPreformatted.md) -- [RichTextQuote](interfaces/RichTextQuote.md) -- [RichTextSection](interfaces/RichTextSection.md) -- [RichTextStyleable](interfaces/RichTextStyleable.md) -- [RichTextTeamMention](interfaces/RichTextTeamMention.md) -- [RichTextText](interfaces/RichTextText.md) -- [RichTextUserMention](interfaces/RichTextUserMention.md) -- [RichTextUsergroupMention](interfaces/RichTextUsergroupMention.md) -- [SearchAllArguments](interfaces/SearchAllArguments.md) -- [SearchFilesArguments](interfaces/SearchFilesArguments.md) -- [SearchMessagesArguments](interfaces/SearchMessagesArguments.md) -- [SectionBlock](interfaces/SectionBlock.md) -- [SelectOption](interfaces/SelectOption.md) -- [SlackFileImageObject](interfaces/SlackFileImageObject.md) -- [StarsListArguments](interfaces/StarsListArguments.md) -- [StaticSelect](interfaces/StaticSelect.md) -- [Timepicker](interfaces/Timepicker.md) -- [ToolingTokensRotateArguments](interfaces/ToolingTokensRotateArguments.md) -- [URLInput](interfaces/URLInput.md) -- [UrlImageObject](interfaces/UrlImageObject.md) -- [UsergroupsCreateArguments](interfaces/UsergroupsCreateArguments.md) -- [UsergroupsDisableArguments](interfaces/UsergroupsDisableArguments.md) -- [UsergroupsEnableArguments](interfaces/UsergroupsEnableArguments.md) -- [UsergroupsUpdateArguments](interfaces/UsergroupsUpdateArguments.md) -- [UsergroupsUsersListArguments](interfaces/UsergroupsUsersListArguments.md) -- [UsergroupsUsersUpdateArguments](interfaces/UsergroupsUsersUpdateArguments.md) -- [UsersConversationsArguments](interfaces/UsersConversationsArguments.md) -- [UsersDeletePhotoArguments](interfaces/UsersDeletePhotoArguments.md) -- [UsersDiscoverableContactsLookupArguments](interfaces/UsersDiscoverableContactsLookupArguments.md) -- [UsersGetPresenceArguments](interfaces/UsersGetPresenceArguments.md) -- [UsersIdentityArguments](interfaces/UsersIdentityArguments.md) -- [UsersInfoArguments](interfaces/UsersInfoArguments.md) -- [UsersListArguments](interfaces/UsersListArguments.md) -- [UsersLookupByEmailArguments](interfaces/UsersLookupByEmailArguments.md) -- [UsersProfileGetArguments](interfaces/UsersProfileGetArguments.md) -- [UsersProfileSetArguments](interfaces/UsersProfileSetArguments.md) -- [UsersSelect](interfaces/UsersSelect.md) -- [UsersSetPhotoArguments](interfaces/UsersSetPhotoArguments.md) -- [UsersSetPresenceArguments](interfaces/UsersSetPresenceArguments.md) -- [VideoBlock](interfaces/VideoBlock.md) -- [ViewsPublishArguments](interfaces/ViewsPublishArguments.md) -- [WebAPICallResult](interfaces/WebAPICallResult.md) -- [WebAPIHTTPError](interfaces/WebAPIHTTPError.md) -- [WebAPIPlatformError](interfaces/WebAPIPlatformError.md) -- [WebAPIRateLimitedError](interfaces/WebAPIRateLimitedError.md) -- [WebAPIRequestError](interfaces/WebAPIRequestError.md) -- [WebClientOptions](interfaces/WebClientOptions.md) -- [WorkflowButton](interfaces/WorkflowButton.md) -- [WorkflowStepView](interfaces/WorkflowStepView.md) -- [WorkflowsStepCompletedArguments](interfaces/WorkflowsStepCompletedArguments.md) -- [WorkflowsStepFailedArguments](interfaces/WorkflowsStepFailedArguments.md) -- [WorkflowsUpdateStepArguments](interfaces/WorkflowsUpdateStepArguments.md) - -## Type Aliases - -- [APITestArguments](type-aliases/APITestArguments.md) -- [AdminAnalyticsGetFileArguments](type-aliases/AdminAnalyticsGetFileArguments.md) -- [AdminAnalyticsGetFileResponse](type-aliases/AdminAnalyticsGetFileResponse.md) -- [AdminAppsActivitiesListArguments](type-aliases/AdminAppsActivitiesListArguments.md) -- [AdminAppsActivitiesListResponse](type-aliases/AdminAppsActivitiesListResponse.md) -- [AdminAppsApproveArguments](type-aliases/AdminAppsApproveArguments.md) -- [AdminAppsApproveResponse](type-aliases/AdminAppsApproveResponse.md) -- [AdminAppsApprovedListArguments](type-aliases/AdminAppsApprovedListArguments.md) -- [AdminAppsApprovedListResponse](type-aliases/AdminAppsApprovedListResponse.md) -- [AdminAppsClearResolutionArguments](type-aliases/AdminAppsClearResolutionArguments.md) -- [AdminAppsClearResolutionResponse](type-aliases/AdminAppsClearResolutionResponse.md) -- [AdminAppsConfigLookupResponse](type-aliases/AdminAppsConfigLookupResponse.md) -- [AdminAppsConfigSetResponse](type-aliases/AdminAppsConfigSetResponse.md) -- [AdminAppsRequestsCancelArguments](type-aliases/AdminAppsRequestsCancelArguments.md) -- [AdminAppsRequestsCancelResponse](type-aliases/AdminAppsRequestsCancelResponse.md) -- [AdminAppsRequestsListArguments](type-aliases/AdminAppsRequestsListArguments.md) -- [AdminAppsRequestsListResponse](type-aliases/AdminAppsRequestsListResponse.md) -- [AdminAppsRestrictArguments](type-aliases/AdminAppsRestrictArguments.md) -- [AdminAppsRestrictResponse](type-aliases/AdminAppsRestrictResponse.md) -- [AdminAppsRestrictedListArguments](type-aliases/AdminAppsRestrictedListArguments.md) -- [AdminAppsRestrictedListResponse](type-aliases/AdminAppsRestrictedListResponse.md) -- [AdminAppsUninstallArguments](type-aliases/AdminAppsUninstallArguments.md) -- [AdminAppsUninstallResponse](type-aliases/AdminAppsUninstallResponse.md) -- [AdminAuthPolicyAssignEntitiesResponse](type-aliases/AdminAuthPolicyAssignEntitiesResponse.md) -- [AdminAuthPolicyGetEntitiesResponse](type-aliases/AdminAuthPolicyGetEntitiesResponse.md) -- [AdminAuthPolicyRemoveEntitiesResponse](type-aliases/AdminAuthPolicyRemoveEntitiesResponse.md) -- [AdminBarriersCreateResponse](type-aliases/AdminBarriersCreateResponse.md) -- [AdminBarriersDeleteResponse](type-aliases/AdminBarriersDeleteResponse.md) -- [AdminBarriersListArguments](type-aliases/AdminBarriersListArguments.md) -- [AdminBarriersListResponse](type-aliases/AdminBarriersListResponse.md) -- [AdminBarriersUpdateResponse](type-aliases/AdminBarriersUpdateResponse.md) -- [AdminConversationsArchiveResponse](type-aliases/AdminConversationsArchiveResponse.md) -- [AdminConversationsBulkArchiveResponse](type-aliases/AdminConversationsBulkArchiveResponse.md) -- [AdminConversationsBulkDeleteResponse](type-aliases/AdminConversationsBulkDeleteResponse.md) -- [AdminConversationsBulkMoveResponse](type-aliases/AdminConversationsBulkMoveResponse.md) -- [AdminConversationsConvertToPrivateResponse](type-aliases/AdminConversationsConvertToPrivateResponse.md) -- [AdminConversationsConvertToPublicResponse](type-aliases/AdminConversationsConvertToPublicResponse.md) -- [AdminConversationsCreateArguments](type-aliases/AdminConversationsCreateArguments.md) -- [AdminConversationsCreateResponse](type-aliases/AdminConversationsCreateResponse.md) -- [AdminConversationsDeleteResponse](type-aliases/AdminConversationsDeleteResponse.md) -- [AdminConversationsDisconnectSharedResponse](type-aliases/AdminConversationsDisconnectSharedResponse.md) -- [AdminConversationsEKMListOriginalConnectedChannelInfoArguments](type-aliases/AdminConversationsEKMListOriginalConnectedChannelInfoArguments.md) -- [AdminConversationsEkmListOriginalConnectedChannelInfoResponse](type-aliases/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.md) -- [AdminConversationsGetConversationPrefsResponse](type-aliases/AdminConversationsGetConversationPrefsResponse.md) -- [AdminConversationsGetCustomRetentionResponse](type-aliases/AdminConversationsGetCustomRetentionResponse.md) -- [AdminConversationsGetTeamsResponse](type-aliases/AdminConversationsGetTeamsResponse.md) -- [AdminConversationsInviteResponse](type-aliases/AdminConversationsInviteResponse.md) -- [AdminConversationsLookupResponse](type-aliases/AdminConversationsLookupResponse.md) -- [AdminConversationsRemoveCustomRetentionResponse](type-aliases/AdminConversationsRemoveCustomRetentionResponse.md) -- [AdminConversationsRenameResponse](type-aliases/AdminConversationsRenameResponse.md) -- [AdminConversationsRestrictAccessAddGroupResponse](type-aliases/AdminConversationsRestrictAccessAddGroupResponse.md) -- [AdminConversationsRestrictAccessListGroupsResponse](type-aliases/AdminConversationsRestrictAccessListGroupsResponse.md) -- [AdminConversationsRestrictAccessRemoveGroupResponse](type-aliases/AdminConversationsRestrictAccessRemoveGroupResponse.md) -- [AdminConversationsSearchArguments](type-aliases/AdminConversationsSearchArguments.md) -- [AdminConversationsSearchResponse](type-aliases/AdminConversationsSearchResponse.md) -- [AdminConversationsSetConversationPrefsResponse](type-aliases/AdminConversationsSetConversationPrefsResponse.md) -- [AdminConversationsSetCustomRetentionResponse](type-aliases/AdminConversationsSetCustomRetentionResponse.md) -- [AdminConversationsSetTeamsResponse](type-aliases/AdminConversationsSetTeamsResponse.md) -- [AdminConversationsUnarchiveResponse](type-aliases/AdminConversationsUnarchiveResponse.md) -- [AdminConversationsWhitelistAddResponse](type-aliases/AdminConversationsWhitelistAddResponse.md) -- [AdminConversationsWhitelistListGroupsLinkedToChannelResponse](type-aliases/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.md) -- [AdminConversationsWhitelistRemoveResponse](type-aliases/AdminConversationsWhitelistRemoveResponse.md) -- [AdminEmojiAddAliasResponse](type-aliases/AdminEmojiAddAliasResponse.md) -- [AdminEmojiAddResponse](type-aliases/AdminEmojiAddResponse.md) -- [AdminEmojiListArguments](type-aliases/AdminEmojiListArguments.md) -- [AdminEmojiListResponse](type-aliases/AdminEmojiListResponse.md) -- [AdminEmojiRemoveResponse](type-aliases/AdminEmojiRemoveResponse.md) -- [AdminEmojiRenameResponse](type-aliases/AdminEmojiRenameResponse.md) -- [AdminFunctionsListResponse](type-aliases/AdminFunctionsListResponse.md) -- [AdminFunctionsPermissionsLookupResponse](type-aliases/AdminFunctionsPermissionsLookupResponse.md) -- [AdminFunctionsPermissionsSetResponse](type-aliases/AdminFunctionsPermissionsSetResponse.md) -- [AdminInviteRequestsApproveResponse](type-aliases/AdminInviteRequestsApproveResponse.md) -- [AdminInviteRequestsApprovedListResponse](type-aliases/AdminInviteRequestsApprovedListResponse.md) -- [AdminInviteRequestsDeniedListResponse](type-aliases/AdminInviteRequestsDeniedListResponse.md) -- [AdminInviteRequestsDenyResponse](type-aliases/AdminInviteRequestsDenyResponse.md) -- [AdminInviteRequestsListResponse](type-aliases/AdminInviteRequestsListResponse.md) -- [AdminRolesAddAssignmentsResponse](type-aliases/AdminRolesAddAssignmentsResponse.md) -- [AdminRolesListAssignmentsArguments](type-aliases/AdminRolesListAssignmentsArguments.md) -- [AdminRolesListAssignmentsResponse](type-aliases/AdminRolesListAssignmentsResponse.md) -- [AdminRolesRemoveAssignmentsResponse](type-aliases/AdminRolesRemoveAssignmentsResponse.md) -- [AdminTeamsAdminsListResponse](type-aliases/AdminTeamsAdminsListResponse.md) -- [AdminTeamsCreateResponse](type-aliases/AdminTeamsCreateResponse.md) -- [AdminTeamsListArguments](type-aliases/AdminTeamsListArguments.md) -- [AdminTeamsListResponse](type-aliases/AdminTeamsListResponse.md) -- [AdminTeamsOwnersListResponse](type-aliases/AdminTeamsOwnersListResponse.md) -- [AdminTeamsSettingsInfoResponse](type-aliases/AdminTeamsSettingsInfoResponse.md) -- [AdminTeamsSettingsSetDefaultChannelsResponse](type-aliases/AdminTeamsSettingsSetDefaultChannelsResponse.md) -- [AdminTeamsSettingsSetDescriptionResponse](type-aliases/AdminTeamsSettingsSetDescriptionResponse.md) -- [AdminTeamsSettingsSetDiscoverabilityResponse](type-aliases/AdminTeamsSettingsSetDiscoverabilityResponse.md) -- [AdminTeamsSettingsSetIconResponse](type-aliases/AdminTeamsSettingsSetIconResponse.md) -- [AdminTeamsSettingsSetNameResponse](type-aliases/AdminTeamsSettingsSetNameResponse.md) -- [AdminUsergroupsAddChannelsResponse](type-aliases/AdminUsergroupsAddChannelsResponse.md) -- [AdminUsergroupsAddTeamsResponse](type-aliases/AdminUsergroupsAddTeamsResponse.md) -- [AdminUsergroupsListChannelsResponse](type-aliases/AdminUsergroupsListChannelsResponse.md) -- [AdminUsergroupsRemoveChannelsResponse](type-aliases/AdminUsergroupsRemoveChannelsResponse.md) -- [AdminUsersAssignResponse](type-aliases/AdminUsersAssignResponse.md) -- [AdminUsersInviteResponse](type-aliases/AdminUsersInviteResponse.md) -- [AdminUsersListArguments](type-aliases/AdminUsersListArguments.md) -- [AdminUsersListResponse](type-aliases/AdminUsersListResponse.md) -- [AdminUsersRemoveResponse](type-aliases/AdminUsersRemoveResponse.md) -- [AdminUsersSessionClearSettingsResponse](type-aliases/AdminUsersSessionClearSettingsResponse.md) -- [AdminUsersSessionGetSettingsResponse](type-aliases/AdminUsersSessionGetSettingsResponse.md) -- [AdminUsersSessionInvalidateResponse](type-aliases/AdminUsersSessionInvalidateResponse.md) -- [AdminUsersSessionListArguments](type-aliases/AdminUsersSessionListArguments.md) -- [AdminUsersSessionListResponse](type-aliases/AdminUsersSessionListResponse.md) -- [AdminUsersSessionResetBulkResponse](type-aliases/AdminUsersSessionResetBulkResponse.md) -- [AdminUsersSessionResetResponse](type-aliases/AdminUsersSessionResetResponse.md) -- [AdminUsersSessionSetSettingsResponse](type-aliases/AdminUsersSessionSetSettingsResponse.md) -- [AdminUsersSetAdminResponse](type-aliases/AdminUsersSetAdminResponse.md) -- [AdminUsersSetExpirationResponse](type-aliases/AdminUsersSetExpirationResponse.md) -- [AdminUsersSetOwnerResponse](type-aliases/AdminUsersSetOwnerResponse.md) -- [AdminUsersSetRegularResponse](type-aliases/AdminUsersSetRegularResponse.md) -- [AdminUsersUnsupportedVersionsExportResponse](type-aliases/AdminUsersUnsupportedVersionsExportResponse.md) -- [AdminWorkflowsCollaboratorsAddResponse](type-aliases/AdminWorkflowsCollaboratorsAddResponse.md) -- [AdminWorkflowsCollaboratorsRemoveResponse](type-aliases/AdminWorkflowsCollaboratorsRemoveResponse.md) -- [AdminWorkflowsPermissionsLookupResponse](type-aliases/AdminWorkflowsPermissionsLookupResponse.md) -- [AdminWorkflowsSearchArguments](type-aliases/AdminWorkflowsSearchArguments.md) -- [AdminWorkflowsSearchResponse](type-aliases/AdminWorkflowsSearchResponse.md) -- [AdminWorkflowsUnpublishResponse](type-aliases/AdminWorkflowsUnpublishResponse.md) -- [ApiTestResponse](type-aliases/ApiTestResponse.md) -- [AppsConnectionsOpenArguments](type-aliases/AppsConnectionsOpenArguments.md) -- [AppsConnectionsOpenResponse](type-aliases/AppsConnectionsOpenResponse.md) -- [AppsEventAuthorizationsListResponse](type-aliases/AppsEventAuthorizationsListResponse.md) -- [AppsManifestCreateResponse](type-aliases/AppsManifestCreateResponse.md) -- [AppsManifestDeleteResponse](type-aliases/AppsManifestDeleteResponse.md) -- [AppsManifestExportResponse](type-aliases/AppsManifestExportResponse.md) -- [AppsManifestUpdateResponse](type-aliases/AppsManifestUpdateResponse.md) -- [AppsManifestValidateResponse](type-aliases/AppsManifestValidateResponse.md) -- [AppsPermissionsInfoResponse](type-aliases/AppsPermissionsInfoResponse.md) -- [AppsPermissionsRequestResponse](type-aliases/AppsPermissionsRequestResponse.md) -- [AppsPermissionsResourcesListResponse](type-aliases/AppsPermissionsResourcesListResponse.md) -- [AppsPermissionsScopesListResponse](type-aliases/AppsPermissionsScopesListResponse.md) -- [AppsPermissionsUsersListResponse](type-aliases/AppsPermissionsUsersListResponse.md) -- [AppsPermissionsUsersRequestResponse](type-aliases/AppsPermissionsUsersRequestResponse.md) -- [AppsUninstallResponse](type-aliases/AppsUninstallResponse.md) -- [AuthRevokeArguments](type-aliases/AuthRevokeArguments.md) -- [AuthRevokeResponse](type-aliases/AuthRevokeResponse.md) -- [AuthTeamsListArguments](type-aliases/AuthTeamsListArguments.md) -- [AuthTeamsListResponse](type-aliases/AuthTeamsListResponse.md) -- [AuthTestArguments](type-aliases/AuthTestArguments.md) -- [AuthTestResponse](type-aliases/AuthTestResponse.md) -- [BookmarksAddResponse](type-aliases/BookmarksAddResponse.md) -- [BookmarksEditResponse](type-aliases/BookmarksEditResponse.md) -- [BookmarksListResponse](type-aliases/BookmarksListResponse.md) -- [BookmarksRemoveResponse](type-aliases/BookmarksRemoveResponse.md) -- [BotsInfoArguments](type-aliases/BotsInfoArguments.md) -- [BotsInfoResponse](type-aliases/BotsInfoResponse.md) -- [CallUser](type-aliases/CallUser.md) -- [CallsAddResponse](type-aliases/CallsAddResponse.md) -- [CallsEndResponse](type-aliases/CallsEndResponse.md) -- [CallsInfoResponse](type-aliases/CallsInfoResponse.md) -- [CallsParticipantsAddResponse](type-aliases/CallsParticipantsAddResponse.md) -- [CallsParticipantsRemoveResponse](type-aliases/CallsParticipantsRemoveResponse.md) -- [CallsUpdateResponse](type-aliases/CallsUpdateResponse.md) -- [CanvasesAccessDeleteResponse](type-aliases/CanvasesAccessDeleteResponse.md) -- [CanvasesAccessSetResponse](type-aliases/CanvasesAccessSetResponse.md) -- [CanvasesCreateArguments](type-aliases/CanvasesCreateArguments.md) -- [CanvasesCreateResponse](type-aliases/CanvasesCreateResponse.md) -- [CanvasesDeleteResponse](type-aliases/CanvasesDeleteResponse.md) -- [CanvasesEditResponse](type-aliases/CanvasesEditResponse.md) -- [CanvasesSectionsLookupResponse](type-aliases/CanvasesSectionsLookupResponse.md) -- [ChannelsArchiveResponse](type-aliases/ChannelsArchiveResponse.md) -- [ChannelsCreateResponse](type-aliases/ChannelsCreateResponse.md) -- [ChannelsHistoryResponse](type-aliases/ChannelsHistoryResponse.md) -- [ChannelsInfoResponse](type-aliases/ChannelsInfoResponse.md) -- [ChannelsInviteResponse](type-aliases/ChannelsInviteResponse.md) -- [ChannelsJoinResponse](type-aliases/ChannelsJoinResponse.md) -- [ChannelsKickResponse](type-aliases/ChannelsKickResponse.md) -- [ChannelsLeaveResponse](type-aliases/ChannelsLeaveResponse.md) -- [ChannelsListResponse](type-aliases/ChannelsListResponse.md) -- [ChannelsMarkResponse](type-aliases/ChannelsMarkResponse.md) -- [ChannelsRenameResponse](type-aliases/ChannelsRenameResponse.md) -- [ChannelsRepliesResponse](type-aliases/ChannelsRepliesResponse.md) -- [ChannelsSetPurposeResponse](type-aliases/ChannelsSetPurposeResponse.md) -- [ChannelsSetTopicResponse](type-aliases/ChannelsSetTopicResponse.md) -- [ChannelsUnarchiveResponse](type-aliases/ChannelsUnarchiveResponse.md) -- [ChatDeleteResponse](type-aliases/ChatDeleteResponse.md) -- [ChatDeleteScheduledMessageResponse](type-aliases/ChatDeleteScheduledMessageResponse.md) -- [ChatGetPermalinkResponse](type-aliases/ChatGetPermalinkResponse.md) -- [ChatMeMessageResponse](type-aliases/ChatMeMessageResponse.md) -- [ChatPostEphemeralArguments](type-aliases/ChatPostEphemeralArguments.md) -- [ChatPostEphemeralResponse](type-aliases/ChatPostEphemeralResponse.md) -- [ChatPostMessageArguments](type-aliases/ChatPostMessageArguments.md) -- [ChatPostMessageResponse](type-aliases/ChatPostMessageResponse.md) -- [ChatScheduleMessageArguments](type-aliases/ChatScheduleMessageArguments.md) -- [ChatScheduleMessageResponse](type-aliases/ChatScheduleMessageResponse.md) -- [ChatScheduledMessagesListArguments](type-aliases/ChatScheduledMessagesListArguments.md) -- [ChatScheduledMessagesListResponse](type-aliases/ChatScheduledMessagesListResponse.md) -- [ChatUnfurlArguments](type-aliases/ChatUnfurlArguments.md) -- [ChatUnfurlResponse](type-aliases/ChatUnfurlResponse.md) -- [ChatUpdateArguments](type-aliases/ChatUpdateArguments.md) -- [ChatUpdateResponse](type-aliases/ChatUpdateResponse.md) -- [ConversationFilter](type-aliases/ConversationFilter.md) -- [ConversationsAcceptSharedInviteArguments](type-aliases/ConversationsAcceptSharedInviteArguments.md) -- [ConversationsAcceptSharedInviteResponse](type-aliases/ConversationsAcceptSharedInviteResponse.md) -- [ConversationsApproveSharedInviteResponse](type-aliases/ConversationsApproveSharedInviteResponse.md) -- [ConversationsArchiveResponse](type-aliases/ConversationsArchiveResponse.md) -- [ConversationsCanvasesCreateResponse](type-aliases/ConversationsCanvasesCreateResponse.md) -- [ConversationsCloseResponse](type-aliases/ConversationsCloseResponse.md) -- [ConversationsCreateResponse](type-aliases/ConversationsCreateResponse.md) -- [ConversationsDeclineSharedInviteResponse](type-aliases/ConversationsDeclineSharedInviteResponse.md) -- [ConversationsExternalInvitePermissionsSetResponse](type-aliases/ConversationsExternalInvitePermissionsSetResponse.md) -- [ConversationsHistoryResponse](type-aliases/ConversationsHistoryResponse.md) -- [ConversationsInfoResponse](type-aliases/ConversationsInfoResponse.md) -- [ConversationsInviteResponse](type-aliases/ConversationsInviteResponse.md) -- [ConversationsInviteSharedArguments](type-aliases/ConversationsInviteSharedArguments.md) -- [ConversationsInviteSharedResponse](type-aliases/ConversationsInviteSharedResponse.md) -- [ConversationsJoinResponse](type-aliases/ConversationsJoinResponse.md) -- [ConversationsKickResponse](type-aliases/ConversationsKickResponse.md) -- [ConversationsLeaveResponse](type-aliases/ConversationsLeaveResponse.md) -- [ConversationsListArguments](type-aliases/ConversationsListArguments.md) -- [ConversationsListConnectInvitesArguments](type-aliases/ConversationsListConnectInvitesArguments.md) -- [ConversationsListConnectInvitesResponse](type-aliases/ConversationsListConnectInvitesResponse.md) -- [ConversationsListResponse](type-aliases/ConversationsListResponse.md) -- [ConversationsMarkResponse](type-aliases/ConversationsMarkResponse.md) -- [ConversationsMembersResponse](type-aliases/ConversationsMembersResponse.md) -- [ConversationsOpenArguments](type-aliases/ConversationsOpenArguments.md) -- [ConversationsOpenResponse](type-aliases/ConversationsOpenResponse.md) -- [ConversationsRenameResponse](type-aliases/ConversationsRenameResponse.md) -- [ConversationsRepliesResponse](type-aliases/ConversationsRepliesResponse.md) -- [ConversationsSetPurposeResponse](type-aliases/ConversationsSetPurposeResponse.md) -- [ConversationsSetTopicResponse](type-aliases/ConversationsSetTopicResponse.md) -- [ConversationsUnarchiveResponse](type-aliases/ConversationsUnarchiveResponse.md) -- [DialogOpenResponse](type-aliases/DialogOpenResponse.md) -- [DndEndDndArguments](type-aliases/DndEndDndArguments.md) -- [DndEndDndResponse](type-aliases/DndEndDndResponse.md) -- [DndEndSnoozeArguments](type-aliases/DndEndSnoozeArguments.md) -- [DndEndSnoozeResponse](type-aliases/DndEndSnoozeResponse.md) -- [DndInfoArguments](type-aliases/DndInfoArguments.md) -- [DndInfoResponse](type-aliases/DndInfoResponse.md) -- [DndSetSnoozeResponse](type-aliases/DndSetSnoozeResponse.md) -- [DndTeamInfoResponse](type-aliases/DndTeamInfoResponse.md) -- [EmojiListArguments](type-aliases/EmojiListArguments.md) -- [EmojiListResponse](type-aliases/EmojiListResponse.md) -- [FilesCommentsAddResponse](type-aliases/FilesCommentsAddResponse.md) -- [FilesCommentsDeleteResponse](type-aliases/FilesCommentsDeleteResponse.md) -- [FilesCommentsEditResponse](type-aliases/FilesCommentsEditResponse.md) -- [FilesCompleteUploadExternalArguments](type-aliases/FilesCompleteUploadExternalArguments.md) -- [FilesCompleteUploadExternalResponse](type-aliases/FilesCompleteUploadExternalResponse.md) -- [FilesDeleteResponse](type-aliases/FilesDeleteResponse.md) -- [FilesGetUploadURLExternalResponse](type-aliases/FilesGetUploadURLExternalResponse.md) -- [FilesInfoResponse](type-aliases/FilesInfoResponse.md) -- [FilesListResponse](type-aliases/FilesListResponse.md) -- [FilesRemoteAddResponse](type-aliases/FilesRemoteAddResponse.md) -- [FilesRemoteInfoArguments](type-aliases/FilesRemoteInfoArguments.md) -- [FilesRemoteInfoResponse](type-aliases/FilesRemoteInfoResponse.md) -- [FilesRemoteListResponse](type-aliases/FilesRemoteListResponse.md) -- [FilesRemoteRemoveArguments](type-aliases/FilesRemoteRemoveArguments.md) -- [FilesRemoteRemoveResponse](type-aliases/FilesRemoteRemoveResponse.md) -- [FilesRemoteShareArguments](type-aliases/FilesRemoteShareArguments.md) -- [FilesRemoteShareResponse](type-aliases/FilesRemoteShareResponse.md) -- [FilesRemoteUpdateArguments](type-aliases/FilesRemoteUpdateArguments.md) -- [FilesRemoteUpdateResponse](type-aliases/FilesRemoteUpdateResponse.md) -- [FilesRevokePublicURLResponse](type-aliases/FilesRevokePublicURLResponse.md) -- [FilesSharedPublicURLResponse](type-aliases/FilesSharedPublicURLResponse.md) -- [FilesUploadArguments](type-aliases/FilesUploadArguments.md) -- [FilesUploadResponse](type-aliases/FilesUploadResponse.md) -- [FilesUploadV2Arguments](type-aliases/FilesUploadV2Arguments.md) -- [FunctionsCompleteErrorResponse](type-aliases/FunctionsCompleteErrorResponse.md) -- [FunctionsCompleteSuccessResponse](type-aliases/FunctionsCompleteSuccessResponse.md) -- [GroupsArchiveResponse](type-aliases/GroupsArchiveResponse.md) -- [GroupsCloseResponse](type-aliases/GroupsCloseResponse.md) -- [GroupsCreateChildResponse](type-aliases/GroupsCreateChildResponse.md) -- [GroupsCreateResponse](type-aliases/GroupsCreateResponse.md) -- [GroupsHistoryResponse](type-aliases/GroupsHistoryResponse.md) -- [GroupsInfoResponse](type-aliases/GroupsInfoResponse.md) -- [GroupsInviteResponse](type-aliases/GroupsInviteResponse.md) -- [GroupsKickResponse](type-aliases/GroupsKickResponse.md) -- [GroupsLeaveResponse](type-aliases/GroupsLeaveResponse.md) -- [GroupsListResponse](type-aliases/GroupsListResponse.md) -- [GroupsMarkResponse](type-aliases/GroupsMarkResponse.md) -- [GroupsOpenResponse](type-aliases/GroupsOpenResponse.md) -- [GroupsRenameResponse](type-aliases/GroupsRenameResponse.md) -- [GroupsRepliesResponse](type-aliases/GroupsRepliesResponse.md) -- [GroupsSetPurposeResponse](type-aliases/GroupsSetPurposeResponse.md) -- [GroupsSetTopicResponse](type-aliases/GroupsSetTopicResponse.md) -- [GroupsUnarchiveResponse](type-aliases/GroupsUnarchiveResponse.md) -- [ImCloseResponse](type-aliases/ImCloseResponse.md) -- [ImHistoryResponse](type-aliases/ImHistoryResponse.md) -- [ImListResponse](type-aliases/ImListResponse.md) -- [ImMarkResponse](type-aliases/ImMarkResponse.md) -- [ImOpenResponse](type-aliases/ImOpenResponse.md) -- [ImRepliesResponse](type-aliases/ImRepliesResponse.md) -- [ImageBlock](type-aliases/ImageBlock.md) -- [ImageElement](type-aliases/ImageElement.md) -- [KnownBlock](type-aliases/KnownBlock.md) -- [MigrationExchangeResponse](type-aliases/MigrationExchangeResponse.md) -- [MpimCloseResponse](type-aliases/MpimCloseResponse.md) -- [MpimHistoryResponse](type-aliases/MpimHistoryResponse.md) -- [MpimListResponse](type-aliases/MpimListResponse.md) -- [MpimMarkResponse](type-aliases/MpimMarkResponse.md) -- [MpimOpenResponse](type-aliases/MpimOpenResponse.md) -- [MpimRepliesResponse](type-aliases/MpimRepliesResponse.md) -- [MultiSelect](type-aliases/MultiSelect.md) -- [OauthAccessResponse](type-aliases/OauthAccessResponse.md) -- [OauthTokenResponse](type-aliases/OauthTokenResponse.md) -- [OauthV2AccessResponse](type-aliases/OauthV2AccessResponse.md) -- [OauthV2ExchangeResponse](type-aliases/OauthV2ExchangeResponse.md) -- [OpenIDConnectTokenResponse](type-aliases/OpenIDConnectTokenResponse.md) -- [OpenIDConnectUserInfoArguments](type-aliases/OpenIDConnectUserInfoArguments.md) -- [OpenIDConnectUserInfoResponse](type-aliases/OpenIDConnectUserInfoResponse.md) -- [Option](type-aliases/Option.md) -- [PageAccumulator](type-aliases/PageAccumulator.md) -- [PinsAddResponse](type-aliases/PinsAddResponse.md) -- [PinsListResponse](type-aliases/PinsListResponse.md) -- [PinsRemoveResponse](type-aliases/PinsRemoveResponse.md) -- [RTMConnectArguments](type-aliases/RTMConnectArguments.md) -- [RTMStartArguments](type-aliases/RTMStartArguments.md) -- [ReactionsAddResponse](type-aliases/ReactionsAddResponse.md) -- [ReactionsGetArguments](type-aliases/ReactionsGetArguments.md) -- [ReactionsGetResponse](type-aliases/ReactionsGetResponse.md) -- [ReactionsListArguments](type-aliases/ReactionsListArguments.md) -- [ReactionsListResponse](type-aliases/ReactionsListResponse.md) -- [ReactionsRemoveArguments](type-aliases/ReactionsRemoveArguments.md) -- [ReactionsRemoveResponse](type-aliases/ReactionsRemoveResponse.md) -- [RemindersAddResponse](type-aliases/RemindersAddResponse.md) -- [RemindersCompleteResponse](type-aliases/RemindersCompleteResponse.md) -- [RemindersDeleteResponse](type-aliases/RemindersDeleteResponse.md) -- [RemindersInfoResponse](type-aliases/RemindersInfoResponse.md) -- [RemindersListArguments](type-aliases/RemindersListArguments.md) -- [RemindersListResponse](type-aliases/RemindersListResponse.md) -- [RichTextElement](type-aliases/RichTextElement.md) -- [RtmConnectResponse](type-aliases/RtmConnectResponse.md) -- [RtmStartResponse](type-aliases/RtmStartResponse.md) -- [SearchAllResponse](type-aliases/SearchAllResponse.md) -- [SearchFilesResponse](type-aliases/SearchFilesResponse.md) -- [SearchMessagesResponse](type-aliases/SearchMessagesResponse.md) -- [Select](type-aliases/Select.md) -- [SlackFile](type-aliases/SlackFile.md) -- [StarsAddRemoveArguments](type-aliases/StarsAddRemoveArguments.md) -- [StarsAddResponse](type-aliases/StarsAddResponse.md) -- [StarsListResponse](type-aliases/StarsListResponse.md) -- [StarsRemoveResponse](type-aliases/StarsRemoveResponse.md) -- [TLSOptions](type-aliases/TLSOptions.md) -- [TeamAccessLogsArguments](type-aliases/TeamAccessLogsArguments.md) -- [TeamAccessLogsResponse](type-aliases/TeamAccessLogsResponse.md) -- [TeamBillableInfoArguments](type-aliases/TeamBillableInfoArguments.md) -- [TeamBillableInfoResponse](type-aliases/TeamBillableInfoResponse.md) -- [TeamBillingInfoArguments](type-aliases/TeamBillingInfoArguments.md) -- [TeamBillingInfoResponse](type-aliases/TeamBillingInfoResponse.md) -- [TeamExternalTeamsDisconnectArguments](type-aliases/TeamExternalTeamsDisconnectArguments.md) -- [TeamExternalTeamsDisconnectResponse](type-aliases/TeamExternalTeamsDisconnectResponse.md) -- [TeamExternalTeamsListArguments](type-aliases/TeamExternalTeamsListArguments.md) -- [TeamExternalTeamsListResponse](type-aliases/TeamExternalTeamsListResponse.md) -- [TeamInfoArguments](type-aliases/TeamInfoArguments.md) -- [TeamInfoResponse](type-aliases/TeamInfoResponse.md) -- [TeamIntegrationLogsArguments](type-aliases/TeamIntegrationLogsArguments.md) -- [TeamIntegrationLogsResponse](type-aliases/TeamIntegrationLogsResponse.md) -- [TeamPreferencesListArguments](type-aliases/TeamPreferencesListArguments.md) -- [TeamPreferencesListResponse](type-aliases/TeamPreferencesListResponse.md) -- [TeamProfileGetArguments](type-aliases/TeamProfileGetArguments.md) -- [TeamProfileGetResponse](type-aliases/TeamProfileGetResponse.md) -- [ToolingTokensRotateResponse](type-aliases/ToolingTokensRotateResponse.md) -- [UsergroupsCreateResponse](type-aliases/UsergroupsCreateResponse.md) -- [UsergroupsDisableResponse](type-aliases/UsergroupsDisableResponse.md) -- [UsergroupsEnableResponse](type-aliases/UsergroupsEnableResponse.md) -- [UsergroupsListArguments](type-aliases/UsergroupsListArguments.md) -- [UsergroupsListResponse](type-aliases/UsergroupsListResponse.md) -- [UsergroupsUpdateResponse](type-aliases/UsergroupsUpdateResponse.md) -- [UsergroupsUsersListResponse](type-aliases/UsergroupsUsersListResponse.md) -- [UsergroupsUsersUpdateResponse](type-aliases/UsergroupsUsersUpdateResponse.md) -- [UsersConversationsResponse](type-aliases/UsersConversationsResponse.md) -- [UsersDeletePhotoResponse](type-aliases/UsersDeletePhotoResponse.md) -- [UsersDiscoverableContactsLookupResponse](type-aliases/UsersDiscoverableContactsLookupResponse.md) -- [UsersGetPresenceResponse](type-aliases/UsersGetPresenceResponse.md) -- [UsersIdentityResponse](type-aliases/UsersIdentityResponse.md) -- [UsersInfoResponse](type-aliases/UsersInfoResponse.md) -- [UsersListResponse](type-aliases/UsersListResponse.md) -- [UsersLookupByEmailResponse](type-aliases/UsersLookupByEmailResponse.md) -- [UsersProfileGetResponse](type-aliases/UsersProfileGetResponse.md) -- [UsersProfileSetResponse](type-aliases/UsersProfileSetResponse.md) -- [UsersSetActiveResponse](type-aliases/UsersSetActiveResponse.md) -- [UsersSetPhotoResponse](type-aliases/UsersSetPhotoResponse.md) -- [UsersSetPresenceResponse](type-aliases/UsersSetPresenceResponse.md) -- [View](type-aliases/View.md) -- [ViewsOpenArguments](type-aliases/ViewsOpenArguments.md) -- [ViewsOpenResponse](type-aliases/ViewsOpenResponse.md) -- [ViewsPublishResponse](type-aliases/ViewsPublishResponse.md) -- [ViewsPushArguments](type-aliases/ViewsPushArguments.md) -- [ViewsPushResponse](type-aliases/ViewsPushResponse.md) -- [ViewsUpdateArguments](type-aliases/ViewsUpdateArguments.md) -- [ViewsUpdateResponse](type-aliases/ViewsUpdateResponse.md) -- [WebAPICallError](type-aliases/WebAPICallError.md) -- [WorkflowsStepCompletedResponse](type-aliases/WorkflowsStepCompletedResponse.md) -- [WorkflowsStepFailedResponse](type-aliases/WorkflowsStepFailedResponse.md) -- [WorkflowsUpdateStepResponse](type-aliases/WorkflowsUpdateStepResponse.md) - -## Variables - -- [retryPolicies](variables/retryPolicies.md) - -## Functions - -- [addAppMetadata](functions/addAppMetadata.md) diff --git a/docs/content/reference/web-api/interfaces/Action.md b/docs/content/reference/web-api/interfaces/Action.md deleted file mode 100644 index 5623edc50..000000000 --- a/docs/content/reference/web-api/interfaces/Action.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: ~~Action~~ - -## Deprecated - -[Action](Action.md) aliased to [Actionable](Actionable.md) in order to name the mixins in this file consistently. - -## Extended by - -- [`Actionable`](Actionable.md) - -## Properties - -### ~~action\_id?~~ - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### ~~type~~ - -```ts -type: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:6 diff --git a/docs/content/reference/web-api/interfaces/Actionable.md b/docs/content/reference/web-api/interfaces/Actionable.md deleted file mode 100644 index 0b57e4a67..000000000 --- a/docs/content/reference/web-api/interfaces/Actionable.md +++ /dev/null @@ -1,71 +0,0 @@ -# Interface: ~~Actionable~~ - -## Deprecated - -[Action](Action.md) aliased to [Actionable](Actionable.md) in order to name the mixins in this file consistently. - -## Extends - -- [`Action`](Action.md) - -## Extended by - -- [`Button`](Button.md) -- [`Checkboxes`](Checkboxes.md) -- [`Datepicker`](Datepicker.md) -- [`DateTimepicker`](DateTimepicker.md) -- [`EmailInput`](EmailInput.md) -- [`FileInput`](FileInput.md) -- [`UsersSelect`](UsersSelect.md) -- [`MultiUsersSelect`](MultiUsersSelect.md) -- [`StaticSelect`](StaticSelect.md) -- [`MultiStaticSelect`](MultiStaticSelect.md) -- [`ConversationsSelect`](ConversationsSelect.md) -- [`MultiConversationsSelect`](MultiConversationsSelect.md) -- [`ChannelsSelect`](ChannelsSelect.md) -- [`MultiChannelsSelect`](MultiChannelsSelect.md) -- [`ExternalSelect`](ExternalSelect.md) -- [`MultiExternalSelect`](MultiExternalSelect.md) -- [`NumberInput`](NumberInput.md) -- [`Overflow`](Overflow.md) -- [`PlainTextInput`](PlainTextInput.md) -- [`RadioButtons`](RadioButtons.md) -- [`Timepicker`](Timepicker.md) -- [`URLInput`](URLInput.md) -- [`RichTextInput`](RichTextInput.md) - -## Properties - -### ~~action\_id?~~ - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Action`](Action.md).[`action_id`](Action.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### ~~type~~ - -```ts -type: string; -``` - -#### Inherited from - -[`Action`](Action.md).[`type`](Action.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:6 diff --git a/docs/content/reference/web-api/interfaces/ActionsBlock.md b/docs/content/reference/web-api/interfaces/ActionsBlock.md deleted file mode 100644 index dc9cb622b..000000000 --- a/docs/content/reference/web-api/interfaces/ActionsBlock.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: ActionsBlock - -## Description - -Holds multiple interactive elements. - -## See - -[Actions block reference](https://api.slack.com/reference/block-kit/blocks#actions). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 - -*** - -### elements - -```ts -elements: ( - | Button - | Checkboxes - | Datepicker - | DateTimepicker - | MultiSelect - | Overflow - | RadioButtons - | Select - | Timepicker - | WorkflowButton - | RichTextInput)[]; -``` - -#### Description - -An array of InteractiveElements objects. -There is a maximum of 25 elements in each action block. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:29 - -*** - -### type - -```ts -type: "actions"; -``` - -#### Description - -The type of block. For an actions block, `type` is always `actions`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:24 diff --git a/docs/content/reference/web-api/interfaces/AdminAnalyticsMemberDetails.md b/docs/content/reference/web-api/interfaces/AdminAnalyticsMemberDetails.md deleted file mode 100644 index 8e5881fa0..000000000 --- a/docs/content/reference/web-api/interfaces/AdminAnalyticsMemberDetails.md +++ /dev/null @@ -1,277 +0,0 @@ -# Interface: AdminAnalyticsMemberDetails - -## Properties - -### channel\_messages\_posted\_count - -```ts -channel_messages_posted_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L31) - -*** - -### date - -```ts -date: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L20) - -*** - -### date\_claimed - -```ts -date_claimed: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L40) - -*** - -### email\_address - -```ts -email_address: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L22) - -*** - -### enterprise\_id - -```ts -enterprise_id: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L18) - -*** - -### files\_added\_count - -```ts -files_added_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L32) - -*** - -### is\_active - -```ts -is_active: boolean; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L25) - -*** - -### is\_active\_android - -```ts -is_active_android: boolean; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L27) - -*** - -### is\_active\_apps - -```ts -is_active_apps: boolean; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L33) - -*** - -### is\_active\_desktop - -```ts -is_active_desktop: boolean; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L28) - -*** - -### is\_active\_ios - -```ts -is_active_ios: boolean; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L26) - -*** - -### is\_active\_slack\_connect - -```ts -is_active_slack_connect: boolean; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L35) - -*** - -### is\_active\_workflows - -```ts -is_active_workflows: boolean; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L34) - -*** - -### is\_billable\_seat - -```ts -is_billable_seat: boolean; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L24) - -*** - -### is\_guest - -```ts -is_guest: boolean; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L23) - -*** - -### messages\_posted\_count - -```ts -messages_posted_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L30) - -*** - -### reactions\_added\_count - -```ts -reactions_added_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L29) - -*** - -### search\_count - -```ts -search_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L39) - -*** - -### slack\_calls\_count - -```ts -slack_calls_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L37) - -*** - -### slack\_huddles\_count - -```ts -slack_huddles_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L38) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L19) - -*** - -### total\_calls\_count - -```ts -total_calls_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L36) - -*** - -### user\_id - -```ts -user_id: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L21) diff --git a/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelDetails.md b/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelDetails.md deleted file mode 100644 index 228187212..000000000 --- a/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelDetails.md +++ /dev/null @@ -1,229 +0,0 @@ -# Interface: AdminAnalyticsPublicChannelDetails - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:46](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L46) - -*** - -### channel\_type - -```ts -channel_type: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L58) - -*** - -### date - -```ts -date: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:62](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L62) - -*** - -### date\_created - -```ts -date_created: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L47) - -*** - -### date\_last\_active - -```ts -date_last_active: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L48) - -*** - -### enterprise\_id - -```ts -enterprise_id: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L44) - -*** - -### externally\_shared\_with\_organizations - -```ts -externally_shared_with_organizations: AdminAnalyticsExternallySharedWithOrganizationsDetails[]; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L61) - -*** - -### full\_members\_count - -```ts -full_members_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L50) - -*** - -### guest\_member\_count - -```ts -guest_member_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L51) - -*** - -### is\_shared\_externally - -```ts -is_shared_externally: boolean; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:59](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L59) - -*** - -### members\_who\_posted\_count - -```ts -members_who_posted_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L55) - -*** - -### members\_who\_viewed\_count - -```ts -members_who_viewed_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:54](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L54) - -*** - -### messages\_posted\_by\_members\_count - -```ts -messages_posted_by_members_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:53](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L53) - -*** - -### messages\_posted\_count - -```ts -messages_posted_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L52) - -*** - -### originating\_team - -```ts -originating_team: AdminAnalyticsOriginatingTeamDetails; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L45) - -*** - -### reactions\_added\_count - -```ts -reactions_added_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:56](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L56) - -*** - -### shared\_with - -```ts -shared_with: AdminAnalyticsSharedWithDetails[]; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:60](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L60) - -*** - -### total\_members\_count - -```ts -total_members_count: number; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L49) - -*** - -### visibility - -```ts -visibility: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L57) diff --git a/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelMetadataDetails.md b/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelMetadataDetails.md deleted file mode 100644 index 6e4bbbdf4..000000000 --- a/docs/content/reference/web-api/interfaces/AdminAnalyticsPublicChannelMetadataDetails.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminAnalyticsPublicChannelMetadataDetails - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:66](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L66) - -*** - -### date - -```ts -date: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:70](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L70) - -*** - -### description - -```ts -description: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L69) - -*** - -### name - -```ts -name: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L67) - -*** - -### topic - -```ts -topic: string; -``` - -#### Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:68](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L68) diff --git a/docs/content/reference/web-api/interfaces/AdminAppsConfigLookupArguments.md b/docs/content/reference/web-api/interfaces/AdminAppsConfigLookupArguments.md deleted file mode 100644 index abec522a3..000000000 --- a/docs/content/reference/web-api/interfaces/AdminAppsConfigLookupArguments.md +++ /dev/null @@ -1,41 +0,0 @@ -# Interface: AdminAppsConfigLookupArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### app\_ids - -```ts -app_ids: string[]; -``` - -#### Description - -An array of app IDs to get app configs for. - -#### Defined in - -[packages/web-api/src/types/request/admin/apps.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L67) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminAppsConfigSetArguments.md b/docs/content/reference/web-api/interfaces/AdminAppsConfigSetArguments.md deleted file mode 100644 index a41fa5aab..000000000 --- a/docs/content/reference/web-api/interfaces/AdminAppsConfigSetArguments.md +++ /dev/null @@ -1,97 +0,0 @@ -# Interface: AdminAppsConfigSetArguments - -## Extends - -- `AppID`.`TokenOverridable` - -## Properties - -### app\_id - -```ts -app_id: string; -``` - -#### Description - -The ID of the app. - -#### Inherited from - -`AppID.app_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L88) - -*** - -### domain\_restrictions? - -```ts -optional domain_restrictions: object; -``` - -#### emails? - -```ts -optional emails: string[]; -``` - -##### Description - -Sets emails for connector authorization. - -#### urls? - -```ts -optional urls: string[]; -``` - -##### Description - -Sets allowed URLs for the app. - -#### Description - -Domain restrictions for the app. - -#### Defined in - -[packages/web-api/src/types/request/admin/apps.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L73) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### workflow\_auth\_strategy? - -```ts -optional workflow_auth_strategy: "builder_choice" | "end_user_only"; -``` - -#### Description - -The workflow auth permission. - -#### Defined in - -[packages/web-api/src/types/request/admin/apps.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L80) diff --git a/docs/content/reference/web-api/interfaces/AdminAuthPolicyAssignEntitiesArguments.md b/docs/content/reference/web-api/interfaces/AdminAuthPolicyAssignEntitiesArguments.md deleted file mode 100644 index f0d0cc845..000000000 --- a/docs/content/reference/web-api/interfaces/AdminAuthPolicyAssignEntitiesArguments.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: AdminAuthPolicyAssignEntitiesArguments - -## Extends - -- `EntityIDs`.`EntityType`.`PolicyName`.`TokenOverridable` - -## Properties - -### entity\_ids - -```ts -entity_ids: string[]; -``` - -#### Description - -Encoded IDs of the entities interacting with. - -#### Inherited from - -`EntityIDs.entity_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/auth.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L5) - -*** - -### entity\_type - -```ts -entity_type: "USER"; -``` - -#### Description - -The type of entity interacting with the policy. - -#### Inherited from - -`EntityType.entity_type` - -#### Defined in - -[packages/web-api/src/types/request/admin/auth.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L9) - -*** - -### policy\_name - -```ts -policy_name: "email_password"; -``` - -#### Description - -The name of the policy. - -#### Inherited from - -`PolicyName.policy_name` - -#### Defined in - -[packages/web-api/src/types/request/admin/auth.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminAuthPolicyGetEntitiesArguments.md b/docs/content/reference/web-api/interfaces/AdminAuthPolicyGetEntitiesArguments.md deleted file mode 100644 index f8f0839d2..000000000 --- a/docs/content/reference/web-api/interfaces/AdminAuthPolicyGetEntitiesArguments.md +++ /dev/null @@ -1,112 +0,0 @@ -# Interface: AdminAuthPolicyGetEntitiesArguments - -## Extends - -- `Partial`\<`EntityType`\>.`PolicyName`.`TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### entity\_type? - -```ts -optional entity_type: "USER"; -``` - -#### Description - -The type of entity interacting with the policy. - -#### Inherited from - -`Partial.entity_type` - -#### Defined in - -[packages/web-api/src/types/request/admin/auth.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L9) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### policy\_name - -```ts -policy_name: "email_password"; -``` - -#### Description - -The name of the policy. - -#### Inherited from - -`PolicyName.policy_name` - -#### Defined in - -[packages/web-api/src/types/request/admin/auth.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminAuthPolicyRemoveEntitiesArguments.md b/docs/content/reference/web-api/interfaces/AdminAuthPolicyRemoveEntitiesArguments.md deleted file mode 100644 index f31b7893e..000000000 --- a/docs/content/reference/web-api/interfaces/AdminAuthPolicyRemoveEntitiesArguments.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: AdminAuthPolicyRemoveEntitiesArguments - -## Extends - -- `EntityIDs`.`EntityType`.`PolicyName`.`TokenOverridable` - -## Properties - -### entity\_ids - -```ts -entity_ids: string[]; -``` - -#### Description - -Encoded IDs of the entities interacting with. - -#### Inherited from - -`EntityIDs.entity_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/auth.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L5) - -*** - -### entity\_type - -```ts -entity_type: "USER"; -``` - -#### Description - -The type of entity interacting with the policy. - -#### Inherited from - -`EntityType.entity_type` - -#### Defined in - -[packages/web-api/src/types/request/admin/auth.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L9) - -*** - -### policy\_name - -```ts -policy_name: "email_password"; -``` - -#### Description - -The name of the policy. - -#### Inherited from - -`PolicyName.policy_name` - -#### Defined in - -[packages/web-api/src/types/request/admin/auth.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/auth.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminBarriersCreateArguments.md b/docs/content/reference/web-api/interfaces/AdminBarriersCreateArguments.md deleted file mode 100644 index 7679d444d..000000000 --- a/docs/content/reference/web-api/interfaces/AdminBarriersCreateArguments.md +++ /dev/null @@ -1,78 +0,0 @@ -# Interface: AdminBarriersCreateArguments - -## Extends - -- `TokenOverridable` - -## Extended by - -- [`AdminBarriersUpdateArguments`](AdminBarriersUpdateArguments.md) - -## Properties - -### barriered\_from\_usergroup\_ids - -```ts -barriered_from_usergroup_ids: string[]; -``` - -#### Description - -A list of [IDP Groups](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) IDs ti associate with the barrier. - -#### Defined in - -[packages/web-api/src/types/request/admin/barriers.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L13) - -*** - -### primary\_usergroup\_id - -```ts -primary_usergroup_id: string; -``` - -#### Description - -The ID of the primary [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org). - -#### Defined in - -[packages/web-api/src/types/request/admin/barriers.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L15) - -*** - -### restricted\_subjects - -```ts -restricted_subjects: ["im", "mpim", "call"]; -``` - -#### Description - -What kind of interactions are blocked by this barrier? -Currently you must provide all three: `im`, `mpim`, `call`. - -#### Defined in - -[packages/web-api/src/types/request/admin/barriers.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L20) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminBarriersDeleteArguments.md b/docs/content/reference/web-api/interfaces/AdminBarriersDeleteArguments.md deleted file mode 100644 index 2c6f1557b..000000000 --- a/docs/content/reference/web-api/interfaces/AdminBarriersDeleteArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminBarriersDeleteArguments - -## Extends - -- `BarrierID`.`TokenOverridable` - -## Properties - -### barrier\_id - -```ts -barrier_id: string; -``` - -#### Description - -The ID of the barrier. - -#### Inherited from - -`BarrierID.barrier_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/barriers.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L7) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminBarriersUpdateArguments.md b/docs/content/reference/web-api/interfaces/AdminBarriersUpdateArguments.md deleted file mode 100644 index 3e54f0521..000000000 --- a/docs/content/reference/web-api/interfaces/AdminBarriersUpdateArguments.md +++ /dev/null @@ -1,106 +0,0 @@ -# Interface: AdminBarriersUpdateArguments - -## Extends - -- [`AdminBarriersCreateArguments`](AdminBarriersCreateArguments.md).`BarrierID` - -## Properties - -### barrier\_id - -```ts -barrier_id: string; -``` - -#### Description - -The ID of the barrier. - -#### Inherited from - -`BarrierID.barrier_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/barriers.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L7) - -*** - -### barriered\_from\_usergroup\_ids - -```ts -barriered_from_usergroup_ids: string[]; -``` - -#### Description - -A list of [IDP Groups](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) IDs ti associate with the barrier. - -#### Inherited from - -[`AdminBarriersCreateArguments`](AdminBarriersCreateArguments.md).[`barriered_from_usergroup_ids`](AdminBarriersCreateArguments.md#barriered_from_usergroup_ids) - -#### Defined in - -[packages/web-api/src/types/request/admin/barriers.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L13) - -*** - -### primary\_usergroup\_id - -```ts -primary_usergroup_id: string; -``` - -#### Description - -The ID of the primary [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org). - -#### Inherited from - -[`AdminBarriersCreateArguments`](AdminBarriersCreateArguments.md).[`primary_usergroup_id`](AdminBarriersCreateArguments.md#primary_usergroup_id) - -#### Defined in - -[packages/web-api/src/types/request/admin/barriers.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L15) - -*** - -### restricted\_subjects - -```ts -restricted_subjects: ["im", "mpim", "call"]; -``` - -#### Description - -What kind of interactions are blocked by this barrier? -Currently you must provide all three: `im`, `mpim`, `call`. - -#### Inherited from - -[`AdminBarriersCreateArguments`](AdminBarriersCreateArguments.md).[`restricted_subjects`](AdminBarriersCreateArguments.md#restricted_subjects) - -#### Defined in - -[packages/web-api/src/types/request/admin/barriers.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L20) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -[`AdminBarriersCreateArguments`](AdminBarriersCreateArguments.md).[`token`](AdminBarriersCreateArguments.md#token) - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsArchiveArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsArchiveArguments.md deleted file mode 100644 index 906c3e87b..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsArchiveArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminConversationsArchiveArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsBulkArchiveArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsBulkArchiveArguments.md deleted file mode 100644 index 8ec302696..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsBulkArchiveArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminConversationsBulkArchiveArguments - -## Extends - -- `ChannelIDs`.`TokenOverridable` - -## Properties - -### channel\_ids - -```ts -channel_ids: [string, ...string[]]; -``` - -#### Description - -An array of channel IDs (must include at least one ID). - -#### Inherited from - -`ChannelIDs.channel_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsBulkDeleteArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsBulkDeleteArguments.md deleted file mode 100644 index 153321b51..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsBulkDeleteArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminConversationsBulkDeleteArguments - -## Extends - -- `ChannelIDs`.`TokenOverridable` - -## Properties - -### channel\_ids - -```ts -channel_ids: [string, ...string[]]; -``` - -#### Description - -An array of channel IDs (must include at least one ID). - -#### Inherited from - -`ChannelIDs.channel_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsBulkMoveArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsBulkMoveArguments.md deleted file mode 100644 index 412b9c42f..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsBulkMoveArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminConversationsBulkMoveArguments - -## Extends - -- `ChannelIDs`.`TokenOverridable` - -## Properties - -### channel\_ids - -```ts -channel_ids: [string, ...string[]]; -``` - -#### Description - -An array of channel IDs (must include at least one ID). - -#### Inherited from - -`ChannelIDs.channel_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) - -*** - -### target\_team\_id - -```ts -target_team_id: string; -``` - -#### Description - -Target team ID to move channels to. - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L49) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPrivateArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPrivateArguments.md deleted file mode 100644 index 15fd96796..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPrivateArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminConversationsConvertToPrivateArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### name? - -```ts -optional name: string; -``` - -#### Description - -Name of private channel to create. Only respected when converting an MPIM. - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L55) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPublicArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPublicArguments.md deleted file mode 100644 index cb1433f75..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsConvertToPublicArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminConversationsConvertToPublicArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsDeleteArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsDeleteArguments.md deleted file mode 100644 index 5b43bce23..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsDeleteArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminConversationsDeleteArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsDisconnectSharedArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsDisconnectSharedArguments.md deleted file mode 100644 index 9e8f8922f..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsDisconnectSharedArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminConversationsDisconnectSharedArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### leaving\_team\_ids? - -```ts -optional leaving_team_ids: string[]; -``` - -#### Description - -Team IDs getting removed from the channel, optional if there are only two teams in the channel. - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L96) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsGetConversationPrefsArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsGetConversationPrefsArguments.md deleted file mode 100644 index 0620a4d5e..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsGetConversationPrefsArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminConversationsGetConversationPrefsArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsGetCustomRetentionArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsGetCustomRetentionArguments.md deleted file mode 100644 index fb682bc2a..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsGetCustomRetentionArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminConversationsGetCustomRetentionArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsGetTeamsArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsGetTeamsArguments.md deleted file mode 100644 index 59cc9857f..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsGetTeamsArguments.md +++ /dev/null @@ -1,92 +0,0 @@ -# Interface: AdminConversationsGetTeamsArguments - -## Extends - -- `ChannelID`.`TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsInviteArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsInviteArguments.md deleted file mode 100644 index 8ce7fa640..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsInviteArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: AdminConversationsInviteArguments - -## Extends - -- `ChannelID`.`UserIDs`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_ids - -```ts -user_ids: [string, ...string[]]; -``` - -#### Description - -List of encoded user IDs. - -#### Inherited from - -`UserIDs.user_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsLookupArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsLookupArguments.md deleted file mode 100644 index d3f655d1c..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsLookupArguments.md +++ /dev/null @@ -1,125 +0,0 @@ -# Interface: AdminConversationsLookupArguments - -## Extends - -- `TeamIDs`.`TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### last\_message\_activity\_before - -```ts -last_message_activity_before: number; -``` - -#### Description - -UNIX timestamp to filter by public channels where the most recent message -was sent before this parameter. - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L126) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### max\_member\_count? - -```ts -optional max_member_count: number; -``` - -#### Description - -Filter by public channels with member count equal to or less than the specified number. - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:128](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L128) - -*** - -### team\_ids - -```ts -team_ids: [string, ...string[]]; -``` - -#### Description - -A list of team IDs to filter by (must include at least one ID). - -#### Inherited from - -`TeamIDs.team_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L25) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsRemoveCustomRetentionArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsRemoveCustomRetentionArguments.md deleted file mode 100644 index abce17dab..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsRemoveCustomRetentionArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminConversationsRemoveCustomRetentionArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsRenameArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsRenameArguments.md deleted file mode 100644 index 424ab788f..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsRenameArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminConversationsRenameArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### name - -```ts -name: string; -``` - -#### Description - -The new name for the channel. - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:137](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L137) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessAddGroupArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessAddGroupArguments.md deleted file mode 100644 index 76f2fc486..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessAddGroupArguments.md +++ /dev/null @@ -1,86 +0,0 @@ -# Interface: AdminConversationsRestrictAccessAddGroupArguments - -## Extends - -- `ChannelID`.`GroupID`.`RestrictAccessTeamID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### group\_id - -```ts -group_id: string; -``` - -#### Description - -The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID. - -#### Inherited from - -`GroupID.group_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L20) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -The workspace where the channel exists. This argument is required for channels only tied to -one workspace, and optional for channels that are shared across an organization. - -#### Inherited from - -`RestrictAccessTeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L34) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessListGroupsArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessListGroupsArguments.md deleted file mode 100644 index 9d447847b..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessListGroupsArguments.md +++ /dev/null @@ -1,66 +0,0 @@ -# Interface: AdminConversationsRestrictAccessListGroupsArguments - -## Extends - -- `ChannelID`.`RestrictAccessTeamID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -The workspace where the channel exists. This argument is required for channels only tied to -one workspace, and optional for channels that are shared across an organization. - -#### Inherited from - -`RestrictAccessTeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L34) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessRemoveGroupArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessRemoveGroupArguments.md deleted file mode 100644 index 226ebd12a..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsRestrictAccessRemoveGroupArguments.md +++ /dev/null @@ -1,86 +0,0 @@ -# Interface: AdminConversationsRestrictAccessRemoveGroupArguments - -## Extends - -- `ChannelID`.`GroupID`.`RestrictAccessTeamID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### group\_id - -```ts -group_id: string; -``` - -#### Description - -The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID. - -#### Inherited from - -`GroupID.group_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L20) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -The workspace where the channel exists. This argument is required for channels only tied to -one workspace, and optional for channels that are shared across an organization. - -#### Inherited from - -`RestrictAccessTeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L34) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsSetConversationPrefsArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsSetConversationPrefsArguments.md deleted file mode 100644 index 0442f6ee6..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsSetConversationPrefsArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminConversationsSetConversationPrefsArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### prefs - -```ts -prefs: Record; -``` - -#### Description - -The prefs for this channel. - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:185](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L185) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsSetCustomRetentionArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsSetCustomRetentionArguments.md deleted file mode 100644 index 55e8c2061..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsSetCustomRetentionArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminConversationsSetCustomRetentionArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### duration\_days - -```ts -duration_days: number; -``` - -#### Description - -The message retention duration in days to set for this conversation. - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:191](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L191) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsSetTeamsArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsSetTeamsArguments.md deleted file mode 100644 index 214f6ec8d..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsSetTeamsArguments.md +++ /dev/null @@ -1,95 +0,0 @@ -# Interface: AdminConversationsSetTeamsArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### org\_channel? - -```ts -optional org_channel: boolean; -``` - -#### Description - -Set to `true` if channel has to be converted to an org channel. Defaults to `false`. - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:197](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L197) - -*** - -### target\_team\_ids? - -```ts -optional target_team_ids: string[]; -``` - -#### Description - -A list of workspaces to which the channel should be shared. -Not required if the channel is being shared org-wide. - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:202](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L202) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -The workspace to which the channel belongs. -Omit this argument if the channel is a cross-workspace shared channel. - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:207](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L207) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminConversationsUnarchiveArguments.md b/docs/content/reference/web-api/interfaces/AdminConversationsUnarchiveArguments.md deleted file mode 100644 index fe41d476e..000000000 --- a/docs/content/reference/web-api/interfaces/AdminConversationsUnarchiveArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminConversationsUnarchiveArguments - -## Extends - -- `ChannelID`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Encoded channel ID. - -#### Inherited from - -`ChannelID.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminEmojiAddAliasArguments.md b/docs/content/reference/web-api/interfaces/AdminEmojiAddAliasArguments.md deleted file mode 100644 index 0e31d6c0b..000000000 --- a/docs/content/reference/web-api/interfaces/AdminEmojiAddAliasArguments.md +++ /dev/null @@ -1,63 +0,0 @@ -# Interface: AdminEmojiAddAliasArguments - -## Extends - -- `Name`.`TokenOverridable` - -## Properties - -### alias\_for - -```ts -alias_for: string; -``` - -#### Description - -Name of the emoji for which the alias is being made. -Any wrapping whitespace or colons will be automatically trimmed. - -#### Defined in - -[packages/web-api/src/types/request/admin/emoji.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L28) - -*** - -### name - -```ts -name: string; -``` - -#### Description - -The name of the emoji. Colons (:myemoji:) around the value are not required, -although they may be included. - -#### Inherited from - -`Name.name` - -#### Defined in - -[packages/web-api/src/types/request/admin/emoji.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L10) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminEmojiAddArguments.md b/docs/content/reference/web-api/interfaces/AdminEmojiAddArguments.md deleted file mode 100644 index b70a4b1f1..000000000 --- a/docs/content/reference/web-api/interfaces/AdminEmojiAddArguments.md +++ /dev/null @@ -1,63 +0,0 @@ -# Interface: AdminEmojiAddArguments - -## Extends - -- `Name`.`TokenOverridable` - -## Properties - -### name - -```ts -name: string; -``` - -#### Description - -The name of the emoji. Colons (:myemoji:) around the value are not required, -although they may be included. - -#### Inherited from - -`Name.name` - -#### Defined in - -[packages/web-api/src/types/request/admin/emoji.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L10) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### url - -```ts -url: string; -``` - -#### Description - -The URL of a file to use as an image for the emoji. -Square images under 128KB and with transparent backgrounds work best. - -#### Defined in - -[packages/web-api/src/types/request/admin/emoji.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L19) diff --git a/docs/content/reference/web-api/interfaces/AdminEmojiRemoveArguments.md b/docs/content/reference/web-api/interfaces/AdminEmojiRemoveArguments.md deleted file mode 100644 index 96c936421..000000000 --- a/docs/content/reference/web-api/interfaces/AdminEmojiRemoveArguments.md +++ /dev/null @@ -1,46 +0,0 @@ -# Interface: AdminEmojiRemoveArguments - -## Extends - -- `Name`.`TokenOverridable` - -## Properties - -### name - -```ts -name: string; -``` - -#### Description - -The name of the emoji. Colons (:myemoji:) around the value are not required, -although they may be included. - -#### Inherited from - -`Name.name` - -#### Defined in - -[packages/web-api/src/types/request/admin/emoji.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L10) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminEmojiRenameArguments.md b/docs/content/reference/web-api/interfaces/AdminEmojiRenameArguments.md deleted file mode 100644 index 20495fa25..000000000 --- a/docs/content/reference/web-api/interfaces/AdminEmojiRenameArguments.md +++ /dev/null @@ -1,62 +0,0 @@ -# Interface: AdminEmojiRenameArguments - -## Extends - -- `Name`.`TokenOverridable` - -## Properties - -### name - -```ts -name: string; -``` - -#### Description - -The name of the emoji. Colons (:myemoji:) around the value are not required, -although they may be included. - -#### Inherited from - -`Name.name` - -#### Defined in - -[packages/web-api/src/types/request/admin/emoji.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L10) - -*** - -### new\_name - -```ts -new_name: string; -``` - -#### Description - -The new name of the emoji. - -#### Defined in - -[packages/web-api/src/types/request/admin/emoji.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L40) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminFunctionsListArguments.md b/docs/content/reference/web-api/interfaces/AdminFunctionsListArguments.md deleted file mode 100644 index fafa9d02b..000000000 --- a/docs/content/reference/web-api/interfaces/AdminFunctionsListArguments.md +++ /dev/null @@ -1,104 +0,0 @@ -# Interface: AdminFunctionsListArguments - -## Extends - -- `TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### app\_ids - -```ts -app_ids: string[]; -``` - -#### Description - -Array of app IDs to get functions for; max 50. - -#### Defined in - -[packages/web-api/src/types/request/admin/functions.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L6) - -*** - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -The team context to retrieve functions from. - -#### Defined in - -[packages/web-api/src/types/request/admin/functions.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L8) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsLookupArguments.md b/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsLookupArguments.md deleted file mode 100644 index 2c0e54f13..000000000 --- a/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsLookupArguments.md +++ /dev/null @@ -1,41 +0,0 @@ -# Interface: AdminFunctionsPermissionsLookupArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### function\_ids - -```ts -function_ids: [string, ...string[]]; -``` - -#### Description - -An array of function IDs to get permissions for. - -#### Defined in - -[packages/web-api/src/types/request/admin/functions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L15) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsSetArguments.md b/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsSetArguments.md deleted file mode 100644 index ad9739b4d..000000000 --- a/docs/content/reference/web-api/interfaces/AdminFunctionsPermissionsSetArguments.md +++ /dev/null @@ -1,73 +0,0 @@ -# Interface: AdminFunctionsPermissionsSetArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### function\_id - -```ts -function_id: string; -``` - -#### Description - -The function ID to set permissions for. - -#### Defined in - -[packages/web-api/src/types/request/admin/functions.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L21) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_ids? - -```ts -optional user_ids: string[]; -``` - -#### Description - -List of user IDs to allow for `named_entities` visibility. - -#### Defined in - -[packages/web-api/src/types/request/admin/functions.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L25) - -*** - -### visibility - -```ts -visibility: "everyone" | "app_collaborators" | "named_entities" | "no_one"; -``` - -#### Description - -The function visibility. - -#### Defined in - -[packages/web-api/src/types/request/admin/functions.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/functions.ts#L23) diff --git a/docs/content/reference/web-api/interfaces/AdminInviteRequestsApproveArguments.md b/docs/content/reference/web-api/interfaces/AdminInviteRequestsApproveArguments.md deleted file mode 100644 index 133cd49a9..000000000 --- a/docs/content/reference/web-api/interfaces/AdminInviteRequestsApproveArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: AdminInviteRequestsApproveArguments - -## Extends - -- `InviteRequestID`.`Required`\<`OptionalTeamAssignable`\>.`TokenOverridable` - -## Properties - -### invite\_request\_id - -```ts -invite_request_id: string; -``` - -#### Description - -ID of the request to invite. - -#### Inherited from - -`InviteRequestID.invite_request_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/inviteRequests.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/inviteRequests.ts#L5) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`Required.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminInviteRequestsApprovedListArguments.md b/docs/content/reference/web-api/interfaces/AdminInviteRequestsApprovedListArguments.md deleted file mode 100644 index 11a7852a3..000000000 --- a/docs/content/reference/web-api/interfaces/AdminInviteRequestsApprovedListArguments.md +++ /dev/null @@ -1,92 +0,0 @@ -# Interface: AdminInviteRequestsApprovedListArguments - -## Extends - -- `Required`\<`OptionalTeamAssignable`\>.`TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`Required.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminInviteRequestsDeniedListArguments.md b/docs/content/reference/web-api/interfaces/AdminInviteRequestsDeniedListArguments.md deleted file mode 100644 index e8e7d4bd0..000000000 --- a/docs/content/reference/web-api/interfaces/AdminInviteRequestsDeniedListArguments.md +++ /dev/null @@ -1,92 +0,0 @@ -# Interface: AdminInviteRequestsDeniedListArguments - -## Extends - -- `Required`\<`OptionalTeamAssignable`\>.`TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`Required.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminInviteRequestsDenyArguments.md b/docs/content/reference/web-api/interfaces/AdminInviteRequestsDenyArguments.md deleted file mode 100644 index 7ca38e6f3..000000000 --- a/docs/content/reference/web-api/interfaces/AdminInviteRequestsDenyArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: AdminInviteRequestsDenyArguments - -## Extends - -- `InviteRequestID`.`Required`\<`OptionalTeamAssignable`\>.`TokenOverridable` - -## Properties - -### invite\_request\_id - -```ts -invite_request_id: string; -``` - -#### Description - -ID of the request to invite. - -#### Inherited from - -`InviteRequestID.invite_request_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/inviteRequests.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/inviteRequests.ts#L5) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`Required.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminInviteRequestsListArguments.md b/docs/content/reference/web-api/interfaces/AdminInviteRequestsListArguments.md deleted file mode 100644 index 707a1c849..000000000 --- a/docs/content/reference/web-api/interfaces/AdminInviteRequestsListArguments.md +++ /dev/null @@ -1,92 +0,0 @@ -# Interface: AdminInviteRequestsListArguments - -## Extends - -- `Required`\<`OptionalTeamAssignable`\>.`TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`Required.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminRolesAddAssignmentsArguments.md b/docs/content/reference/web-api/interfaces/AdminRolesAddAssignmentsArguments.md deleted file mode 100644 index 46fd90a7e..000000000 --- a/docs/content/reference/web-api/interfaces/AdminRolesAddAssignmentsArguments.md +++ /dev/null @@ -1,90 +0,0 @@ -# Interface: AdminRolesAddAssignmentsArguments - -## Extends - -- `EntityIDs`.`RoleID`.`UserIDs`.`TokenOverridable` - -## Properties - -### entity\_ids - -```ts -entity_ids: [string, ...string[]]; -``` - -#### Description - -List of the entity IDs for which roles will be assigned/listed/removed. -These can be Org IDs (E12345), Team IDs (T12345) or Channel IDs (C12345). - -#### Inherited from - -`EntityIDs.entity_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/roles.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/roles.ts#L10) - -*** - -### role\_id - -```ts -role_id: string; -``` - -#### Description - -ID of the role to which users will be assigned/removed. - -#### See - -[Admin Roles under Usage info](https://api.slack.com/methods/admin.roles.addAssignments#markdown). - -#### Inherited from - -`RoleID.role_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/roles.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/roles.ts#L18) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_ids - -```ts -user_ids: [string, ...string[]]; -``` - -#### Description - -List of encoded user IDs. - -#### Inherited from - -`UserIDs.user_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminRolesRemoveAssignmentsArguments.md b/docs/content/reference/web-api/interfaces/AdminRolesRemoveAssignmentsArguments.md deleted file mode 100644 index 52f719fa0..000000000 --- a/docs/content/reference/web-api/interfaces/AdminRolesRemoveAssignmentsArguments.md +++ /dev/null @@ -1,90 +0,0 @@ -# Interface: AdminRolesRemoveAssignmentsArguments - -## Extends - -- `EntityIDs`.`RoleID`.`UserIDs`.`TokenOverridable` - -## Properties - -### entity\_ids - -```ts -entity_ids: [string, ...string[]]; -``` - -#### Description - -List of the entity IDs for which roles will be assigned/listed/removed. -These can be Org IDs (E12345), Team IDs (T12345) or Channel IDs (C12345). - -#### Inherited from - -`EntityIDs.entity_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/roles.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/roles.ts#L10) - -*** - -### role\_id - -```ts -role_id: string; -``` - -#### Description - -ID of the role to which users will be assigned/removed. - -#### See - -[Admin Roles under Usage info](https://api.slack.com/methods/admin.roles.addAssignments#markdown). - -#### Inherited from - -`RoleID.role_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/roles.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/roles.ts#L18) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_ids - -```ts -user_ids: [string, ...string[]]; -``` - -#### Description - -List of encoded user IDs. - -#### Inherited from - -`UserIDs.user_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsAdminsListArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsAdminsListArguments.md deleted file mode 100644 index 26ccf9070..000000000 --- a/docs/content/reference/web-api/interfaces/AdminTeamsAdminsListArguments.md +++ /dev/null @@ -1,92 +0,0 @@ -# Interface: AdminTeamsAdminsListArguments - -## Extends - -- `TeamID`.`TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsCreateArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsCreateArguments.md deleted file mode 100644 index 976a5e4be..000000000 --- a/docs/content/reference/web-api/interfaces/AdminTeamsCreateArguments.md +++ /dev/null @@ -1,89 +0,0 @@ -# Interface: AdminTeamsCreateArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### team\_description? - -```ts -optional team_description: string; -``` - -#### Description - -Description for the team. - -#### Defined in - -[packages/web-api/src/types/request/admin/teams.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L17) - -*** - -### team\_discoverability? - -```ts -optional team_discoverability: TeamDiscoverability; -``` - -#### Description - -Who can join the team. - -#### Defined in - -[packages/web-api/src/types/request/admin/teams.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L19) - -*** - -### team\_domain - -```ts -team_domain: string; -``` - -#### Description - -Team domain (for example, slacksoftballteam). Domains are limited to 21 characters. - -#### Defined in - -[packages/web-api/src/types/request/admin/teams.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L13) - -*** - -### team\_name - -```ts -team_name: string; -``` - -#### Description - -Team name (for example, Slack Softball Team). - -#### Defined in - -[packages/web-api/src/types/request/admin/teams.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L15) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsOwnersListArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsOwnersListArguments.md deleted file mode 100644 index d17521e0d..000000000 --- a/docs/content/reference/web-api/interfaces/AdminTeamsOwnersListArguments.md +++ /dev/null @@ -1,92 +0,0 @@ -# Interface: AdminTeamsOwnersListArguments - -## Extends - -- `TeamID`.`TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsInfoArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsInfoArguments.md deleted file mode 100644 index 8519fbefb..000000000 --- a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsInfoArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminTeamsSettingsInfoArguments - -## Extends - -- `TeamID`.`TokenOverridable` - -## Properties - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDefaultChannelsArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDefaultChannelsArguments.md deleted file mode 100644 index 2371b4f5f..000000000 --- a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDefaultChannelsArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: AdminTeamsSettingsSetDefaultChannelsArguments - -## Extends - -- `ChannelIDs`.`TeamID`.`TokenOverridable` - -## Properties - -### channel\_ids - -```ts -channel_ids: [string, ...string[]]; -``` - -#### Description - -An array of channel IDs (must include at least one ID). - -#### Inherited from - -`ChannelIDs.channel_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDescriptionArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDescriptionArguments.md deleted file mode 100644 index 2187f7a97..000000000 --- a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDescriptionArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminTeamsSettingsSetDescriptionArguments - -## Extends - -- `TeamID`.`TokenOverridable` - -## Properties - -### description - -```ts -description: string; -``` - -#### Description - -The new description for the workspace. - -#### Defined in - -[packages/web-api/src/types/request/admin/teams.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L37) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDiscoverabilityArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDiscoverabilityArguments.md deleted file mode 100644 index 01c68ac97..000000000 --- a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetDiscoverabilityArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminTeamsSettingsSetDiscoverabilityArguments - -## Extends - -- `TeamID`.`TokenOverridable` - -## Properties - -### discoverability - -```ts -discoverability: TeamDiscoverability; -``` - -#### Description - -This workspace's discovery setting. - -#### Defined in - -[packages/web-api/src/types/request/admin/teams.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L43) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetIconArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetIconArguments.md deleted file mode 100644 index 41ae961ef..000000000 --- a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetIconArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminTeamsSettingsSetIconArguments - -## Extends - -- `TeamID`.`TokenOverridable` - -## Properties - -### image\_url - -```ts -image_url: string; -``` - -#### Description - -Image URL for the icon. - -#### Defined in - -[packages/web-api/src/types/request/admin/teams.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L49) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetNameArguments.md b/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetNameArguments.md deleted file mode 100644 index 745e6976b..000000000 --- a/docs/content/reference/web-api/interfaces/AdminTeamsSettingsSetNameArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminTeamsSettingsSetNameArguments - -## Extends - -- `TeamID`.`TokenOverridable` - -## Properties - -### name - -```ts -name: string; -``` - -#### Description - -The new name of the workspace. - -#### Defined in - -[packages/web-api/src/types/request/admin/teams.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L55) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminUsergroupsAddChannelsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsergroupsAddChannelsArguments.md deleted file mode 100644 index bd3a315b1..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsergroupsAddChannelsArguments.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: AdminUsergroupsAddChannelsArguments - -## Extends - -- `ChannelIDs`.`UsergroupID`.`OptionalTeamAssignable`.`TokenOverridable` - -## Properties - -### channel\_ids - -```ts -channel_ids: string | string[]; -``` - -#### Description - -One or more encoded channel IDs. - -#### Inherited from - -`ChannelIDs.channel_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/usergroups.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L5) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### usergroup\_id - -```ts -usergroup_id: string; -``` - -#### Description - -ID of the IDP group to list/manage channels for. - -#### Inherited from - -`UsergroupID.usergroup_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/usergroups.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L10) diff --git a/docs/content/reference/web-api/interfaces/AdminUsergroupsAddTeamsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsergroupsAddTeamsArguments.md deleted file mode 100644 index 52bbf0365..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsergroupsAddTeamsArguments.md +++ /dev/null @@ -1,79 +0,0 @@ -# Interface: AdminUsergroupsAddTeamsArguments - -## Extends - -- `UsergroupID`.`TokenOverridable` - -## Properties - -### auto\_provision? - -```ts -optional auto_provision: boolean; -``` - -#### Description - -When `true`, this method automatically creates new workspace accounts for the IDP group members. -Defaults to `false`. - -#### Defined in - -[packages/web-api/src/types/request/admin/usergroups.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L28) - -*** - -### team\_ids - -```ts -team_ids: string | string[]; -``` - -#### Description - -One or more encoded team (workspace) IDs. -Each workspace MUST belong to the organization associated with the token. - -#### Defined in - -[packages/web-api/src/types/request/admin/usergroups.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L23) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### usergroup\_id - -```ts -usergroup_id: string; -``` - -#### Description - -ID of the IDP group to list/manage channels for. - -#### Inherited from - -`UsergroupID.usergroup_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/usergroups.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L10) diff --git a/docs/content/reference/web-api/interfaces/AdminUsergroupsListChannelsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsergroupsListChannelsArguments.md deleted file mode 100644 index 8d46eeac7..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsergroupsListChannelsArguments.md +++ /dev/null @@ -1,81 +0,0 @@ -# Interface: AdminUsergroupsListChannelsArguments - -## Extends - -- `UsergroupID`.`OptionalTeamAssignable`.`TokenOverridable` - -## Properties - -### include\_num\_members? - -```ts -optional include_num_members: boolean; -``` - -#### Description - -Flag to include or exclude the count of members per channel. - -#### Defined in - -[packages/web-api/src/types/request/admin/usergroups.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L34) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### usergroup\_id - -```ts -usergroup_id: string; -``` - -#### Description - -ID of the IDP group to list/manage channels for. - -#### Inherited from - -`UsergroupID.usergroup_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/usergroups.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L10) diff --git a/docs/content/reference/web-api/interfaces/AdminUsergroupsRemoveChannelsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsergroupsRemoveChannelsArguments.md deleted file mode 100644 index 5e3bc2d32..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsergroupsRemoveChannelsArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: AdminUsergroupsRemoveChannelsArguments - -## Extends - -- `ChannelIDs`.`UsergroupID`.`TokenOverridable` - -## Properties - -### channel\_ids - -```ts -channel_ids: string | string[]; -``` - -#### Description - -One or more encoded channel IDs. - -#### Inherited from - -`ChannelIDs.channel_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/usergroups.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L5) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### usergroup\_id - -```ts -usergroup_id: string; -``` - -#### Description - -ID of the IDP group to list/manage channels for. - -#### Inherited from - -`UsergroupID.usergroup_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/usergroups.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/usergroups.ts#L10) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersAssignArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersAssignArguments.md deleted file mode 100644 index 3995d7dbf..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersAssignArguments.md +++ /dev/null @@ -1,125 +0,0 @@ -# Interface: AdminUsersAssignArguments - -## Extends - -- `TeamID`.`UserID`.`Partial`\<`ChannelIDs`\>.`IsRestricted`.`IsUltraRestricted`.`TokenOverridable` - -## Properties - -### channel\_ids? - -```ts -optional channel_ids: [string, ...string[]]; -``` - -#### Description - -An array of channel IDs (must include at least one ID). - -#### Inherited from - -`Partial.channel_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) - -*** - -### is\_restricted? - -```ts -optional is_restricted: boolean; -``` - -#### Description - -Set to `true` if user should be added to the workspace as a guest. - -#### Inherited from - -`IsRestricted.is_restricted` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L19) - -*** - -### is\_ultra\_restricted? - -```ts -optional is_ultra_restricted: boolean; -``` - -#### Description - -Set to `true` if user should be added to the workspace as a guest. - -#### Inherited from - -`IsUltraRestricted.is_ultra_restricted` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L24) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_id - -```ts -user_id: string; -``` - -#### Description - -The ID of the user. - -#### Inherited from - -`UserID.user_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersInviteArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersInviteArguments.md deleted file mode 100644 index 581615ee7..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersInviteArguments.md +++ /dev/null @@ -1,204 +0,0 @@ -# Interface: AdminUsersInviteArguments - -## Extends - -- `ChannelIDs`.`TeamID`.`IsRestricted`.`IsUltraRestricted`.`TokenOverridable` - -## Properties - -### channel\_ids - -```ts -channel_ids: [string, ...string[]]; -``` - -#### Description - -An array of channel IDs (must include at least one ID). - -#### Inherited from - -`ChannelIDs.channel_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) - -*** - -### custom\_message? - -```ts -optional custom_message: string; -``` - -#### Description - -An optional message to send to the user in the invite email. - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L67) - -*** - -### email - -```ts -email: string; -``` - -#### Description - -The email address of the person to invite. - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L65) - -*** - -### email\_password\_policy\_enabled? - -```ts -optional email_password_policy_enabled: boolean; -``` - -#### Description - -Allow invited user to sign in via email and password. Only available for Enterprise Grid teams via -admin invite. - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:72](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L72) - -*** - -### guest\_expiration\_ts? - -```ts -optional guest_expiration_ts: string; -``` - -#### Description - -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. - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:77](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L77) - -*** - -### is\_restricted? - -```ts -optional is_restricted: boolean; -``` - -#### Description - -Set to `true` if user should be added to the workspace as a guest. - -#### Inherited from - -`IsRestricted.is_restricted` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L19) - -*** - -### is\_ultra\_restricted? - -```ts -optional is_ultra_restricted: boolean; -``` - -#### Description - -Set to `true` if user should be added to the workspace as a guest. - -#### Inherited from - -`IsUltraRestricted.is_ultra_restricted` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L24) - -*** - -### real\_name? - -```ts -optional real_name: string; -``` - -#### Description - -Full name of the user. - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:79](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L79) - -*** - -### resend? - -```ts -optional resend: boolean; -``` - -#### Description - -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`. - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L84) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersRemoveArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersRemoveArguments.md deleted file mode 100644 index 96bf30ece..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersRemoveArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: AdminUsersRemoveArguments - -## Extends - -- `TeamID`.`UserID`.`TokenOverridable` - -## Properties - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_id - -```ts -user_id: string; -``` - -#### Description - -The ID of the user. - -#### Inherited from - -`UserID.user_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionClearSettingsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionClearSettingsArguments.md deleted file mode 100644 index b1601e18d..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersSessionClearSettingsArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminUsersSessionClearSettingsArguments - -## Extends - -- `UserIDs`.`TokenOverridable` - -## Properties - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_ids - -```ts -user_ids: [string, ...string[]]; -``` - -#### Description - -List of encoded user IDs. - -#### Inherited from - -`UserIDs.user_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionGetSettingsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionGetSettingsArguments.md deleted file mode 100644 index 9509010a4..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersSessionGetSettingsArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminUsersSessionGetSettingsArguments - -## Extends - -- `UserIDs`.`TokenOverridable` - -## Properties - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_ids - -```ts -user_ids: [string, ...string[]]; -``` - -#### Description - -List of encoded user IDs. - -#### Inherited from - -`UserIDs.user_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionInvalidateArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionInvalidateArguments.md deleted file mode 100644 index 0efc9a1da..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersSessionInvalidateArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: AdminUsersSessionInvalidateArguments - -## Extends - -- `TeamID`.`TokenOverridable` - -## Properties - -### session\_id - -```ts -session_id: string; -``` - -#### Description - -ID of the session to invalidate. - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L109) - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionResetArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionResetArguments.md deleted file mode 100644 index d8caf3b63..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersSessionResetArguments.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: AdminUsersSessionResetArguments - -## Extends - -- `UserID`.`SessionExpirationTarget`.`TokenOverridable` - -## Properties - -### mobile\_only? - -```ts -optional mobile_only: boolean; -``` - -#### Description - -Only expire mobile sessions. Defaults to `false`. - -#### Inherited from - -`SessionExpirationTarget.mobile_only` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L29) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_id - -```ts -user_id: string; -``` - -#### Description - -The ID of the user. - -#### Inherited from - -`UserID.user_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) - -*** - -### web\_only? - -```ts -optional web_only: boolean; -``` - -#### Description - -Only expire web sessions. Defaults to `false`. - -#### Inherited from - -`SessionExpirationTarget.web_only` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L31) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionResetBulkArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionResetBulkArguments.md deleted file mode 100644 index 2c4793494..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersSessionResetBulkArguments.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: AdminUsersSessionResetBulkArguments - -## Extends - -- `UserIDs`.`SessionExpirationTarget`.`TokenOverridable` - -## Properties - -### mobile\_only? - -```ts -optional mobile_only: boolean; -``` - -#### Description - -Only expire mobile sessions. Defaults to `false`. - -#### Inherited from - -`SessionExpirationTarget.mobile_only` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L29) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_ids - -```ts -user_ids: [string, ...string[]]; -``` - -#### Description - -List of encoded user IDs. - -#### Inherited from - -`UserIDs.user_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) - -*** - -### web\_only? - -```ts -optional web_only: boolean; -``` - -#### Description - -Only expire web sessions. Defaults to `false`. - -#### Inherited from - -`SessionExpirationTarget.web_only` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L31) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSessionSetSettingsArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSessionSetSettingsArguments.md deleted file mode 100644 index 99b58b021..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersSessionSetSettingsArguments.md +++ /dev/null @@ -1,78 +0,0 @@ -# Interface: AdminUsersSessionSetSettingsArguments - -## Extends - -- `UserIDs`.`TokenOverridable` - -## Properties - -### desktop\_app\_browser\_quit? - -```ts -optional desktop_app_browser_quit: boolean; -``` - -#### Description - -Terminate the session when the client—either the desktop app or a browser window—is closed. - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L125) - -*** - -### duration? - -```ts -optional duration: number; -``` - -#### Description - -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). - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L130) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_ids - -```ts -user_ids: [string, ...string[]]; -``` - -#### Description - -List of encoded user IDs. - -#### Inherited from - -`UserIDs.user_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSetAdminArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSetAdminArguments.md deleted file mode 100644 index ed54359c8..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersSetAdminArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: AdminUsersSetAdminArguments - -## Extends - -- `TeamID`.`UserID`.`TokenOverridable` - -## Properties - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_id - -```ts -user_id: string; -``` - -#### Description - -The ID of the user. - -#### Inherited from - -`UserID.user_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSetExpirationArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSetExpirationArguments.md deleted file mode 100644 index 5793106b6..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersSetExpirationArguments.md +++ /dev/null @@ -1,81 +0,0 @@ -# Interface: AdminUsersSetExpirationArguments - -## Extends - -- `UserID`.`TokenOverridable`.`OptionalTeamAssignable` - -## Properties - -### expiration\_ts - -```ts -expiration_ts: number; -``` - -#### Description - -Epoch timestamp in seconds when guest account should be disabled. - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:139](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L139) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_id - -```ts -user_id: string; -``` - -#### Description - -The ID of the user. - -#### Inherited from - -`UserID.user_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSetOwnerArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSetOwnerArguments.md deleted file mode 100644 index 1b11a0f55..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersSetOwnerArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: AdminUsersSetOwnerArguments - -## Extends - -- `TeamID`.`UserID`.`TokenOverridable` - -## Properties - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_id - -```ts -user_id: string; -``` - -#### Description - -The ID of the user. - -#### Inherited from - -`UserID.user_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersSetRegularArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersSetRegularArguments.md deleted file mode 100644 index bb2263af2..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersSetRegularArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: AdminUsersSetRegularArguments - -## Extends - -- `TeamID`.`UserID`.`TokenOverridable` - -## Properties - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID. - -#### Inherited from - -`TeamID.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L61) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_id - -```ts -user_id: string; -``` - -#### Description - -The ID of the user. - -#### Inherited from - -`UserID.user_id` - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L14) diff --git a/docs/content/reference/web-api/interfaces/AdminUsersUnsupportedVersionsExportArguments.md b/docs/content/reference/web-api/interfaces/AdminUsersUnsupportedVersionsExportArguments.md deleted file mode 100644 index 84b13f977..000000000 --- a/docs/content/reference/web-api/interfaces/AdminUsersUnsupportedVersionsExportArguments.md +++ /dev/null @@ -1,59 +0,0 @@ -# Interface: AdminUsersUnsupportedVersionsExportArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### date\_end\_of\_support? - -```ts -optional date_end_of_support: number; -``` - -#### Description - -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`. - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:154](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L154) - -*** - -### date\_sessions\_started? - -```ts -optional date_sessions_started: number; -``` - -#### Description - -Unix timestamp of a date to start looking for user sessions. -If not provided will start six months ago. - -#### Defined in - -[packages/web-api/src/types/request/admin/users.ts:159](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L159) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsAddArguments.md b/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsAddArguments.md deleted file mode 100644 index e5bad42e7..000000000 --- a/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsAddArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: AdminWorkflowsCollaboratorsAddArguments - -## Extends - -- `CollaboratorIDs`.`WorkflowIDs`.`TokenOverridable` - -## Properties - -### collaborator\_ids - -```ts -collaborator_ids: [string, ...string[]]; -``` - -#### Description - -Array of collaborators (encoded user IDs) - maximum of 50 items. - -#### Inherited from - -`CollaboratorIDs.collaborator_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/workflows.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L7) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### workflow\_ids - -```ts -workflow_ids: [string, ...string[]]; -``` - -#### Description - -Array of workflow IDs - maximum of 50 items. - -#### Inherited from - -`WorkflowIDs.workflow_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/workflows.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L12) diff --git a/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsRemoveArguments.md b/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsRemoveArguments.md deleted file mode 100644 index ec0efa9d5..000000000 --- a/docs/content/reference/web-api/interfaces/AdminWorkflowsCollaboratorsRemoveArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: AdminWorkflowsCollaboratorsRemoveArguments - -## Extends - -- `CollaboratorIDs`.`WorkflowIDs`.`TokenOverridable` - -## Properties - -### collaborator\_ids - -```ts -collaborator_ids: [string, ...string[]]; -``` - -#### Description - -Array of collaborators (encoded user IDs) - maximum of 50 items. - -#### Inherited from - -`CollaboratorIDs.collaborator_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/workflows.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L7) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### workflow\_ids - -```ts -workflow_ids: [string, ...string[]]; -``` - -#### Description - -Array of workflow IDs - maximum of 50 items. - -#### Inherited from - -`WorkflowIDs.workflow_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/workflows.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L12) diff --git a/docs/content/reference/web-api/interfaces/AdminWorkflowsPermissionsLookupArguments.md b/docs/content/reference/web-api/interfaces/AdminWorkflowsPermissionsLookupArguments.md deleted file mode 100644 index 97043d9d6..000000000 --- a/docs/content/reference/web-api/interfaces/AdminWorkflowsPermissionsLookupArguments.md +++ /dev/null @@ -1,62 +0,0 @@ -# Interface: AdminWorkflowsPermissionsLookupArguments - -## Extends - -- `WorkflowIDs`.`TokenOverridable` - -## Properties - -### max\_workflow\_triggers? - -```ts -optional max_workflow_triggers: number; -``` - -#### Description - -Maximum number of triggers to fetch for each workflow when determining overall run permissions. -Defaults to `100`. Maximum of `1000`. - -#### Defined in - -[packages/web-api/src/types/request/admin/workflows.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L27) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### workflow\_ids - -```ts -workflow_ids: [string, ...string[]]; -``` - -#### Description - -Array of workflow IDs - maximum of 50 items. - -#### Inherited from - -`WorkflowIDs.workflow_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/workflows.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L12) diff --git a/docs/content/reference/web-api/interfaces/AdminWorkflowsUnpublishArguments.md b/docs/content/reference/web-api/interfaces/AdminWorkflowsUnpublishArguments.md deleted file mode 100644 index d335489b5..000000000 --- a/docs/content/reference/web-api/interfaces/AdminWorkflowsUnpublishArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AdminWorkflowsUnpublishArguments - -## Extends - -- `WorkflowIDs`.`TokenOverridable` - -## Properties - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### workflow\_ids - -```ts -workflow_ids: [string, ...string[]]; -``` - -#### Description - -Array of workflow IDs - maximum of 50 items. - -#### Inherited from - -`WorkflowIDs.workflow_ids` - -#### Defined in - -[packages/web-api/src/types/request/admin/workflows.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L12) diff --git a/docs/content/reference/web-api/interfaces/AppsEventAuthorizationsListArguments.md b/docs/content/reference/web-api/interfaces/AppsEventAuthorizationsListArguments.md deleted file mode 100644 index 5b727cec2..000000000 --- a/docs/content/reference/web-api/interfaces/AppsEventAuthorizationsListArguments.md +++ /dev/null @@ -1,84 +0,0 @@ -# Interface: AppsEventAuthorizationsListArguments - -## Extends - -- `TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### event\_context - -```ts -event_context: string; -``` - -#### Defined in - -[packages/web-api/src/types/request/apps.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L12) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsManifestCreateArguments.md b/docs/content/reference/web-api/interfaces/AppsManifestCreateArguments.md deleted file mode 100644 index 5270f4d5b..000000000 --- a/docs/content/reference/web-api/interfaces/AppsManifestCreateArguments.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: AppsManifestCreateArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### manifest - -```ts -manifest: Manifest; -``` - -#### Defined in - -[packages/web-api/src/types/request/apps.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L17) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsManifestDeleteArguments.md b/docs/content/reference/web-api/interfaces/AppsManifestDeleteArguments.md deleted file mode 100644 index 710922803..000000000 --- a/docs/content/reference/web-api/interfaces/AppsManifestDeleteArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AppsManifestDeleteArguments - -## Extends - -- `AppID`.`TokenOverridable` - -## Properties - -### app\_id - -```ts -app_id: string; -``` - -#### Description - -The ID of the app. - -#### Inherited from - -`AppID.app_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L88) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsManifestExportArguments.md b/docs/content/reference/web-api/interfaces/AppsManifestExportArguments.md deleted file mode 100644 index 16528a740..000000000 --- a/docs/content/reference/web-api/interfaces/AppsManifestExportArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AppsManifestExportArguments - -## Extends - -- `AppID`.`TokenOverridable` - -## Properties - -### app\_id - -```ts -app_id: string; -``` - -#### Description - -The ID of the app. - -#### Inherited from - -`AppID.app_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L88) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsManifestUpdateArguments.md b/docs/content/reference/web-api/interfaces/AppsManifestUpdateArguments.md deleted file mode 100644 index ce96306d7..000000000 --- a/docs/content/reference/web-api/interfaces/AppsManifestUpdateArguments.md +++ /dev/null @@ -1,57 +0,0 @@ -# Interface: AppsManifestUpdateArguments - -## Extends - -- `AppID`.`TokenOverridable` - -## Properties - -### app\_id - -```ts -app_id: string; -``` - -#### Description - -The ID of the app. - -#### Inherited from - -`AppID.app_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L88) - -*** - -### manifest - -```ts -manifest: Manifest; -``` - -#### Defined in - -[packages/web-api/src/types/request/apps.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L28) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsManifestValidateArguments.md b/docs/content/reference/web-api/interfaces/AppsManifestValidateArguments.md deleted file mode 100644 index 426bc3cf5..000000000 --- a/docs/content/reference/web-api/interfaces/AppsManifestValidateArguments.md +++ /dev/null @@ -1,57 +0,0 @@ -# Interface: AppsManifestValidateArguments - -## Extends - -- `Partial`\<`AppID`\>.`TokenOverridable` - -## Properties - -### app\_id? - -```ts -optional app_id: string; -``` - -#### Description - -The ID of the app. - -#### Inherited from - -`Partial.app_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L88) - -*** - -### manifest - -```ts -manifest: Manifest; -``` - -#### Defined in - -[packages/web-api/src/types/request/apps.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L33) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/AppsUninstallArguments.md b/docs/content/reference/web-api/interfaces/AppsUninstallArguments.md deleted file mode 100644 index a68efc286..000000000 --- a/docs/content/reference/web-api/interfaces/AppsUninstallArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: AppsUninstallArguments - -## Extends - -- `Pick`\<`OAuthCredentials`, `"client_id"` \| `"client_secret"`\> - -## Properties - -### client\_id - -```ts -client_id: string; -``` - -#### Description - -Issued when you created your application. - -#### Inherited from - -`Pick.client_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L125) - -*** - -### client\_secret - -```ts -client_secret: string; -``` - -#### Description - -Issued when you created your application. - -#### Inherited from - -`Pick.client_secret` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L127) diff --git a/docs/content/reference/web-api/interfaces/AttachmentAction.md b/docs/content/reference/web-api/interfaces/AttachmentAction.md deleted file mode 100644 index a5f483b61..000000000 --- a/docs/content/reference/web-api/interfaces/AttachmentAction.md +++ /dev/null @@ -1,162 +0,0 @@ -# Interface: AttachmentAction - -## Properties - -### confirm? - -```ts -optional confirm: Confirmation; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:140 - -*** - -### data\_source? - -```ts -optional data_source: - | "channels" - | "users" - | "conversations" - | "external" - | "static"; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:141 - -*** - -### id? - -```ts -optional id: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:139 - -*** - -### min\_query\_length? - -```ts -optional min_query_length: number; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:142 - -*** - -### name? - -```ts -optional name: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:143 - -*** - -### option\_groups? - -```ts -optional option_groups: object[]; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:145 - -*** - -### options? - -```ts -optional options: OptionField[]; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:144 - -*** - -### selected\_options? - -```ts -optional selected_options: OptionField[]; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:149 - -*** - -### style? - -```ts -optional style: "danger" | "default" | "primary"; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:150 - -*** - -### text - -```ts -text: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:151 - -*** - -### type - -```ts -type: "select" | "button"; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:152 - -*** - -### url? - -```ts -optional url: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:154 - -*** - -### value? - -```ts -optional value: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:153 diff --git a/docs/content/reference/web-api/interfaces/Block.md b/docs/content/reference/web-api/interfaces/Block.md deleted file mode 100644 index ccb8a7564..000000000 --- a/docs/content/reference/web-api/interfaces/Block.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: Block - -## Extended by - -- [`ActionsBlock`](ActionsBlock.md) -- [`ContextBlock`](ContextBlock.md) -- [`DividerBlock`](DividerBlock.md) -- [`FileBlock`](FileBlock.md) -- [`HeaderBlock`](HeaderBlock.md) -- [`InputBlock`](InputBlock.md) -- [`SectionBlock`](SectionBlock.md) -- [`VideoBlock`](VideoBlock.md) -- [`RichTextBlock`](RichTextBlock.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 - -*** - -### type - -```ts -type: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:5 diff --git a/docs/content/reference/web-api/interfaces/BookmarksAddArguments.md b/docs/content/reference/web-api/interfaces/BookmarksAddArguments.md deleted file mode 100644 index c527723da..000000000 --- a/docs/content/reference/web-api/interfaces/BookmarksAddArguments.md +++ /dev/null @@ -1,153 +0,0 @@ -# Interface: BookmarksAddArguments - -## Extends - -- `Channel`.`BookmarkFields`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Channel containing bookmark. - -#### Inherited from - -`Channel.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L5) - -*** - -### emoji? - -```ts -optional emoji: string; -``` - -#### Description - -Emoji tag to apply to the bookmark. - -#### Inherited from - -`BookmarkFields.emoji` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L16) - -*** - -### entity\_id? - -```ts -optional entity_id: string; -``` - -#### Description - -ID of the entity being bookmarked. Only applies to message and file types. - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L24) - -*** - -### link - -```ts -link: string; -``` - -#### Description - -Link to bookmark. - -#### Inherited from - -`BookmarkFields.link` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L14) - -*** - -### parent\_id? - -```ts -optional parent_id: string; -``` - -#### Description - -ID of this bookmark's parent. - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L26) - -*** - -### title - -```ts -title: string; -``` - -#### Description - -Title for the bookmark. - -#### Inherited from - -`BookmarkFields.title` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L12) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### type - -```ts -type: "link"; -``` - -#### Description - -Type of the bookmark. Only `link` is supported at the moment. - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L22) diff --git a/docs/content/reference/web-api/interfaces/BookmarksEditArguments.md b/docs/content/reference/web-api/interfaces/BookmarksEditArguments.md deleted file mode 100644 index 069f85300..000000000 --- a/docs/content/reference/web-api/interfaces/BookmarksEditArguments.md +++ /dev/null @@ -1,121 +0,0 @@ -# Interface: BookmarksEditArguments - -## Extends - -- `Channel`.`ID`.`Partial`\<`BookmarkFields`\>.`TokenOverridable` - -## Properties - -### bookmark\_id - -```ts -bookmark_id: string; -``` - -#### Inherited from - -`ID.bookmark_id` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L8) - -*** - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Channel containing bookmark. - -#### Inherited from - -`Channel.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L5) - -*** - -### emoji? - -```ts -optional emoji: string; -``` - -#### Description - -Emoji tag to apply to the bookmark. - -#### Inherited from - -`Partial.emoji` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L16) - -*** - -### link? - -```ts -optional link: string; -``` - -#### Description - -Link to bookmark. - -#### Inherited from - -`Partial.link` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L14) - -*** - -### title? - -```ts -optional title: string; -``` - -#### Description - -Title for the bookmark. - -#### Inherited from - -`Partial.title` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L12) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/BookmarksListArguments.md b/docs/content/reference/web-api/interfaces/BookmarksListArguments.md deleted file mode 100644 index 35415ac6f..000000000 --- a/docs/content/reference/web-api/interfaces/BookmarksListArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: BookmarksListArguments - -## Extends - -- `Channel`.`TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Channel containing bookmark. - -#### Inherited from - -`Channel.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L5) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/BookmarksRemoveArguments.md b/docs/content/reference/web-api/interfaces/BookmarksRemoveArguments.md deleted file mode 100644 index 3b057e5e0..000000000 --- a/docs/content/reference/web-api/interfaces/BookmarksRemoveArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: BookmarksRemoveArguments - -## Extends - -- `Channel`.`ID`.`TokenOverridable` - -## Properties - -### bookmark\_id - -```ts -bookmark_id: string; -``` - -#### Inherited from - -`ID.bookmark_id` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L8) - -*** - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Channel containing bookmark. - -#### Inherited from - -`Channel.channel_id` - -#### Defined in - -[packages/web-api/src/types/request/bookmarks.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bookmarks.ts#L5) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/Button.md b/docs/content/reference/web-api/interfaces/Button.md deleted file mode 100644 index f2b6b2c81..000000000 --- a/docs/content/reference/web-api/interfaces/Button.md +++ /dev/null @@ -1,165 +0,0 @@ -# Interface: Button - -## Description - -Allows users a direct path to performing basic actions. - -## See - - - [Button element reference](https://api.slack.com/reference/block-kit/block-elements#button). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md) - -## Properties - -### accessibility\_label? - -```ts -optional accessibility_label: string; -``` - -#### Description - -A label for longer descriptive text about a button element. This label will be read out by screen -readers instead of the button `text` object. Maximum length for this field is 75 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:43 - -*** - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### style? - -```ts -optional style: "danger" | "primary"; -``` - -#### Description - -Decorates buttons with alternative visual color schemes. Use this option with restraint. -`primary` gives buttons a green outline and text, ideal for affirmation or confirmation actions. `primary` should -only be used for one button within a set. -`danger` gives buttons a red outline and text, and should be used when the action is destructive. Use `danger` even -more sparingly than primary. -If you don't include this field, the default button style will be used. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:38 - -*** - -### text - -```ts -text: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) that defines the button's text. `text` may truncate with ~30 characters. -Maximum length for the text in this field is 75 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:18 - -*** - -### type - -```ts -type: "button"; -``` - -#### Description - -The type of element. In this case `type` is always `button`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:13 - -*** - -### url? - -```ts -optional url: string; -``` - -#### Description - -A URL to load in the user's browser when the button is clicked. Maximum length for this field is 3000 -characters. If you're using `url`, you'll still receive an [interaction payload](https://api.slack.com/interactivity/handling#payloads) -and will need to send an [acknowledgement response](https://api.slack.com/interactivity/handling#acknowledgment_response). - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:29 - -*** - -### value? - -```ts -optional value: string; -``` - -#### Description - -The value to send along with the [interaction payload](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 2000 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:23 diff --git a/docs/content/reference/web-api/interfaces/CallUserExternal.md b/docs/content/reference/web-api/interfaces/CallUserExternal.md deleted file mode 100644 index 989e4136d..000000000 --- a/docs/content/reference/web-api/interfaces/CallUserExternal.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: CallUserExternal - -## Properties - -### avatar\_url? - -```ts -optional avatar_url: string; -``` - -#### Description - -URL to an avatar image of the user. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:24 - -*** - -### display\_name - -```ts -display_name: string; -``` - -#### Description - -Name of the user to be displayed in the Call block in a message. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:20 - -*** - -### external\_id - -```ts -external_id: string; -``` - -#### Description - -A unique ID created by your app to represent your users. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:16 diff --git a/docs/content/reference/web-api/interfaces/CallUserSlack.md b/docs/content/reference/web-api/interfaces/CallUserSlack.md deleted file mode 100644 index 844ccbcfd..000000000 --- a/docs/content/reference/web-api/interfaces/CallUserSlack.md +++ /dev/null @@ -1,18 +0,0 @@ -# Interface: CallUserSlack - -## Properties - -### slack\_id - -```ts -slack_id: string; -``` - -#### Description - -The Slack encoded user ID, e.g. U1234ABCD. Set this if you have it or know it, otherwise, set -`external_id` and `display_name`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:10 diff --git a/docs/content/reference/web-api/interfaces/CallsAddArguments.md b/docs/content/reference/web-api/interfaces/CallsAddArguments.md deleted file mode 100644 index 152caedb2..000000000 --- a/docs/content/reference/web-api/interfaces/CallsAddArguments.md +++ /dev/null @@ -1,176 +0,0 @@ -# Interface: CallsAddArguments - -## Extends - -- `Partial`\<`Users`\>.`CallDetails`.`TokenOverridable` - -## Properties - -### created\_by? - -```ts -optional created_by: string; -``` - -#### Description - -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. - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L37) - -*** - -### date\_start? - -```ts -optional date_start: number; -``` - -#### Description - -Unix timestamp of the call start time. - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L39) - -*** - -### desktop\_app\_join\_url? - -```ts -optional desktop_app_join_url: string; -``` - -#### Description - -When supplied, available Slack clients will attempt to directly launch the 3rd-party Call -with this URL. - -#### Inherited from - -`CallDetails.desktop_app_join_url` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L22) - -*** - -### external\_display\_id? - -```ts -optional external_display_id: string; -``` - -#### Description - -An optional, human-readable ID supplied by the 3rd-party Call provider. -If supplied, this ID will be displayed in the Call object. - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L44) - -*** - -### external\_unique\_id - -```ts -external_unique_id: string; -``` - -#### Description - -An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service. - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L32) - -*** - -### join\_url - -```ts -join_url: string; -``` - -#### Description - -The URL required for a client to join the Call. - -#### Inherited from - -`CallDetails.join_url` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L17) - -*** - -### title? - -```ts -optional title: string; -``` - -#### Description - -The name of the Call. - -#### Inherited from - -`CallDetails.title` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L24) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### users? - -```ts -optional users: CallUser[]; -``` - -#### Description - -The list of users to add/remove to/from the Call. - -#### See - -[Using the Calls API: a note on Users](https://api.slack.com/apis/calls#users). - -#### Inherited from - -`Partial.users` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L13) diff --git a/docs/content/reference/web-api/interfaces/CallsEndArguments.md b/docs/content/reference/web-api/interfaces/CallsEndArguments.md deleted file mode 100644 index c269aa88e..000000000 --- a/docs/content/reference/web-api/interfaces/CallsEndArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: CallsEndArguments - -## Extends - -- `ID`.`TokenOverridable` - -## Properties - -### duration? - -```ts -optional duration: number; -``` - -#### Description - -Call duration in seconds. - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L50) - -*** - -### id - -```ts -id: string; -``` - -#### Description - -`id` returned when registering the call using the `calls.add` method. - -#### Inherited from - -`ID.id` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L6) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/CallsInfoArguments.md b/docs/content/reference/web-api/interfaces/CallsInfoArguments.md deleted file mode 100644 index 69d392620..000000000 --- a/docs/content/reference/web-api/interfaces/CallsInfoArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: CallsInfoArguments - -## Extends - -- `ID`.`TokenOverridable` - -## Properties - -### id - -```ts -id: string; -``` - -#### Description - -`id` returned when registering the call using the `calls.add` method. - -#### Inherited from - -`ID.id` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L6) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/CallsParticipantsAddArguments.md b/docs/content/reference/web-api/interfaces/CallsParticipantsAddArguments.md deleted file mode 100644 index 2dcb00d7d..000000000 --- a/docs/content/reference/web-api/interfaces/CallsParticipantsAddArguments.md +++ /dev/null @@ -1,69 +0,0 @@ -# Interface: CallsParticipantsAddArguments - -## Extends - -- `ID`.`Users`.`TokenOverridable` - -## Properties - -### id - -```ts -id: string; -``` - -#### Description - -`id` returned when registering the call using the `calls.add` method. - -#### Inherited from - -`ID.id` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L6) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### users - -```ts -users: CallUser[]; -``` - -#### Description - -The list of users to add/remove to/from the Call. - -#### See - -[Using the Calls API: a note on Users](https://api.slack.com/apis/calls#users). - -#### Inherited from - -`Users.users` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L13) diff --git a/docs/content/reference/web-api/interfaces/CallsParticipantsRemoveArguments.md b/docs/content/reference/web-api/interfaces/CallsParticipantsRemoveArguments.md deleted file mode 100644 index 9537096c7..000000000 --- a/docs/content/reference/web-api/interfaces/CallsParticipantsRemoveArguments.md +++ /dev/null @@ -1,69 +0,0 @@ -# Interface: CallsParticipantsRemoveArguments - -## Extends - -- `ID`.`Users`.`TokenOverridable` - -## Properties - -### id - -```ts -id: string; -``` - -#### Description - -`id` returned when registering the call using the `calls.add` method. - -#### Inherited from - -`ID.id` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L6) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### users - -```ts -users: CallUser[]; -``` - -#### Description - -The list of users to add/remove to/from the Call. - -#### See - -[Using the Calls API: a note on Users](https://api.slack.com/apis/calls#users). - -#### Inherited from - -`Users.users` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L13) diff --git a/docs/content/reference/web-api/interfaces/CallsUpdateArguments.md b/docs/content/reference/web-api/interfaces/CallsUpdateArguments.md deleted file mode 100644 index c1d6e48e1..000000000 --- a/docs/content/reference/web-api/interfaces/CallsUpdateArguments.md +++ /dev/null @@ -1,106 +0,0 @@ -# Interface: CallsUpdateArguments - -## Extends - -- `ID`.`Partial`\<`CallDetails`\>.`TokenOverridable` - -## Properties - -### desktop\_app\_join\_url? - -```ts -optional desktop_app_join_url: string; -``` - -#### Description - -When supplied, available Slack clients will attempt to directly launch the 3rd-party Call -with this URL. - -#### Inherited from - -`Partial.desktop_app_join_url` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L22) - -*** - -### id - -```ts -id: string; -``` - -#### Description - -`id` returned when registering the call using the `calls.add` method. - -#### Inherited from - -`ID.id` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L6) - -*** - -### join\_url? - -```ts -optional join_url: string; -``` - -#### Description - -The URL required for a client to join the Call. - -#### Inherited from - -`Partial.join_url` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L17) - -*** - -### title? - -```ts -optional title: string; -``` - -#### Description - -The name of the Call. - -#### Inherited from - -`Partial.title` - -#### Defined in - -[packages/web-api/src/types/request/calls.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/calls.ts#L24) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/CanvasesAccessDeleteArguments.md b/docs/content/reference/web-api/interfaces/CanvasesAccessDeleteArguments.md deleted file mode 100644 index d80b7444e..000000000 --- a/docs/content/reference/web-api/interfaces/CanvasesAccessDeleteArguments.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: CanvasesAccessDeleteArguments - -## Extends - -- `CanvasID`.`Partial`\<`ChannelIDs`\>.`TokenOverridable`.`Partial`\<`UserIDs`\> - -## Properties - -### canvas\_id - -```ts -canvas_id: string; -``` - -#### Description - -Encoded ID of the canvas. - -#### Inherited from - -`CanvasID.canvas_id` - -#### Defined in - -[packages/web-api/src/types/request/canvas.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L6) - -*** - -### channel\_ids? - -```ts -optional channel_ids: [string, ...string[]]; -``` - -#### Description - -An array of channel IDs (must include at least one ID). - -#### Inherited from - -`Partial.channel_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_ids? - -```ts -optional user_ids: [string, ...string[]]; -``` - -#### Description - -List of encoded user IDs. - -#### Inherited from - -`Partial.user_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/CanvasesAccessSetArguments.md b/docs/content/reference/web-api/interfaces/CanvasesAccessSetArguments.md deleted file mode 100644 index 75f3f7086..000000000 --- a/docs/content/reference/web-api/interfaces/CanvasesAccessSetArguments.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: CanvasesAccessSetArguments - -## Extends - -- `CanvasID`.`Partial`\<`ChannelIDs`\>.`TokenOverridable`.`Partial`\<`UserIDs`\> - -## Properties - -### access\_level - -```ts -access_level: "read" | "write"; -``` - -#### Description - -Desired level of access. - -#### Defined in - -[packages/web-api/src/types/request/canvas.ts:59](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L59) - -*** - -### canvas\_id - -```ts -canvas_id: string; -``` - -#### Description - -Encoded ID of the canvas. - -#### Inherited from - -`CanvasID.canvas_id` - -#### Defined in - -[packages/web-api/src/types/request/canvas.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L6) - -*** - -### channel\_ids? - -```ts -optional channel_ids: [string, ...string[]]; -``` - -#### Description - -An array of channel IDs (must include at least one ID). - -#### Inherited from - -`Partial.channel_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L76) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_ids? - -```ts -optional user_ids: [string, ...string[]]; -``` - -#### Description - -List of encoded user IDs. - -#### Inherited from - -`Partial.user_ids` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L83) diff --git a/docs/content/reference/web-api/interfaces/CanvasesDeleteArguments.md b/docs/content/reference/web-api/interfaces/CanvasesDeleteArguments.md deleted file mode 100644 index fae0bb0ef..000000000 --- a/docs/content/reference/web-api/interfaces/CanvasesDeleteArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: CanvasesDeleteArguments - -## Extends - -- `CanvasID`.`TokenOverridable` - -## Properties - -### canvas\_id - -```ts -canvas_id: string; -``` - -#### Description - -Encoded ID of the canvas. - -#### Inherited from - -`CanvasID.canvas_id` - -#### Defined in - -[packages/web-api/src/types/request/canvas.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L6) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/CanvasesEditArguments.md b/docs/content/reference/web-api/interfaces/CanvasesEditArguments.md deleted file mode 100644 index cc3e8f2dd..000000000 --- a/docs/content/reference/web-api/interfaces/CanvasesEditArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: CanvasesEditArguments - -## Extends - -- `CanvasID`.`TokenOverridable` - -## Properties - -### canvas\_id - -```ts -canvas_id: string; -``` - -#### Description - -Encoded ID of the canvas. - -#### Inherited from - -`CanvasID.canvas_id` - -#### Defined in - -[packages/web-api/src/types/request/canvas.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L6) - -*** - -### changes - -```ts -changes: [Change, ...Change[]]; -``` - -#### Description - -List of changes to apply to the canvas. - -#### Defined in - -[packages/web-api/src/types/request/canvas.ts:82](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L82) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/CanvasesSectionsLookupArguments.md b/docs/content/reference/web-api/interfaces/CanvasesSectionsLookupArguments.md deleted file mode 100644 index a9f52527e..000000000 --- a/docs/content/reference/web-api/interfaces/CanvasesSectionsLookupArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: CanvasesSectionsLookupArguments - -## Extends - -- `CanvasID`.`TokenOverridable` - -## Properties - -### canvas\_id - -```ts -canvas_id: string; -``` - -#### Description - -Encoded ID of the canvas. - -#### Inherited from - -`CanvasID.canvas_id` - -#### Defined in - -[packages/web-api/src/types/request/canvas.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L6) - -*** - -### criteria - -```ts -criteria: Criteria; -``` - -#### Description - -Filtering criteria. - -#### Defined in - -[packages/web-api/src/types/request/canvas.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L73) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ChannelsSelect.md b/docs/content/reference/web-api/interfaces/ChannelsSelect.md deleted file mode 100644 index dadf427dc..000000000 --- a/docs/content/reference/web-api/interfaces/ChannelsSelect.md +++ /dev/null @@ -1,154 +0,0 @@ -# Interface: ChannelsSelect - -## Description - -This select menu will populate its options with a list of public channels visible to the current user -in the active workspace. - -## See - - - [Select menu of public channels reference](https://api.slack.com/reference/block-kit/block-elements#channels_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_channel? - -```ts -optional initial_channel: string; -``` - -#### Description - -The ID of any valid public channel to be pre-selected when the menu loads. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:359 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### response\_url\_enabled? - -```ts -optional response_url_enabled: boolean; -``` - -#### Description - -When set to `true`, the [`view_submission` payload](https://api.slack.com/reference/interaction-payloads/views#view_submission) -from the menu's parent view will contain a `response_url`. This `response_url` can be used for -[message responses](https://api.slack.com/interactivity/handling#message_responses). The target channel -for the message will be determined by the value of this select menu. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:366 - -*** - -### type - -```ts -type: "channels_select"; -``` - -#### Description - -The type of element. In this case `type` is always `channels_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:355 diff --git a/docs/content/reference/web-api/interfaces/ChatDeleteArguments.md b/docs/content/reference/web-api/interfaces/ChatDeleteArguments.md deleted file mode 100644 index 899531281..000000000 --- a/docs/content/reference/web-api/interfaces/ChatDeleteArguments.md +++ /dev/null @@ -1,87 +0,0 @@ -# Interface: ChatDeleteArguments - -## Extends - -- `ChannelAndTS`.`AsUser`.`TokenOverridable` - -## Properties - -### as\_user? - -```ts -optional as_user: boolean; -``` - -#### Description - -Pass `true` to act as the authed user with [`chat:write:user` scope](https://api.slack.com/scopes/chat:write:user). -Bot users in this context are considered authed users. If unused or `false`, the message will be acted upon with -[`chat:write:bot` scope](https://api.slack.com/scopes/chat:write:bot). - -#### Inherited from - -`AsUser.as_user` - -#### Defined in - -[packages/web-api/src/types/request/chat.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L35) - -*** - -### channel - -```ts -channel: string; -``` - -#### Description - -Channel ID for the message. - -#### Inherited from - -`ChannelAndTS.channel` - -#### Defined in - -[packages/web-api/src/types/request/chat.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L19) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### ts - -```ts -ts: string; -``` - -#### Description - -Timestamp of the message. - -#### Inherited from - -`ChannelAndTS.ts` - -#### Defined in - -[packages/web-api/src/types/request/chat.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L23) diff --git a/docs/content/reference/web-api/interfaces/ChatDeleteScheduledMessageArguments.md b/docs/content/reference/web-api/interfaces/ChatDeleteScheduledMessageArguments.md deleted file mode 100644 index 8cdcf657d..000000000 --- a/docs/content/reference/web-api/interfaces/ChatDeleteScheduledMessageArguments.md +++ /dev/null @@ -1,83 +0,0 @@ -# Interface: ChatDeleteScheduledMessageArguments - -## Extends - -- `Channel`.`AsUser`.`TokenOverridable` - -## Properties - -### as\_user? - -```ts -optional as_user: boolean; -``` - -#### Description - -Pass `true` to act as the authed user with [`chat:write:user` scope](https://api.slack.com/scopes/chat:write:user). -Bot users in this context are considered authed users. If unused or `false`, the message will be acted upon with -[`chat:write:bot` scope](https://api.slack.com/scopes/chat:write:bot). - -#### Inherited from - -`AsUser.as_user` - -#### Defined in - -[packages/web-api/src/types/request/chat.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L35) - -*** - -### channel - -```ts -channel: string; -``` - -#### Description - -Channel ID for the message. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/chat.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L19) - -*** - -### scheduled\_message\_id - -```ts -scheduled_message_id: string; -``` - -#### Description - -The `scheduled_message_id` returned from call to [`chat.scheduleMessage`](https://api.slack.com/methods/chat.scheduleMessage). - -#### Defined in - -[packages/web-api/src/types/request/chat.ts:151](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L151) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ChatGetPermalinkArguments.md b/docs/content/reference/web-api/interfaces/ChatGetPermalinkArguments.md deleted file mode 100644 index 854a782a2..000000000 --- a/docs/content/reference/web-api/interfaces/ChatGetPermalinkArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: ChatGetPermalinkArguments - -## Extends - -- `ChannelAndMessageTS`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -Channel ID for the message. - -#### Inherited from - -`ChannelAndMessageTS.channel` - -#### Defined in - -[packages/web-api/src/types/request/chat.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L19) - -*** - -### message\_ts - -```ts -message_ts: string; -``` - -#### Description - -Timestamp of the message. - -#### Inherited from - -`ChannelAndMessageTS.message_ts` - -#### Defined in - -[packages/web-api/src/types/request/chat.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L27) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ChatMeMessageArguments.md b/docs/content/reference/web-api/interfaces/ChatMeMessageArguments.md deleted file mode 100644 index 7929bb3fd..000000000 --- a/docs/content/reference/web-api/interfaces/ChatMeMessageArguments.md +++ /dev/null @@ -1,66 +0,0 @@ -# Interface: ChatMeMessageArguments - -## Extends - -- `ChannelAndText`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -Channel ID for the message. - -#### Inherited from - -`ChannelAndText.channel` - -#### Defined in - -[packages/web-api/src/types/request/chat.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L19) - -*** - -### text - -```ts -text: string; -``` - -#### Description - -Text of the message. If used in conjunction with `blocks` or `attachments`, `text` will be used -as fallback text for notifications only. - -#### Inherited from - -`ChannelAndText.text` - -#### Defined in - -[packages/web-api/src/types/request/chat.ts:53](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L53) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/Checkboxes.md b/docs/content/reference/web-api/interfaces/Checkboxes.md deleted file mode 100644 index dc88487b9..000000000 --- a/docs/content/reference/web-api/interfaces/Checkboxes.md +++ /dev/null @@ -1,130 +0,0 @@ -# Interface: Checkboxes - -## Description - -Allows users to choose multiple items from a list of options. - -## See - - - [Checkboxes element reference](https://api.slack.com/reference/block-kit/block-elements#checkboxes). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_options? - -```ts -optional initial_options: Option[]; -``` - -#### Description - -An array of [Option](../type-aliases/Option.md) objects that exactly matches one or more of the options within `options`. -These options will be selected when the checkbox group initially loads. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:59 - -*** - -### options - -```ts -options: Option[]; -``` - -#### Description - -An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options are allowed. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:63 - -*** - -### type - -```ts -type: "checkboxes"; -``` - -#### Description - -The type of element. In this case `type` is always `checkboxes`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:54 diff --git a/docs/content/reference/web-api/interfaces/CodedError.md b/docs/content/reference/web-api/interfaces/CodedError.md deleted file mode 100644 index db4248508..000000000 --- a/docs/content/reference/web-api/interfaces/CodedError.md +++ /dev/null @@ -1,126 +0,0 @@ -# Interface: CodedError - -All errors produced by this package adhere to this interface - -## Extends - -- `ErrnoException` - -## Extended by - -- [`WebAPIPlatformError`](WebAPIPlatformError.md) -- [`WebAPIRequestError`](WebAPIRequestError.md) -- [`WebAPIHTTPError`](WebAPIHTTPError.md) -- [`WebAPIRateLimitedError`](WebAPIRateLimitedError.md) - -## Properties - -### code - -```ts -code: ErrorCode; -``` - -#### Overrides - -`NodeJS.ErrnoException.code` - -#### Defined in - -[packages/web-api/src/errors.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L11) - -*** - -### errno? - -```ts -optional errno: number; -``` - -#### Inherited from - -`NodeJS.ErrnoException.errno` - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:268 - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -`NodeJS.ErrnoException.message` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -`NodeJS.ErrnoException.name` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### path? - -```ts -optional path: string; -``` - -#### Inherited from - -`NodeJS.ErrnoException.path` - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:270 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -`NodeJS.ErrnoException.stack` - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 - -*** - -### syscall? - -```ts -optional syscall: string; -``` - -#### Inherited from - -`NodeJS.ErrnoException.syscall` - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:271 diff --git a/docs/content/reference/web-api/interfaces/Confirm.md b/docs/content/reference/web-api/interfaces/Confirm.md deleted file mode 100644 index 631ddd51d..000000000 --- a/docs/content/reference/web-api/interfaces/Confirm.md +++ /dev/null @@ -1,104 +0,0 @@ -# Interface: ~~Confirm~~ - -## Deprecated - -[Confirm](Confirm.md) aliased to [ConfirmationDialog](ConfirmationDialog.md) in order to make the construct clearer -and line up terminology with api.slack.com. - -## Description - -Defines a dialog that adds a confirmation step to interactive elements. - -## See - -[Confirmation dialog object reference](https://api.slack.com/reference/block-kit/composition-objects#confirm). - -## Extended by - -- [`ConfirmationDialog`](ConfirmationDialog.md) - -## Properties - -### ~~confirm?~~ - -```ts -optional confirm: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that confirms the action. -Maximum length for the `text` in this field is 30 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:22 - -*** - -### ~~deny?~~ - -```ts -optional deny: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that cancels the action. -Maximum length for the `text` in this field is 30 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:27 - -*** - -### ~~style?~~ - -```ts -optional style: "danger" | "primary"; -``` - -#### Description - -Defines the color scheme applied to the `confirm` button. A value of `danger` will display the button -with a red background on desktop, or red text on mobile. A value of `primary` will display the button with a green -background on desktop, or blue text on mobile. If this field is not provided, the default value will be `primary`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:33 - -*** - -### ~~text~~ - -```ts -text: PlainTextElement | MrkdwnElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object that defines the explanatory text that appears in the confirm -dialog. Maximum length for the `text` in this field is 300 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:17 - -*** - -### ~~title?~~ - -```ts -optional title: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object that defines the dialog's title. -Maximum length for this field is 100 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:12 diff --git a/docs/content/reference/web-api/interfaces/Confirmable.md b/docs/content/reference/web-api/interfaces/Confirmable.md deleted file mode 100644 index f94c6cd16..000000000 --- a/docs/content/reference/web-api/interfaces/Confirmable.md +++ /dev/null @@ -1,39 +0,0 @@ -# Interface: Confirmable - -## Extended by - -- [`Button`](Button.md) -- [`Checkboxes`](Checkboxes.md) -- [`Datepicker`](Datepicker.md) -- [`DateTimepicker`](DateTimepicker.md) -- [`UsersSelect`](UsersSelect.md) -- [`MultiUsersSelect`](MultiUsersSelect.md) -- [`StaticSelect`](StaticSelect.md) -- [`MultiStaticSelect`](MultiStaticSelect.md) -- [`ConversationsSelect`](ConversationsSelect.md) -- [`MultiConversationsSelect`](MultiConversationsSelect.md) -- [`ChannelsSelect`](ChannelsSelect.md) -- [`MultiChannelsSelect`](MultiChannelsSelect.md) -- [`ExternalSelect`](ExternalSelect.md) -- [`MultiExternalSelect`](MultiExternalSelect.md) -- [`Overflow`](Overflow.md) -- [`RadioButtons`](RadioButtons.md) -- [`Timepicker`](Timepicker.md) -- [`WorkflowButton`](WorkflowButton.md) - -## Properties - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 diff --git a/docs/content/reference/web-api/interfaces/Confirmation.md b/docs/content/reference/web-api/interfaces/Confirmation.md deleted file mode 100644 index 13e22dfe0..000000000 --- a/docs/content/reference/web-api/interfaces/Confirmation.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: Confirmation - -## Properties - -### dismiss\_text? - -```ts -optional dismiss_text: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:162 - -*** - -### ok\_text? - -```ts -optional ok_text: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:163 - -*** - -### text - -```ts -text: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:164 - -*** - -### title? - -```ts -optional title: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:165 diff --git a/docs/content/reference/web-api/interfaces/ConfirmationDialog.md b/docs/content/reference/web-api/interfaces/ConfirmationDialog.md deleted file mode 100644 index e57f343ea..000000000 --- a/docs/content/reference/web-api/interfaces/ConfirmationDialog.md +++ /dev/null @@ -1,119 +0,0 @@ -# Interface: ConfirmationDialog - -## Description - -Defines a dialog that adds a confirmation step to interactive elements. - -## See - -[Confirmation dialog object reference](https://api.slack.com/reference/block-kit/composition-objects#confirm). - -## Extends - -- [`Confirm`](Confirm.md) - -## Properties - -### confirm? - -```ts -optional confirm: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that confirms the action. -Maximum length for the `text` in this field is 30 characters. - -#### Inherited from - -[`Confirm`](Confirm.md).[`confirm`](Confirm.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:22 - -*** - -### deny? - -```ts -optional deny: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object to define the text of the button that cancels the action. -Maximum length for the `text` in this field is 30 characters. - -#### Inherited from - -[`Confirm`](Confirm.md).[`deny`](Confirm.md#deny) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:27 - -*** - -### style? - -```ts -optional style: "danger" | "primary"; -``` - -#### Description - -Defines the color scheme applied to the `confirm` button. A value of `danger` will display the button -with a red background on desktop, or red text on mobile. A value of `primary` will display the button with a green -background on desktop, or blue text on mobile. If this field is not provided, the default value will be `primary`. - -#### Inherited from - -[`Confirm`](Confirm.md).[`style`](Confirm.md#style) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:33 - -*** - -### text - -```ts -text: PlainTextElement | MrkdwnElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object that defines the explanatory text that appears in the confirm -dialog. Maximum length for the `text` in this field is 300 characters. - -#### Inherited from - -[`Confirm`](Confirm.md).[`text`](Confirm.md#text) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:17 - -*** - -### title? - -```ts -optional title: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object that defines the dialog's title. -Maximum length for this field is 100 characters. - -#### Inherited from - -[`Confirm`](Confirm.md).[`title`](Confirm.md#title) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:12 diff --git a/docs/content/reference/web-api/interfaces/ContextBlock.md b/docs/content/reference/web-api/interfaces/ContextBlock.md deleted file mode 100644 index 5f3d031f2..000000000 --- a/docs/content/reference/web-api/interfaces/ContextBlock.md +++ /dev/null @@ -1,74 +0,0 @@ -# Interface: ContextBlock - -## Description - -Displays contextual info, which can include both images and text. - -## See - -[Context block reference](https://api.slack.com/reference/block-kit/blocks#context). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 - -*** - -### elements - -```ts -elements: (PlainTextElement | ImageElement | MrkdwnElement)[]; -``` - -#### Description - -An array of [ImageElement](../type-aliases/ImageElement.md), [PlainTextElement](PlainTextElement.md) or [MrkdwnElement](MrkdwnElement.md) objects. -Maximum number of items is 10. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:44 - -*** - -### type - -```ts -type: "context"; -``` - -#### Description - -The type of block. For a context block, `type` is always `context`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:39 diff --git a/docs/content/reference/web-api/interfaces/ConversationsApproveSharedInviteArguments.md b/docs/content/reference/web-api/interfaces/ConversationsApproveSharedInviteArguments.md deleted file mode 100644 index 9f68c9cfa..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsApproveSharedInviteArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: ConversationsApproveSharedInviteArguments - -## Extends - -- `InviteID`.`TargetTeam`.`TokenOverridable` - -## Properties - -### invite\_id - -```ts -invite_id: string; -``` - -#### Description - -ID of the invite. - -#### Inherited from - -`InviteID.invite_id` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L31) - -*** - -### target\_team? - -```ts -optional target_team: string; -``` - -#### Description - -The team or enterprise id of the other party. - -#### Inherited from - -`TargetTeam.target_team` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L69) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsArchiveArguments.md b/docs/content/reference/web-api/interfaces/ConversationsArchiveArguments.md deleted file mode 100644 index 522e256f2..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsArchiveArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: ConversationsArchiveArguments - -## Extends - -- `Channel`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md b/docs/content/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md deleted file mode 100644 index ef6809681..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md +++ /dev/null @@ -1,57 +0,0 @@ -# Interface: ConversationsCanvasesCreateArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -Channel ID of the channel to create a canvas in. - -#### Defined in - -[packages/web-api/src/types/request/canvas.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L88) - -*** - -### document\_content? - -```ts -optional document_content: DocumentContent; -``` - -#### Description - -Structure describing the type and contents of the Canvas being created. - -#### Defined in - -[packages/web-api/src/types/request/canvas.ts:90](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L90) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsCloseArguments.md b/docs/content/reference/web-api/interfaces/ConversationsCloseArguments.md deleted file mode 100644 index 2ae2a135a..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsCloseArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: ConversationsCloseArguments - -## Extends - -- `Channel`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsCreateArguments.md b/docs/content/reference/web-api/interfaces/ConversationsCreateArguments.md deleted file mode 100644 index 67af36b4e..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsCreateArguments.md +++ /dev/null @@ -1,81 +0,0 @@ -# Interface: ConversationsCreateArguments - -## Extends - -- `IsPrivate`.`TokenOverridable`.`OptionalTeamAssignable` - -## Properties - -### is\_private? - -```ts -optional is_private: boolean; -``` - -#### Description - -Whether the channel should be private. - -#### Inherited from - -`IsPrivate.is_private` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L35) - -*** - -### name - -```ts -name: string; -``` - -#### Description - -Name of the public or private channel to create. - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:74](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L74) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsDeclineSharedInviteArguments.md b/docs/content/reference/web-api/interfaces/ConversationsDeclineSharedInviteArguments.md deleted file mode 100644 index 97fe9ffd9..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsDeclineSharedInviteArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: ConversationsDeclineSharedInviteArguments - -## Extends - -- `InviteID`.`TargetTeam`.`TokenOverridable` - -## Properties - -### invite\_id - -```ts -invite_id: string; -``` - -#### Description - -ID of the invite. - -#### Inherited from - -`InviteID.invite_id` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L31) - -*** - -### target\_team? - -```ts -optional target_team: string; -``` - -#### Description - -The team or enterprise id of the other party. - -#### Inherited from - -`TargetTeam.target_team` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L69) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsExternalInvitePermissionsSetArguments.md b/docs/content/reference/web-api/interfaces/ConversationsExternalInvitePermissionsSetArguments.md deleted file mode 100644 index e8527552d..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsExternalInvitePermissionsSetArguments.md +++ /dev/null @@ -1,81 +0,0 @@ -# Interface: ConversationsExternalInvitePermissionsSetArguments - -## Extends - -- `Channel`.`Required`\<`TargetTeam`\>.`TokenOverridable` - -## Properties - -### action - -```ts -action: "downgrade" | "upgrade"; -``` - -#### Description - -The type of action be taken: `upgrade` or `downgrade`. - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L84) - -*** - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### target\_team - -```ts -target_team: string; -``` - -#### Description - -The team or enterprise id of the other party. - -#### Inherited from - -`Required.target_team` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L69) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsHistoryArguments.md b/docs/content/reference/web-api/interfaces/ConversationsHistoryArguments.md deleted file mode 100644 index 4933d5345..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsHistoryArguments.md +++ /dev/null @@ -1,173 +0,0 @@ -# Interface: ConversationsHistoryArguments - -## Extends - -- `Channel`.`IncludeAllMetadata`.`TokenOverridable`.`CursorPaginationEnabled`.`TimelinePaginationEnabled` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### include\_all\_metadata? - -```ts -optional include_all_metadata: boolean; -``` - -#### Description - -Return all metadata associated with messages. Defaults to `false`. - -#### Inherited from - -`IncludeAllMetadata.include_all_metadata` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L27) - -*** - -### inclusive? - -```ts -optional inclusive: boolean; -``` - -#### Description - -Include messages with `oldest` or `latest` timestamps in results. -Ignored unless either timestamp is specified. Defaults to `false`. - -#### Inherited from - -`TimelinePaginationEnabled.inclusive` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L28) - -*** - -### latest? - -```ts -optional latest: string; -``` - -#### Description - -Only messages before this Unix timestamp will be included in results. - -#### Inherited from - -`TimelinePaginationEnabled.latest` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L23) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### oldest? - -```ts -optional oldest: string; -``` - -#### Description - -Only messages after this Unix timestamp will be included in results. - -#### Inherited from - -`TimelinePaginationEnabled.oldest` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L21) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsInfoArguments.md b/docs/content/reference/web-api/interfaces/ConversationsInfoArguments.md deleted file mode 100644 index 208a9ef79..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsInfoArguments.md +++ /dev/null @@ -1,81 +0,0 @@ -# Interface: ConversationsInfoArguments - -## Extends - -- `Channel`.`TokenOverridable`.`LocaleAware` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### include\_locale? - -```ts -optional include_locale: boolean; -``` - -#### Description - -Set this to `true` to receive the locale with the response. - -#### Inherited from - -`LocaleAware.include_locale` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L51) - -*** - -### include\_num\_members? - -```ts -optional include_num_members: boolean; -``` - -#### Description - -Set to `true` to include the member count for the specified conversation. Defaults to `false`. - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L96) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsInviteArguments.md b/docs/content/reference/web-api/interfaces/ConversationsInviteArguments.md deleted file mode 100644 index 8047a1fef..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsInviteArguments.md +++ /dev/null @@ -1,82 +0,0 @@ -# Interface: ConversationsInviteArguments - -## Extends - -- `Channel`.`Users`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### force? - -```ts -optional force: boolean; -``` - -#### Description - -When set to `true` and multiple user IDs are provided, continue inviting the valid ones while -disregarding invalid IDs. Defaults to `false`. - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L105) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### users - -```ts -users: string; -``` - -#### Description - -A comma separated list of user IDs. Up to 1000 users may be listed. - -#### Inherited from - -`Users.users` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L48) diff --git a/docs/content/reference/web-api/interfaces/ConversationsJoinArguments.md b/docs/content/reference/web-api/interfaces/ConversationsJoinArguments.md deleted file mode 100644 index 3b4680d70..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsJoinArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: ConversationsJoinArguments - -## Extends - -- `Channel`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsKickArguments.md b/docs/content/reference/web-api/interfaces/ConversationsKickArguments.md deleted file mode 100644 index 53682ab74..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsKickArguments.md +++ /dev/null @@ -1,57 +0,0 @@ -# Interface: ConversationsKickArguments - -## Extends - -- `Channel`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user - -```ts -user: string; -``` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:119](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L119) diff --git a/docs/content/reference/web-api/interfaces/ConversationsLeaveArguments.md b/docs/content/reference/web-api/interfaces/ConversationsLeaveArguments.md deleted file mode 100644 index fb4510563..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsLeaveArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: ConversationsLeaveArguments - -## Extends - -- `Channel`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsMarkArguments.md b/docs/content/reference/web-api/interfaces/ConversationsMarkArguments.md deleted file mode 100644 index b856f5f27..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsMarkArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: ConversationsMarkArguments - -## Extends - -- `Message`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Message.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### ts - -```ts -ts: string; -``` - -#### Description - -Unique identifier of message. - -#### Inherited from - -`Message.ts` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L39) diff --git a/docs/content/reference/web-api/interfaces/ConversationsMembersArguments.md b/docs/content/reference/web-api/interfaces/ConversationsMembersArguments.md deleted file mode 100644 index b3e6fa2cd..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsMembersArguments.md +++ /dev/null @@ -1,92 +0,0 @@ -# Interface: ConversationsMembersArguments - -## Extends - -- `Channel`.`TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsRenameArguments.md b/docs/content/reference/web-api/interfaces/ConversationsRenameArguments.md deleted file mode 100644 index da841a7e8..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsRenameArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: ConversationsRenameArguments - -## Extends - -- `Channel`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### name - -```ts -name: string; -``` - -#### Description - -New name for conversation. - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:165](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L165) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsRepliesArguments.md b/docs/content/reference/web-api/interfaces/ConversationsRepliesArguments.md deleted file mode 100644 index 29c9c1890..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsRepliesArguments.md +++ /dev/null @@ -1,193 +0,0 @@ -# Interface: ConversationsRepliesArguments - -## Extends - -- `Message`.`IncludeAllMetadata`.`TokenOverridable`.`CursorPaginationEnabled`.`TimelinePaginationEnabled` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Message.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### include\_all\_metadata? - -```ts -optional include_all_metadata: boolean; -``` - -#### Description - -Return all metadata associated with messages. Defaults to `false`. - -#### Inherited from - -`IncludeAllMetadata.include_all_metadata` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L27) - -*** - -### inclusive? - -```ts -optional inclusive: boolean; -``` - -#### Description - -Include messages with `oldest` or `latest` timestamps in results. -Ignored unless either timestamp is specified. Defaults to `false`. - -#### Inherited from - -`TimelinePaginationEnabled.inclusive` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L28) - -*** - -### latest? - -```ts -optional latest: string; -``` - -#### Description - -Only messages before this Unix timestamp will be included in results. - -#### Inherited from - -`TimelinePaginationEnabled.latest` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L23) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### oldest? - -```ts -optional oldest: string; -``` - -#### Description - -Only messages after this Unix timestamp will be included in results. - -#### Inherited from - -`TimelinePaginationEnabled.oldest` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L21) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### ts - -```ts -ts: string; -``` - -#### Description - -Unique identifier of message. - -#### Inherited from - -`Message.ts` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L39) diff --git a/docs/content/reference/web-api/interfaces/ConversationsSelect.md b/docs/content/reference/web-api/interfaces/ConversationsSelect.md deleted file mode 100644 index 0b11255f2..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsSelect.md +++ /dev/null @@ -1,206 +0,0 @@ -# Interface: ConversationsSelect - -## Description - -This select menu will populate its options with a list of public and private channels, DMs, and MPIMs -visible to the current user in the active workspace. - -## See - - - [Select menu of conversations reference](https://api.slack.com/reference/block-kit/block-elements#conversations_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### default\_to\_current\_conversation? - -```ts -optional default_to_current_conversation: boolean; -``` - -#### Description - -Pre-populates the select menu with the conversation that the user was viewing when they opened the -modal, if available. Default is `false`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:301 - -*** - -### filter? - -```ts -optional filter: object; -``` - -#### exclude\_bot\_users? - -```ts -optional exclude_bot_users: boolean; -``` - -#### exclude\_external\_shared\_channels? - -```ts -optional exclude_external_shared_channels: boolean; -``` - -#### include? - -```ts -optional include: ("im" | "mpim" | "private" | "public")[]; -``` - -#### Description - -A filter object that reduces the list of available conversations using the specified criteria. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:305 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_conversation? - -```ts -optional initial_conversation: string; -``` - -#### Description - -The ID of any valid conversation to be pre-selected when the menu loads. If -`default_to_current_conversation` is also supplied, `initial_conversation` will take precedence. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:289 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### response\_url\_enabled? - -```ts -optional response_url_enabled: boolean; -``` - -#### Description - -When set to `true`, the [`view_submission` payload](https://api.slack.com/reference/interaction-payloads/views#view_submission) -from the menu's parent view will contain a `response_url`. This `response_url` can be used for -[message responses](https://api.slack.com/interactivity/handling#message_responses). The target conversation -for the message will be determined by the value of this select menu. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:296 - -*** - -### type - -```ts -type: "conversations_select"; -``` - -#### Description - -The type of element. In this case `type` is always `conversations_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:284 diff --git a/docs/content/reference/web-api/interfaces/ConversationsSetPurposeArguments.md b/docs/content/reference/web-api/interfaces/ConversationsSetPurposeArguments.md deleted file mode 100644 index 89b225f45..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsSetPurposeArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: ConversationsSetPurposeArguments - -## Extends - -- `Channel`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### purpose - -```ts -purpose: string; -``` - -#### Description - -A new, specialer purpose. - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:175](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L175) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/ConversationsSetTopicArguments.md b/docs/content/reference/web-api/interfaces/ConversationsSetTopicArguments.md deleted file mode 100644 index 9c52f719b..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsSetTopicArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: ConversationsSetTopicArguments - -## Extends - -- `Channel`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### topic - -```ts -topic: string; -``` - -#### Description - -The new topic string. Does not support formatting or linkification. - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:181](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L181) diff --git a/docs/content/reference/web-api/interfaces/ConversationsUnarchiveArguments.md b/docs/content/reference/web-api/interfaces/ConversationsUnarchiveArguments.md deleted file mode 100644 index 3eb9789e2..000000000 --- a/docs/content/reference/web-api/interfaces/ConversationsUnarchiveArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: ConversationsUnarchiveArguments - -## Extends - -- `Channel`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -ID of conversation. - -#### Inherited from - -`Channel.channel` - -#### Defined in - -[packages/web-api/src/types/request/conversations.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L14) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/DateTimepicker.md b/docs/content/reference/web-api/interfaces/DateTimepicker.md deleted file mode 100644 index 237349021..000000000 --- a/docs/content/reference/web-api/interfaces/DateTimepicker.md +++ /dev/null @@ -1,118 +0,0 @@ -# Interface: DateTimepicker - -## Description - -Allows users to select both a date and a time of day, formatted as a Unix timestamp. On desktop -clients, this time picker will take the form of a dropdown list and the date picker will take the form of a dropdown -calendar. Both options will have free-text entry for precise choices. On mobile clients, the time picker and date -picker will use native UIs. - -## See - - - [Datetime picker element reference](https://api.slack.com/reference/block-kit/block-elements#datetimepicker). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_date\_time? - -```ts -optional initial_date_time: number; -``` - -#### Description - -The initial date and time that is selected when the element is loaded, represented as a UNIX -timestamp in seconds. This should be in the format of 10 digits, for example `1628633820` represents the date and -time August 10th, 2021 at 03:17pm PST. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:99 - -*** - -### type - -```ts -type: "datetimepicker"; -``` - -#### Description - -The type of element. In this case `type` is always `datetimepicker`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:93 diff --git a/docs/content/reference/web-api/interfaces/Datepicker.md b/docs/content/reference/web-api/interfaces/Datepicker.md deleted file mode 100644 index d038f8b92..000000000 --- a/docs/content/reference/web-api/interfaces/Datepicker.md +++ /dev/null @@ -1,135 +0,0 @@ -# Interface: Datepicker - -## Description - -Allows users to select a date from a calendar style UI. - -## See - - - [Date picker element reference](https://api.slack.com/reference/block-kit/block-elements#datepicker). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_date? - -```ts -optional initial_date: string; -``` - -#### Description - -The initial date that is selected when the element is loaded. -This should be in the format `YYYY-MM-DD`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:79 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "datepicker"; -``` - -#### Description - -The type of element. In this case `type` is always `datepicker`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:74 diff --git a/docs/content/reference/web-api/interfaces/Dialog.md b/docs/content/reference/web-api/interfaces/Dialog.md deleted file mode 100644 index 59b959d3c..000000000 --- a/docs/content/reference/web-api/interfaces/Dialog.md +++ /dev/null @@ -1,79 +0,0 @@ -# Interface: ~~Dialog~~ - -Reusable shapes for argument values - -## Deprecated - -Dialogs are a deprecated surface in Slack. For more details on how to upgrade, check out our [Upgrading outmoded dialogs to modals guide](https://api.slack.com/block-kit/dialogs-to-modals). This will be removed in the next major version. - -## Properties - -### ~~callback\_id~~ - -```ts -callback_id: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:7 - -*** - -### ~~elements~~ - -```ts -elements: object[]; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:8 - -*** - -### ~~notify\_on\_cancel?~~ - -```ts -optional notify_on_cancel: boolean; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:29 - -*** - -### ~~state?~~ - -```ts -optional state: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:30 - -*** - -### ~~submit\_label?~~ - -```ts -optional submit_label: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:28 - -*** - -### ~~title~~ - -```ts -title: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:6 diff --git a/docs/content/reference/web-api/interfaces/DialogOpenArguments.md b/docs/content/reference/web-api/interfaces/DialogOpenArguments.md deleted file mode 100644 index 7d971437c..000000000 --- a/docs/content/reference/web-api/interfaces/DialogOpenArguments.md +++ /dev/null @@ -1,57 +0,0 @@ -# Interface: DialogOpenArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### dialog - -```ts -dialog: Dialog; -``` - -#### Description - -The dialog definition. - -#### Defined in - -[packages/web-api/src/types/request/dialog.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dialog.ts#L9) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### trigger\_id - -```ts -trigger_id: string; -``` - -#### Description - -Exchange a trigger to post to the user. - -#### Defined in - -[packages/web-api/src/types/request/dialog.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dialog.ts#L7) diff --git a/docs/content/reference/web-api/interfaces/DispatchActionConfig.md b/docs/content/reference/web-api/interfaces/DispatchActionConfig.md deleted file mode 100644 index 5ab3966ca..000000000 --- a/docs/content/reference/web-api/interfaces/DispatchActionConfig.md +++ /dev/null @@ -1,30 +0,0 @@ -# Interface: DispatchActionConfig - -## Description - -Defines when a [PlainTextElement](PlainTextElement.md) will return a [`block_actions` interaction payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -## See - -[`block_actions` interaction payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -## Properties - -### trigger\_actions\_on? - -```ts -optional trigger_actions_on: ("on_enter_pressed" | "on_character_entered")[]; -``` - -#### Description - -An array of interaction types that you would like to receive a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions) for. Should be -one or both of: - `on_enter_pressed` — payload is dispatched when user presses the enter key while the input is in focus. Hint - text will appear underneath the input explaining to the user to press enter to submit. - `on_character_entered` — payload is dispatched when a character is entered (or removed) in the input. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:54 diff --git a/docs/content/reference/web-api/interfaces/Dispatchable.md b/docs/content/reference/web-api/interfaces/Dispatchable.md deleted file mode 100644 index 7cec6ccb0..000000000 --- a/docs/content/reference/web-api/interfaces/Dispatchable.md +++ /dev/null @@ -1,26 +0,0 @@ -# Interface: Dispatchable - -## Extended by - -- [`EmailInput`](EmailInput.md) -- [`NumberInput`](NumberInput.md) -- [`PlainTextInput`](PlainTextInput.md) -- [`URLInput`](URLInput.md) -- [`RichTextInput`](RichTextInput.md) - -## Properties - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 diff --git a/docs/content/reference/web-api/interfaces/DividerBlock.md b/docs/content/reference/web-api/interfaces/DividerBlock.md deleted file mode 100644 index cb8b19461..000000000 --- a/docs/content/reference/web-api/interfaces/DividerBlock.md +++ /dev/null @@ -1,58 +0,0 @@ -# Interface: DividerBlock - -## Description - -Visually separates pieces of info inside of a message. A content divider, like an `
`, to split up -different blocks inside of a message. The divider block is nice and neat, requiring only a `type`. - -## See - -[Divider block reference](https://api.slack.com/reference/block-kit/blocks#divider). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 - -*** - -### type - -```ts -type: "divider"; -``` - -#### Description - -The type of block. For a divider block, `type` is always `divider`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:55 diff --git a/docs/content/reference/web-api/interfaces/DndSetSnoozeArguments.md b/docs/content/reference/web-api/interfaces/DndSetSnoozeArguments.md deleted file mode 100644 index dd2bac43d..000000000 --- a/docs/content/reference/web-api/interfaces/DndSetSnoozeArguments.md +++ /dev/null @@ -1,41 +0,0 @@ -# Interface: DndSetSnoozeArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### num\_minutes - -```ts -num_minutes: number; -``` - -#### Description - -Number of minutes, from now, to snooze until. - -#### Defined in - -[packages/web-api/src/types/request/dnd.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dnd.ts#L16) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/DndTeamInfoArguments.md b/docs/content/reference/web-api/interfaces/DndTeamInfoArguments.md deleted file mode 100644 index aee528846..000000000 --- a/docs/content/reference/web-api/interfaces/DndTeamInfoArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: DndTeamInfoArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable` - -## Properties - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### users - -```ts -users: string; -``` - -#### Description - -Comma-separated list of users to fetch Do Not Disturb status for. - -#### Defined in - -[packages/web-api/src/types/request/dnd.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dnd.ts#L21) diff --git a/docs/content/reference/web-api/interfaces/EmailInput.md b/docs/content/reference/web-api/interfaces/EmailInput.md deleted file mode 100644 index 520c3a2dd..000000000 --- a/docs/content/reference/web-api/interfaces/EmailInput.md +++ /dev/null @@ -1,134 +0,0 @@ -# Interface: EmailInput - -## Description - -Allows user to enter an email into a single-line field. - -## See - - - [Email input element reference](https://api.slack.com/reference/block-kit/block-elements#email). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Inherited from - -[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_value? - -```ts -optional initial_value: string; -``` - -#### Description - -The initial value in the email input when it is loaded. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:114 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "email_text_input"; -``` - -#### Description - -The type of element. In this case `type` is always `email_text_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:110 diff --git a/docs/content/reference/web-api/interfaces/ExternalSelect.md b/docs/content/reference/web-api/interfaces/ExternalSelect.md deleted file mode 100644 index 956f04a8a..000000000 --- a/docs/content/reference/web-api/interfaces/ExternalSelect.md +++ /dev/null @@ -1,153 +0,0 @@ -# Interface: ExternalSelect - -## Description - -This select menu will load its options from an external data source, allowing for a dynamic list of -options. - -## See - - - [Select menu of external data source reference](https://api.slack.com/reference/block-kit/block-elements#external_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_option? - -```ts -optional initial_option: PlainTextOption; -``` - -#### Description - -A single option to be selected when the menu initially loads. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:402 - -*** - -### min\_query\_length? - -```ts -optional min_query_length: number; -``` - -#### Description - -When the typeahead field is used, a request will be sent on every character change. If you prefer -fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number -of typed characters required before dispatch. The default value is `3`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:408 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "external_select"; -``` - -#### Description - -The type of element. In this case `type` is always `external_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:398 diff --git a/docs/content/reference/web-api/interfaces/FileBlock.md b/docs/content/reference/web-api/interfaces/FileBlock.md deleted file mode 100644 index 5845ba358..000000000 --- a/docs/content/reference/web-api/interfaces/FileBlock.md +++ /dev/null @@ -1,92 +0,0 @@ -# Interface: FileBlock - -## Description - -Displays a [remote file](https://api.slack.com/messaging/files/remote). You can't add this block to -app surfaces directly, but it will show up when [retrieving messages](https://api.slack.com/messaging/retrieving) -that contain remote files. If you want to add remote files to messages, -[follow our guide](https://api.slack.com/messaging/files/remote). - -## See - -[File block reference](https://api.slack.com/reference/block-kit/blocks#file). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 - -*** - -### external\_id - -```ts -external_id: string; -``` - -#### Description - -The external unique ID for this file. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:76 - -*** - -### source - -```ts -source: string; -``` - -#### Description - -At the moment, source will always be `remote` for a remote file. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:72 - -*** - -### type - -```ts -type: "file"; -``` - -#### Description - -The type of block. For a file block, `type` is always `file`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:68 diff --git a/docs/content/reference/web-api/interfaces/FileInput.md b/docs/content/reference/web-api/interfaces/FileInput.md deleted file mode 100644 index 733c19c3c..000000000 --- a/docs/content/reference/web-api/interfaces/FileInput.md +++ /dev/null @@ -1,89 +0,0 @@ -# Interface: FileInput - -## Description - -Allows user to upload files. In order to use the `file_input` element within your app, -your app must have the `files:read` scope. - -## See - -[File input element reference](https://api.slack.com/reference/block-kit/block-elements#file_input). - -## Extends - -- [`Actionable`](Actionable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### filetypes? - -```ts -optional filetypes: string[]; -``` - -#### Description - -An array of valid [file extensions](https://api.slack.com/types/file#types) that will be accepted -for this element. All file extensions will be accepted if `filetypes` is not specified. This validation is provided -for convenience only, and you should perform your own file type validation based on what you expect to receive. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:131 - -*** - -### max\_files? - -```ts -optional max_files: number; -``` - -#### Description - -Maximum number of files that can be uploaded for this `file_input` element. Minimum of `1`, maximum of -`10`. Defaults to `10` if not specified. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:136 - -*** - -### type - -```ts -type: "file_input"; -``` - -#### Description - -The type of element. In this case `type` is always `file_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:125 diff --git a/docs/content/reference/web-api/interfaces/FilesCommentsDeleteArguments.md b/docs/content/reference/web-api/interfaces/FilesCommentsDeleteArguments.md deleted file mode 100644 index 81bb3f5f2..000000000 --- a/docs/content/reference/web-api/interfaces/FilesCommentsDeleteArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: FilesCommentsDeleteArguments - -## Extends - -- `FileArgument`.`TokenOverridable` - -## Properties - -### file - -```ts -file: string; -``` - -#### Description - -Encoded file ID. - -#### Inherited from - -`FileArgument.file` - -#### Defined in - -[packages/web-api/src/types/request/files.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L13) - -*** - -### id - -```ts -id: string; -``` - -#### Description - -The ID of the comment to delete. - -#### Defined in - -[packages/web-api/src/types/request/files.ts:174](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L174) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesDeleteArguments.md b/docs/content/reference/web-api/interfaces/FilesDeleteArguments.md deleted file mode 100644 index 663595568..000000000 --- a/docs/content/reference/web-api/interfaces/FilesDeleteArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: FilesDeleteArguments - -## Extends - -- `FileArgument`.`TokenOverridable` - -## Properties - -### file - -```ts -file: string; -``` - -#### Description - -Encoded file ID. - -#### Inherited from - -`FileArgument.file` - -#### Defined in - -[packages/web-api/src/types/request/files.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesGetUploadURLExternalArguments.md b/docs/content/reference/web-api/interfaces/FilesGetUploadURLExternalArguments.md deleted file mode 100644 index c429befbd..000000000 --- a/docs/content/reference/web-api/interfaces/FilesGetUploadURLExternalArguments.md +++ /dev/null @@ -1,89 +0,0 @@ -# Interface: FilesGetUploadURLExternalArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### alt\_text? - -```ts -optional alt_text: string; -``` - -#### Description - -Description of image for screen-reader. - -#### Defined in - -[packages/web-api/src/types/request/files.ts:82](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L82) - -*** - -### filename - -```ts -filename: string; -``` - -#### Description - -Name of the file being uploaded. - -#### Defined in - -[packages/web-api/src/types/request/files.ts:78](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L78) - -*** - -### length - -```ts -length: number; -``` - -#### Description - -Size in bytes of the file being uploaded. - -#### Defined in - -[packages/web-api/src/types/request/files.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L80) - -*** - -### snippet\_type? - -```ts -optional snippet_type: string; -``` - -#### Description - -Syntax type of the snippet being uploaded. E.g. `python`. - -#### Defined in - -[packages/web-api/src/types/request/files.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L84) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesInfoArguments.md b/docs/content/reference/web-api/interfaces/FilesInfoArguments.md deleted file mode 100644 index b114b30d3..000000000 --- a/docs/content/reference/web-api/interfaces/FilesInfoArguments.md +++ /dev/null @@ -1,132 +0,0 @@ -# Interface: FilesInfoArguments - -## Extends - -- `FileArgument`.`TokenOverridable`.`CursorPaginationEnabled`.`TraditionalPagingEnabled` - -## Properties - -### count? - -```ts -optional count: number; -``` - -#### Description - -Number of items to return per page. Defaults to `20` - -#### Inherited from - -`TraditionalPagingEnabled.count` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) - -*** - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### file - -```ts -file: string; -``` - -#### Description - -Encoded file ID. - -#### Inherited from - -`FileArgument.file` - -#### Defined in - -[packages/web-api/src/types/request/files.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L13) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### page? - -```ts -optional page: number; -``` - -#### Description - -Page number of results to return. Defaults to `1`. - -#### Inherited from - -`TraditionalPagingEnabled.page` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesListArguments.md b/docs/content/reference/web-api/interfaces/FilesListArguments.md deleted file mode 100644 index 77c97d7d9..000000000 --- a/docs/content/reference/web-api/interfaces/FilesListArguments.md +++ /dev/null @@ -1,184 +0,0 @@ -# Interface: FilesListArguments - -## Extends - -- `TokenOverridable`.`TraditionalPagingEnabled`.`OptionalTeamAssignable` - -## Properties - -### channel? - -```ts -optional channel: string; -``` - -#### Description - -Filter files appearing in a specific channel, indicated by its ID. - -#### Defined in - -[packages/web-api/src/types/request/files.ts:92](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L92) - -*** - -### count? - -```ts -optional count: number; -``` - -#### Description - -Number of items to return per page. Defaults to `20` - -#### Inherited from - -`TraditionalPagingEnabled.count` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) - -*** - -### page? - -```ts -optional page: number; -``` - -#### Description - -Page number of results to return. Defaults to `1`. - -#### Inherited from - -`TraditionalPagingEnabled.page` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) - -*** - -### show\_files\_hidden\_by\_limit? - -```ts -optional show_files_hidden_by_limit: boolean; -``` - -#### Description - -Show truncated file info for files hidden due to being too old, and the team who owns the file -being over the file limit. - -#### Defined in - -[packages/web-api/src/types/request/files.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L97) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### ts\_from? - -```ts -optional ts_from: string; -``` - -#### Description - -Filter files created after this timestamp (inclusive). - -#### Defined in - -[packages/web-api/src/types/request/files.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L99) - -*** - -### ts\_to? - -```ts -optional ts_to: string; -``` - -#### Description - -Filter files created before this timestamp (inclusive). - -#### Defined in - -[packages/web-api/src/types/request/files.ts:101](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L101) - -*** - -### types? - -```ts -optional types: string; -``` - -#### Description - -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`. - -#### Defined in - -[packages/web-api/src/types/request/files.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L107) - -*** - -### user? - -```ts -optional user: string; -``` - -#### Description - -Filter files created by a single user. - -#### Defined in - -[packages/web-api/src/types/request/files.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L109) diff --git a/docs/content/reference/web-api/interfaces/FilesRemoteAddArguments.md b/docs/content/reference/web-api/interfaces/FilesRemoteAddArguments.md deleted file mode 100644 index 9a7c66e5b..000000000 --- a/docs/content/reference/web-api/interfaces/FilesRemoteAddArguments.md +++ /dev/null @@ -1,150 +0,0 @@ -# Interface: FilesRemoteAddArguments - -## Extends - -- `SharedFile`.`FileType`.`ExternalIDArgument`.`TokenOverridable` - -## Properties - -### external\_id - -```ts -external_id: string; -``` - -#### Description - -Creator defined GUID for the file. - -#### Inherited from - -`ExternalIDArgument.external_id` - -#### Defined in - -[packages/web-api/src/types/request/files.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L17) - -*** - -### external\_url - -```ts -external_url: string; -``` - -#### Description - -URL of the remote file. - -#### Inherited from - -`SharedFile.external_url` - -#### Defined in - -[packages/web-api/src/types/request/files.ts:180](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L180) - -*** - -### filetype? - -```ts -optional filetype: string; -``` - -#### Description - -A file type identifier. - -#### See - -[File types](https://api.slack.com/types/file#file_types) for a complete list of supported file types. - -#### Inherited from - -`FileType.filetype` - -#### Defined in - -[packages/web-api/src/types/request/files.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L31) - -*** - -### indexable\_file\_contents? - -```ts -optional indexable_file_contents: Buffer | Stream; -``` - -#### Description - -A text file (txt, pdf, doc, etc.) containing textual search terms that are used to improve discovery -of the remote file. - -#### Inherited from - -`SharedFile.indexable_file_contents` - -#### Defined in - -[packages/web-api/src/types/request/files.ts:187](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L187) - -*** - -### preview\_image? - -```ts -optional preview_image: Buffer | Stream; -``` - -#### Description - -Preview of the document. - -#### Inherited from - -`SharedFile.preview_image` - -#### Defined in - -[packages/web-api/src/types/request/files.ts:182](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L182) - -*** - -### title - -```ts -title: string; -``` - -#### Description - -Title of the file being shared. - -#### Inherited from - -`SharedFile.title` - -#### Defined in - -[packages/web-api/src/types/request/files.ts:178](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L178) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesRemoteListArguments.md b/docs/content/reference/web-api/interfaces/FilesRemoteListArguments.md deleted file mode 100644 index 864e1ca12..000000000 --- a/docs/content/reference/web-api/interfaces/FilesRemoteListArguments.md +++ /dev/null @@ -1,120 +0,0 @@ -# Interface: FilesRemoteListArguments - -## Extends - -- `TokenOverridable`.`CursorPaginationEnabled` - -## Properties - -### channel? - -```ts -optional channel: string; -``` - -#### Description - -Filter files appearing in a specific channel, indicated by its ID. - -#### Defined in - -[packages/web-api/src/types/request/files.ts:199](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L199) - -*** - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### ts\_from? - -```ts -optional ts_from: string; -``` - -#### Description - -Filter files created after this timestamp (inclusive). - -#### Defined in - -[packages/web-api/src/types/request/files.ts:201](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L201) - -*** - -### ts\_to? - -```ts -optional ts_to: string; -``` - -#### Description - -Filter files created before this timestamp (inclusive). - -#### Defined in - -[packages/web-api/src/types/request/files.ts:203](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L203) diff --git a/docs/content/reference/web-api/interfaces/FilesRevokePublicURLArguments.md b/docs/content/reference/web-api/interfaces/FilesRevokePublicURLArguments.md deleted file mode 100644 index 920f0d9f8..000000000 --- a/docs/content/reference/web-api/interfaces/FilesRevokePublicURLArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: FilesRevokePublicURLArguments - -## Extends - -- `FileArgument`.`TokenOverridable` - -## Properties - -### file - -```ts -file: string; -``` - -#### Description - -Encoded file ID. - -#### Inherited from - -`FileArgument.file` - -#### Defined in - -[packages/web-api/src/types/request/files.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FilesSharedPublicURLArguments.md b/docs/content/reference/web-api/interfaces/FilesSharedPublicURLArguments.md deleted file mode 100644 index f046347d7..000000000 --- a/docs/content/reference/web-api/interfaces/FilesSharedPublicURLArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: FilesSharedPublicURLArguments - -## Extends - -- `FileArgument`.`TokenOverridable` - -## Properties - -### file - -```ts -file: string; -``` - -#### Description - -Encoded file ID. - -#### Inherited from - -`FileArgument.file` - -#### Defined in - -[packages/web-api/src/types/request/files.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L13) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/Focusable.md b/docs/content/reference/web-api/interfaces/Focusable.md deleted file mode 100644 index 6685356d6..000000000 --- a/docs/content/reference/web-api/interfaces/Focusable.md +++ /dev/null @@ -1,42 +0,0 @@ -# Interface: Focusable - -## Extended by - -- [`Checkboxes`](Checkboxes.md) -- [`Datepicker`](Datepicker.md) -- [`DateTimepicker`](DateTimepicker.md) -- [`EmailInput`](EmailInput.md) -- [`UsersSelect`](UsersSelect.md) -- [`MultiUsersSelect`](MultiUsersSelect.md) -- [`StaticSelect`](StaticSelect.md) -- [`MultiStaticSelect`](MultiStaticSelect.md) -- [`ConversationsSelect`](ConversationsSelect.md) -- [`MultiConversationsSelect`](MultiConversationsSelect.md) -- [`ChannelsSelect`](ChannelsSelect.md) -- [`MultiChannelsSelect`](MultiChannelsSelect.md) -- [`ExternalSelect`](ExternalSelect.md) -- [`MultiExternalSelect`](MultiExternalSelect.md) -- [`NumberInput`](NumberInput.md) -- [`PlainTextInput`](PlainTextInput.md) -- [`RadioButtons`](RadioButtons.md) -- [`Timepicker`](Timepicker.md) -- [`URLInput`](URLInput.md) -- [`RichTextInput`](RichTextInput.md) - -## Properties - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 diff --git a/docs/content/reference/web-api/interfaces/FunctionsCompleteErrorArguments.md b/docs/content/reference/web-api/interfaces/FunctionsCompleteErrorArguments.md deleted file mode 100644 index 13c9c1642..000000000 --- a/docs/content/reference/web-api/interfaces/FunctionsCompleteErrorArguments.md +++ /dev/null @@ -1,53 +0,0 @@ -# Interface: FunctionsCompleteErrorArguments - -## Extends - -- `ExecutionID`.`TokenOverridable` - -## Properties - -### error - -```ts -error: string; -``` - -#### Defined in - -[packages/web-api/src/types/request/functions.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/functions.ts#L9) - -*** - -### function\_execution\_id - -```ts -function_execution_id: string; -``` - -#### Inherited from - -`ExecutionID.function_execution_id` - -#### Defined in - -[packages/web-api/src/types/request/functions.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/functions.ts#L4) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/FunctionsCompleteSuccessArguments.md b/docs/content/reference/web-api/interfaces/FunctionsCompleteSuccessArguments.md deleted file mode 100644 index 6e994ef36..000000000 --- a/docs/content/reference/web-api/interfaces/FunctionsCompleteSuccessArguments.md +++ /dev/null @@ -1,53 +0,0 @@ -# Interface: FunctionsCompleteSuccessArguments - -## Extends - -- `ExecutionID`.`TokenOverridable` - -## Properties - -### function\_execution\_id - -```ts -function_execution_id: string; -``` - -#### Inherited from - -`ExecutionID.function_execution_id` - -#### Defined in - -[packages/web-api/src/types/request/functions.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/functions.ts#L4) - -*** - -### outputs - -```ts -outputs: Record; -``` - -#### Defined in - -[packages/web-api/src/types/request/functions.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/functions.ts#L14) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/HeaderBlock.md b/docs/content/reference/web-api/interfaces/HeaderBlock.md deleted file mode 100644 index ab761661a..000000000 --- a/docs/content/reference/web-api/interfaces/HeaderBlock.md +++ /dev/null @@ -1,75 +0,0 @@ -# Interface: HeaderBlock - -## Description - -Displays a larger-sized text block. A `header` is a plain-text block that displays in a larger, bold -font. Use it to delineate between different groups of content in your app's surfaces. - -## See - -[Header block reference](https://api.slack.com/reference/block-kit/blocks#header). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 - -*** - -### text - -```ts -text: PlainTextElement; -``` - -#### Description - -The text for the block, in the form of a [PlainTextElement](PlainTextElement.md). -Maximum length for the text in this field is 150 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:92 - -*** - -### type - -```ts -type: "header"; -``` - -#### Description - -The type of block. For a header block, `type` is always `header`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:87 diff --git a/docs/content/reference/web-api/interfaces/HomeView.md b/docs/content/reference/web-api/interfaces/HomeView.md deleted file mode 100644 index 6dcc9b93b..000000000 --- a/docs/content/reference/web-api/interfaces/HomeView.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: HomeView - -## Properties - -### blocks - -```ts -blocks: (Block | KnownBlock)[]; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:5 - -*** - -### callback\_id? - -```ts -optional callback_id: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:7 - -*** - -### external\_id? - -```ts -optional external_id: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:8 - -*** - -### private\_metadata? - -```ts -optional private_metadata: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:6 - -*** - -### type - -```ts -type: "home"; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:4 diff --git a/docs/content/reference/web-api/interfaces/InputBlock.md b/docs/content/reference/web-api/interfaces/InputBlock.md deleted file mode 100644 index 938ef5a89..000000000 --- a/docs/content/reference/web-api/interfaces/InputBlock.md +++ /dev/null @@ -1,156 +0,0 @@ -# Interface: InputBlock - -## Description - -Collects information from users via block elements. - -## See - - - [Input block reference](https://api.slack.com/reference/block-kit/blocks#input). - - [Collecting input in modals guide](https://api.slack.com/surfaces/modals#gathering_input). - - [Collecting input in Home tabs guide](https://api.slack.com/surfaces/app-home#gathering_input). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 - -*** - -### dispatch\_action? - -```ts -optional dispatch_action: boolean; -``` - -#### Description - -A boolean that indicates whether or not the use of elements in this block should dispatch a -[block_actions payload](https://api.slack.com/reference/interaction-payloads/block-actions). Defaults to `false`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:148 - -*** - -### element - -```ts -element: - | Checkboxes - | Datepicker - | DateTimepicker - | MultiSelect - | RadioButtons - | Select - | Timepicker - | RichTextInput - | PlainTextInput - | URLInput - | EmailInput - | NumberInput - | FileInput; -``` - -#### Description - -A block element. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:143 - -*** - -### hint? - -```ts -optional hint: PlainTextElement; -``` - -#### Description - -An optional hint that appears below an input element in a lighter grey. It must be a -[object](PlainTextElement.md). Maximum length for the `text` in this field is 2000 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:134 - -*** - -### label - -```ts -label: PlainTextElement; -``` - -#### Description - -A label that appears above an input element in the form of a [PlainTextElement](PlainTextElement.md) object. -Maximum length for the text in this field is 2000 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:129 - -*** - -### optional? - -```ts -optional optional: boolean; -``` - -#### Description - -A boolean that indicates whether the input element may be empty when a user submits the modal. -Defaults to `false`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:139 - -*** - -### type - -```ts -type: "input"; -``` - -#### Description - -The type of block. For an input block, `type` is always `input`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:124 diff --git a/docs/content/reference/web-api/interfaces/LinkUnfurls.md b/docs/content/reference/web-api/interfaces/LinkUnfurls.md deleted file mode 100644 index d041ae784..000000000 --- a/docs/content/reference/web-api/interfaces/LinkUnfurls.md +++ /dev/null @@ -1,5 +0,0 @@ -# Interface: LinkUnfurls - -## Indexable - - \[`linkUrl`: `string`\]: [`MessageAttachment`](MessageAttachment.md) diff --git a/docs/content/reference/web-api/interfaces/Logger.md b/docs/content/reference/web-api/interfaces/Logger.md deleted file mode 100644 index 56561ef1e..000000000 --- a/docs/content/reference/web-api/interfaces/Logger.md +++ /dev/null @@ -1,167 +0,0 @@ -# Interface: Logger - -Interface for objects where objects in this package's logs can be sent (can be used as `logger` option). - -## Methods - -### debug() - -```ts -debug(...msg): void -``` - -Output debug message - -#### Parameters - -• ...**msg**: `any`[] - -any data to log - -#### Returns - -`void` - -#### Defined in - -packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:18 - -*** - -### error() - -```ts -error(...msg): void -``` - -Output error message - -#### Parameters - -• ...**msg**: `any`[] - -any data to log - -#### Returns - -`void` - -#### Defined in - -packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:33 - -*** - -### getLevel() - -```ts -getLevel(): LogLevel -``` - -Return the current LogLevel. - -#### Returns - -[`LogLevel`](../enumerations/LogLevel.md) - -#### Defined in - -packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:43 - -*** - -### info() - -```ts -info(...msg): void -``` - -Output info message - -#### Parameters - -• ...**msg**: `any`[] - -any data to log - -#### Returns - -`void` - -#### Defined in - -packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:23 - -*** - -### setLevel() - -```ts -setLevel(level): void -``` - -This disables all logging below the given level, so that after a log.setLevel("warn") call log.warn("something") -or log.error("something") will output messages, but log.info("something") will not. - -#### Parameters - -• **level**: [`LogLevel`](../enumerations/LogLevel.md) - -as a string, like 'error' (case-insensitive) - -#### Returns - -`void` - -#### Defined in - -packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:39 - -*** - -### setName() - -```ts -setName(name): void -``` - -This allows the instance to be named so that they can easily be filtered when many loggers are sending output -to the same destination. - -#### Parameters - -• **name**: `string` - -as a string, will be output with every log after the level - -#### Returns - -`void` - -#### Defined in - -packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:49 - -*** - -### warn() - -```ts -warn(...msg): void -``` - -Output warn message - -#### Parameters - -• ...**msg**: `any`[] - -any data to log - -#### Returns - -`void` - -#### Defined in - -packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:28 diff --git a/docs/content/reference/web-api/interfaces/MessageAttachment.md b/docs/content/reference/web-api/interfaces/MessageAttachment.md deleted file mode 100644 index de071da3f..000000000 --- a/docs/content/reference/web-api/interfaces/MessageAttachment.md +++ /dev/null @@ -1,401 +0,0 @@ -# Interface: MessageAttachment - -Add [secondary attachments](https://api.slack.com/messaging/composing/layouts#attachments) to your messages in Slack. -Message attachments are considered a legacy part of messaging functionality. They are not deprecated per se, but they may change in the future, in ways that reduce their visibility or utility. We recommend moving to Block Kit instead. Read more about [when to use message attachments](https://api.slack.com/messaging/composing/layouts#when-to-use-attachments). - -## See - -[Secondary message attachments reference documentation](https://api.slack.com/reference/messaging/attachments) - -## Properties - -### actions? - -```ts -optional actions: AttachmentAction[]; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:97 - -*** - -### app\_id? - -```ts -optional app_id: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:107 - -*** - -### app\_unfurl\_url? - -```ts -optional app_unfurl_url: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:105 - -*** - -### author\_icon? - -```ts -optional author_icon: string; -``` - -#### Description - -A valid URL that displays a small 16px by 16px image to the left of the `author_name` text. -Will only work if `author_name` is present. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:41 - -*** - -### author\_link? - -```ts -optional author_link: string; -``` - -#### Description - -A valid URL that will hyperlink the `author_name` text. Will only work if `author_name` is present. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:36 - -*** - -### author\_name? - -```ts -optional author_name: string; -``` - -#### Description - -Small text used to display the author's name. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:32 - -*** - -### author\_subname? - -```ts -optional author_subname: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:42 - -*** - -### blocks? - -```ts -optional blocks: (Block | KnownBlock)[]; -``` - -#### Description - -An array of [layout blocks](../type-aliases/KnownBlock.md) in the same format -[as described in the building blocks guide](https://api.slack.com/block-kit/building). - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:13 - -*** - -### bot\_id? - -```ts -optional bot_id: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:108 - -*** - -### callback\_id? - -```ts -optional callback_id: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:98 - -*** - -### color? - -```ts -optional color: string; -``` - -#### Description - -Changes the color of the border on the left side of this attachment from the default gray. Can either -be one of `good` (green), `warning` (yellow), `danger` (red), or any hex color code (eg. `#439FE0`) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:23 - -*** - -### fallback? - -```ts -optional fallback: string; -``` - -#### Description - -A plain text summary of the attachment used in clients that -don't show formatted text (e.g. mobile notifications). - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:18 - -*** - -### fields? - -```ts -optional fields: MessageAttachmentField[]; -``` - -#### Description - -An array of [MessageAttachmentField](MessageAttachmentField.md) that get displayed in a table-like way -(see [this example](https://api.slack.com/reference/messaging/attachments#example)). -For best results, include no more than 2-3 field objects. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:63 - -*** - -### footer? - -```ts -optional footer: string; -``` - -#### Description - -Some brief text to help contextualize and identify an attachment. Limited to 300 characters, -and may be truncated further when displayed to users in environments with limited screen real estate. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:83 - -*** - -### footer\_icon? - -```ts -optional footer_icon: string; -``` - -#### Description - -A valid URL to an image file that will be displayed beside the `footer` text. -Will only work if `footer` is present. We'll render what you provide at 16px by 16px. -It's best to use an image that is similarly sized. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:89 - -*** - -### image\_url? - -```ts -optional image_url: string; -``` - -#### Description - -A valid URL to an image file that will be displayed at the bottom of the attachment. -We support GIF, JPEG, PNG, and BMP formats. -Large images will be resized to a maximum width of 360px or a maximum height of 500px, while still -maintaining the original aspect ratio. Cannot be used with `thumb_url`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:70 - -*** - -### is\_app\_unfurl? - -```ts -optional is_app_unfurl: boolean; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:106 - -*** - -### mrkdwn\_in? - -```ts -optional mrkdwn_in: ("text" | "pretext" | "fields")[]; -``` - -#### Description - -Field names that should be [formatted by `mrkdwn` syntax](https://api.slack.com/reference/surfaces/formatting#basics). -The fields that can be formatted in this way include the names of the `fields` property, or -the `text` or `pretext` properties. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:104 - -*** - -### pretext? - -```ts -optional pretext: string; -``` - -#### Description - -Text that appears above the message attachment block. It can be formatted as plain text, -or with [`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by including it in the `mrkdwn_in` field. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:28 - -*** - -### preview? - -```ts -optional preview: MessageAttachmentPreview; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:109 - -*** - -### text? - -```ts -optional text: string; -``` - -#### Description - -The main body text of the attachment. It can be formatted as plain text, or with -[`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by including it in the `mrkdwn_in` field. -The content will automatically collapse if it contains 700+ characters or 5+ line breaks, and will display -a "Show more..." link to expand the content. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:57 - -*** - -### thumb\_url? - -```ts -optional thumb_url: string; -``` - -#### Description - -A valid URL to an image file that will be displayed as a thumbnail on the right side of -a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP. -The thumbnail's longest dimension will be scaled down to 75px while maintaining the aspect ratio of the image. -The file size of the image must also be less than 500 KB. -For best results, please use images that are already 75px by 75px. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:78 - -*** - -### title? - -```ts -optional title: string; -``` - -#### Description - -Large title text near the top of the attachment. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:46 - -*** - -### title\_link? - -```ts -optional title_link: string; -``` - -#### Description - -A valid URL that turns the `title` text into a hyperlink. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:50 - -*** - -### ts? - -```ts -optional ts: string; -``` - -#### Description - -A Unix timestamp that is used to relate your attachment to a specific time. -The attachment will display the additional timestamp value as part of the attachment's footer. -Your message's timestamp will be displayed in varying ways, depending on how far in the past or future it is, -relative to the present. Form factors, like mobile versus desktop may also transform its rendered appearance. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:96 diff --git a/docs/content/reference/web-api/interfaces/MessageAttachmentField.md b/docs/content/reference/web-api/interfaces/MessageAttachmentField.md deleted file mode 100644 index 1d41c5d92..000000000 --- a/docs/content/reference/web-api/interfaces/MessageAttachmentField.md +++ /dev/null @@ -1,59 +0,0 @@ -# Interface: MessageAttachmentField - -## Description - -A field object to include in a [MessageAttachment](MessageAttachment.md). - -## See - -[Field objects reference](https://api.slack.com/reference/messaging/attachments#field_objects). - -## Properties - -### short? - -```ts -optional short: boolean; -``` - -#### Description - -Indicates whether the field object is short enough to be displayed side-by-side with -other field objects. Defaults to `false`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:129 - -*** - -### title - -```ts -title: string; -``` - -#### Description - -Shown as a bold heading displayed in the field object. It cannot contain markup and -will be escaped for you. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:120 - -*** - -### value - -```ts -value: string; -``` - -#### Description - -The text value displayed in the field object. It can be formatted as plain text, or with [`mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) by using the `mrkdwn_in` option of [MessageAttachment](MessageAttachment.md). - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:124 diff --git a/docs/content/reference/web-api/interfaces/MessageAttachmentPreview.md b/docs/content/reference/web-api/interfaces/MessageAttachmentPreview.md deleted file mode 100644 index 8ad0de0e3..000000000 --- a/docs/content/reference/web-api/interfaces/MessageAttachmentPreview.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: MessageAttachmentPreview - -## Properties - -### can\_remove? - -```ts -optional can_remove: boolean; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:133 - -*** - -### iconUrl? - -```ts -optional iconUrl: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:136 - -*** - -### subtitle? - -```ts -optional subtitle: PlainTextElement; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:135 - -*** - -### title? - -```ts -optional title: PlainTextElement; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:134 - -*** - -### type? - -```ts -optional type: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:132 diff --git a/docs/content/reference/web-api/interfaces/MessageMetadata.md b/docs/content/reference/web-api/interfaces/MessageMetadata.md deleted file mode 100644 index 90f964628..000000000 --- a/docs/content/reference/web-api/interfaces/MessageMetadata.md +++ /dev/null @@ -1,52 +0,0 @@ -# Interface: MessageMetadata - -## Description - -Application-specific data to attach to Slack message. - -## See - - - [Using Metadata](https://api.slack.com/metadata/using) - - [Metadata Payload Structure](https://api.slack.com/reference/metadata#payload_structure) - -## Properties - -### event\_payload - -```ts -event_payload: object; -``` - -#### Index Signature - - \[`key`: `string`\]: - \| `string` - \| `number` - \| `boolean` - \| [`MessageMetadataEventPayloadObject`](MessageMetadataEventPayloadObject.md) - \| [`MessageMetadataEventPayloadObject`](MessageMetadataEventPayloadObject.md)[] - -#### Description - -A free-form object containing whatever data your application wishes to attach to messages. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-metadata.d.ts:15 - -*** - -### event\_type - -```ts -event_type: string; -``` - -#### Description - -A human readable alphanumeric string representing your application's metadata event. -The value of this field may appear in the UI to developers. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-metadata.d.ts:11 diff --git a/docs/content/reference/web-api/interfaces/MessageMetadataEventPayloadObject.md b/docs/content/reference/web-api/interfaces/MessageMetadataEventPayloadObject.md deleted file mode 100644 index fa6b94c30..000000000 --- a/docs/content/reference/web-api/interfaces/MessageMetadataEventPayloadObject.md +++ /dev/null @@ -1,5 +0,0 @@ -# Interface: MessageMetadataEventPayloadObject - -## Indexable - - \[`key`: `string`\]: `string` \| `number` \| `boolean` diff --git a/docs/content/reference/web-api/interfaces/Method.md b/docs/content/reference/web-api/interfaces/Method.md deleted file mode 100644 index cf220a52f..000000000 --- a/docs/content/reference/web-api/interfaces/Method.md +++ /dev/null @@ -1,27 +0,0 @@ -# Interface: Method()\ - -Generic method definition - -## Type Parameters - -• **MethodArguments** - -• **MethodResult** *extends* [`WebAPICallResult`](WebAPICallResult.md) = [`WebAPICallResult`](WebAPICallResult.md) - -```ts -interface Method(options): Promise -``` - -Generic method definition - -## Parameters - -• **options**: `MethodArguments` - -## Returns - -`Promise`\<`MethodResult`\> - -## Defined in - -[packages/web-api/src/methods.ts:508](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L508) diff --git a/docs/content/reference/web-api/interfaces/MigrationExchangeArguments.md b/docs/content/reference/web-api/interfaces/MigrationExchangeArguments.md deleted file mode 100644 index 43a2c6813..000000000 --- a/docs/content/reference/web-api/interfaces/MigrationExchangeArguments.md +++ /dev/null @@ -1,77 +0,0 @@ -# Interface: MigrationExchangeArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable` - -## Properties - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### to\_old? - -```ts -optional to_old: boolean; -``` - -#### Description - -Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`. - -#### Defined in - -[packages/web-api/src/types/request/migration.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/migration.ts#L8) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### users - -```ts -users: string; -``` - -#### Description - -A comma-separated list of user IDs, up to 400 per request. - -#### Defined in - -[packages/web-api/src/types/request/migration.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/migration.ts#L6) diff --git a/docs/content/reference/web-api/interfaces/ModalView.md b/docs/content/reference/web-api/interfaces/ModalView.md deleted file mode 100644 index 68b8c6eb2..000000000 --- a/docs/content/reference/web-api/interfaces/ModalView.md +++ /dev/null @@ -1,121 +0,0 @@ -# Interface: ModalView - -## Properties - -### blocks - -```ts -blocks: (Block | KnownBlock)[]; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:13 - -*** - -### callback\_id? - -```ts -optional callback_id: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:17 - -*** - -### clear\_on\_close? - -```ts -optional clear_on_close: boolean; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:18 - -*** - -### close? - -```ts -optional close: PlainTextElement; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:14 - -*** - -### external\_id? - -```ts -optional external_id: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:20 - -*** - -### notify\_on\_close? - -```ts -optional notify_on_close: boolean; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:19 - -*** - -### private\_metadata? - -```ts -optional private_metadata: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:16 - -*** - -### submit? - -```ts -optional submit: PlainTextElement; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:15 - -*** - -### title - -```ts -title: PlainTextElement; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:12 - -*** - -### type - -```ts -type: "modal"; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:11 diff --git a/docs/content/reference/web-api/interfaces/MrkdwnElement.md b/docs/content/reference/web-api/interfaces/MrkdwnElement.md deleted file mode 100644 index 3ac7cf980..000000000 --- a/docs/content/reference/web-api/interfaces/MrkdwnElement.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: MrkdwnElement - -## Description - -Defines an object containing some text. - -## See - -[Text object reference](https://api.slack.com/reference/block-kit/composition-objects#text). - -## Properties - -### text - -```ts -text: string; -``` - -#### Description - -The text for the block. This field accepts any of the standard text formatting markup. -The minimum length is 1 and maximum length is 3000 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:139 - -*** - -### type - -```ts -type: "mrkdwn"; -``` - -#### Description - -The formatting to use for this text object. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:134 - -*** - -### verbatim? - -```ts -optional verbatim: boolean; -``` - -#### Description - -When set to `false` (as is default) URLs will be auto-converted into links, conversation names will -be link-ified, and certain mentions will be [automatically parsed](https://api.slack.com/reference/surfaces/formatting#automatic-parsing). -Using a value of `true` will skip any preprocessing of this nature, although you can still include -[manual parsing strings](https://api.slack.com/reference/surfaces/formatting#advanced). - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:146 diff --git a/docs/content/reference/web-api/interfaces/MrkdwnOption.md b/docs/content/reference/web-api/interfaces/MrkdwnOption.md deleted file mode 100644 index 8e31c1f32..000000000 --- a/docs/content/reference/web-api/interfaces/MrkdwnOption.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: MrkdwnOption - -## Extends - -- `OptionDescriptor` - -## Properties - -### description? - -```ts -optional description: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) that defines a line of descriptive text shown below the `text` field. -Maximum length for the `text` within this field is 75 characters. - -#### Inherited from - -`OptionDescriptor.description` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:71 - -*** - -### text - -```ts -text: MrkdwnElement; -``` - -#### Description - -A [MrkdwnElement](MrkdwnElement.md) that defines the text shown in the option on the menu. To be used with -radio buttons and checkboxes. Maximum length for the `text` in this field is 75 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:78 - -*** - -### url? - -```ts -optional url: string; -``` - -#### Description - -Only available in overflow menus! A URL to load in the user's browser when the option is clicked. -Maximum length for this field is 3000 characters. - -#### Inherited from - -`OptionDescriptor.url` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:66 - -*** - -### value? - -```ts -optional value: string; -``` - -#### Description - -A unique string value that will be passed to your app when this option is chosen. -Maximum length for this field is 75 characters. - -#### Inherited from - -`OptionDescriptor.value` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:61 diff --git a/docs/content/reference/web-api/interfaces/MultiChannelsSelect.md b/docs/content/reference/web-api/interfaces/MultiChannelsSelect.md deleted file mode 100644 index e94a03d13..000000000 --- a/docs/content/reference/web-api/interfaces/MultiChannelsSelect.md +++ /dev/null @@ -1,151 +0,0 @@ -# Interface: MultiChannelsSelect - -## Description - -This multi-select menu will populate its options with a list of public channels visible to the current -user in the active workspace. - -## See - - - [Multi-select menu of public channels reference](https://api.slack.com/reference/block-kit/block-elements#channel_multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_channels? - -```ts -optional initial_channels: string[]; -``` - -#### Description - -An array of one or more IDs of any valid public channel to be pre-selected when the menu loads. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:382 - -*** - -### max\_selected\_items? - -```ts -optional max_selected_items: number; -``` - -#### Description - -Specifies the maximum number of items that can be selected in the menu. Minimum number is 1. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:386 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "multi_channels_select"; -``` - -#### Description - -The type of element. In this case `type` is always `multi_channels_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:378 diff --git a/docs/content/reference/web-api/interfaces/MultiConversationsSelect.md b/docs/content/reference/web-api/interfaces/MultiConversationsSelect.md deleted file mode 100644 index 65d4b8554..000000000 --- a/docs/content/reference/web-api/interfaces/MultiConversationsSelect.md +++ /dev/null @@ -1,203 +0,0 @@ -# Interface: MultiConversationsSelect - -## Description - -This multi-select menu will populate its options with a list of public and private channels, DMs, and -MPIMs visible to the current user in the active workspace. - -## See - - - [Multi-select menu of conversations reference](https://api.slack.com/reference/block-kit/block-elements#conversation_multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### default\_to\_current\_conversation? - -```ts -optional default_to_current_conversation: boolean; -``` - -#### Description - -Pre-populates the select menu with the conversation that the user was viewing when they opened the -modal, if available. Default is `false`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:335 - -*** - -### filter? - -```ts -optional filter: object; -``` - -#### exclude\_bot\_users? - -```ts -optional exclude_bot_users: boolean; -``` - -#### exclude\_external\_shared\_channels? - -```ts -optional exclude_external_shared_channels: boolean; -``` - -#### include? - -```ts -optional include: ("im" | "mpim" | "private" | "public")[]; -``` - -#### Description - -A filter object that reduces the list of available conversations using the specified criteria. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:339 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_conversations? - -```ts -optional initial_conversations: string[]; -``` - -#### Description - -An array of one or more IDs of any valid conversations to be pre-selected when the menu loads. If -`default_to_current_conversation` is also supplied, `initial_conversation` will be ignored. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:326 - -*** - -### max\_selected\_items? - -```ts -optional max_selected_items: number; -``` - -#### Description - -Specifies the maximum number of items that can be selected in the menu. Minimum number is 1. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:330 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "multi_conversations_select"; -``` - -#### Description - -The type of element. In this case `type` is always `conversations_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:321 diff --git a/docs/content/reference/web-api/interfaces/MultiExternalSelect.md b/docs/content/reference/web-api/interfaces/MultiExternalSelect.md deleted file mode 100644 index c4fa9f0aa..000000000 --- a/docs/content/reference/web-api/interfaces/MultiExternalSelect.md +++ /dev/null @@ -1,168 +0,0 @@ -# Interface: MultiExternalSelect - -## Description - -This menu will load its options from an external data source, allowing for a dynamic list of options. - -## See - - - [Multi-select menu of external data source reference](https://api.slack.com/reference/block-kit/block-elements#external_multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_options? - -```ts -optional initial_options: PlainTextOption[]; -``` - -#### Description - -An array of options to be selected when the menu initially loads. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:423 - -*** - -### max\_selected\_items? - -```ts -optional max_selected_items: number; -``` - -#### Description - -Specifies the maximum number of items that can be selected in the menu. Minimum number is 1. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:433 - -*** - -### min\_query\_length? - -```ts -optional min_query_length: number; -``` - -#### Description - -When the typeahead field is used, a request will be sent on every character change. If you prefer -fewer requests or more fully ideated queries, use the `min_query_length` attribute to tell Slack the fewest number -of typed characters required before dispatch. The default value is `3`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:429 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "multi_external_select"; -``` - -#### Description - -The type of element. In this case `type` is always `multi_external_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:419 diff --git a/docs/content/reference/web-api/interfaces/MultiStaticSelect.md b/docs/content/reference/web-api/interfaces/MultiStaticSelect.md deleted file mode 100644 index 91dbd608d..000000000 --- a/docs/content/reference/web-api/interfaces/MultiStaticSelect.md +++ /dev/null @@ -1,186 +0,0 @@ -# Interface: MultiStaticSelect - -## Description - -This is the simplest form of select menu, with a static list of options passed in when defining the -element. - -## See - - - [Multi-select menu of static options reference](https://api.slack.com/reference/block-kit/block-elements#static_multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_options? - -```ts -optional initial_options: PlainTextOption[]; -``` - -#### Description - -An array of option objects that exactly match one or more of the options within `options` or -`option_groups`. These options will be selected when the menu initially loads. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:255 - -*** - -### max\_selected\_items? - -```ts -optional max_selected_items: number; -``` - -#### Description - -Specifies the maximum number of items that can be selected in the menu. Minimum number is 1. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:272 - -*** - -### option\_groups? - -```ts -optional option_groups: object[]; -``` - -#### Description - -An array of option group objects. Maximum number of option groups is 100. If `options` is specified, -this field should not be. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:265 - -*** - -### options? - -```ts -optional options: PlainTextOption[]; -``` - -#### Description - -An array of [PlainTextOption](PlainTextOption.md). Maximum number of options is 100. If `option_groups` is -specified, this field should not be. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:260 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "multi_static_select"; -``` - -#### Description - -The type of element. In this case `type` is always `multi_static_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:250 diff --git a/docs/content/reference/web-api/interfaces/MultiUsersSelect.md b/docs/content/reference/web-api/interfaces/MultiUsersSelect.md deleted file mode 100644 index a1e4dce9d..000000000 --- a/docs/content/reference/web-api/interfaces/MultiUsersSelect.md +++ /dev/null @@ -1,151 +0,0 @@ -# Interface: MultiUsersSelect - -## Description - -This multi-select menu will populate its options with a list of Slack users visible to the current user -in the active workspace. - -## See - - - [Multi-select menu of users reference](https://api.slack.com/reference/block-kit/block-elements#users_multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_users? - -```ts -optional initial_users: string[]; -``` - -#### Description - -An array of user IDs of any valid users to be pre-selected when the menu loads. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:204 - -*** - -### max\_selected\_items? - -```ts -optional max_selected_items: number; -``` - -#### Description - -Specifies the maximum number of items that can be selected in the menu. Minimum number is `1`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:208 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "multi_users_select"; -``` - -#### Description - -The type of element. In this case `type` is always `multi_users_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:200 diff --git a/docs/content/reference/web-api/interfaces/NumberInput.md b/docs/content/reference/web-api/interfaces/NumberInput.md deleted file mode 100644 index 9e0decede..000000000 --- a/docs/content/reference/web-api/interfaces/NumberInput.md +++ /dev/null @@ -1,184 +0,0 @@ -# Interface: NumberInput - -## Description - -Allows user to enter a number into a single-line field. The number input element accepts both whole and -decimal numbers. For example, 0.25, 5.5, and -10 are all valid input values. Decimal numbers are only allowed when -`is_decimal_allowed` is equal to `true`. - -## See - - - [Number input element reference](https://api.slack.com/reference/block-kit/block-elements#number). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Inherited from - -[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_value? - -```ts -optional initial_value: string; -``` - -#### Description - -The initial value in the input when it is loaded. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:454 - -*** - -### is\_decimal\_allowed - -```ts -is_decimal_allowed: boolean; -``` - -#### Description - -Decimal numbers are allowed if this property is `true`, set the value to `false` otherwise. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:450 - -*** - -### max\_value? - -```ts -optional max_value: string; -``` - -#### Description - -The maximum value, cannot be less than `min_value`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:462 - -*** - -### min\_value? - -```ts -optional min_value: string; -``` - -#### Description - -The minimum value, cannot be greater than `max_value`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:458 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "number_input"; -``` - -#### Description - -The type of element. In this case `type` is always `number_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:446 diff --git a/docs/content/reference/web-api/interfaces/OAuthAccessArguments.md b/docs/content/reference/web-api/interfaces/OAuthAccessArguments.md deleted file mode 100644 index ef5c6cfa0..000000000 --- a/docs/content/reference/web-api/interfaces/OAuthAccessArguments.md +++ /dev/null @@ -1,102 +0,0 @@ -# Interface: OAuthAccessArguments - -## Extends - -- `OAuthCredentials` - -## Properties - -### client\_id - -```ts -client_id: string; -``` - -#### Description - -Issued when you created your application. - -#### Inherited from - -`OAuthCredentials.client_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L125) - -*** - -### client\_secret - -```ts -client_secret: string; -``` - -#### Description - -Issued when you created your application. - -#### Inherited from - -`OAuthCredentials.client_secret` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L127) - -*** - -### code? - -```ts -optional code: string; -``` - -#### Description - -The `code` parameter returned via the OAuth callback. - -#### Inherited from - -`OAuthCredentials.code` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:129](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L129) - -*** - -### redirect\_uri? - -```ts -optional redirect_uri: string; -``` - -#### Description - -While optional, it is _required_ if your app passed it as a parameter to the OpenID/OAuth flow's -first step and must match the originally submitted URI. - -#### Inherited from - -`OAuthCredentials.redirect_uri` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:134](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L134) - -*** - -### single\_channel? - -```ts -optional single_channel: boolean; -``` - -#### Description - -Request the user to add your app only to a single channel. Only valid with a [legacy workspace app](https://api.slack.com/legacy-workspace-apps). Defaults to `false`. - -#### Defined in - -[packages/web-api/src/types/request/oauth.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/oauth.ts#L6) diff --git a/docs/content/reference/web-api/interfaces/OAuthV2AccessArguments.md b/docs/content/reference/web-api/interfaces/OAuthV2AccessArguments.md deleted file mode 100644 index 63dc416d6..000000000 --- a/docs/content/reference/web-api/interfaces/OAuthV2AccessArguments.md +++ /dev/null @@ -1,126 +0,0 @@ -# Interface: OAuthV2AccessArguments - -## Extends - -- `OAuthCredentials`.`OAuthGrantRefresh` - -## Properties - -### client\_id - -```ts -client_id: string; -``` - -#### Description - -Issued when you created your application. - -#### Inherited from - -`OAuthCredentials.client_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L125) - -*** - -### client\_secret - -```ts -client_secret: string; -``` - -#### Description - -Issued when you created your application. - -#### Inherited from - -`OAuthCredentials.client_secret` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L127) - -*** - -### code? - -```ts -optional code: string; -``` - -#### Description - -The `code` parameter returned via the OAuth callback. - -#### Inherited from - -`OAuthCredentials.code` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:129](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L129) - -*** - -### grant\_type? - -```ts -optional grant_type: "authorization_code" | "refresh_token"; -``` - -#### Description - -The `grant_type` param as described in the OAuth spec. - -#### Inherited from - -`OAuthGrantRefresh.grant_type` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:139](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L139) - -*** - -### redirect\_uri? - -```ts -optional redirect_uri: string; -``` - -#### Description - -While optional, it is _required_ if your app passed it as a parameter to the OpenID/OAuth flow's -first step and must match the originally submitted URI. - -#### Inherited from - -`OAuthCredentials.redirect_uri` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:134](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L134) - -*** - -### refresh\_token? - -```ts -optional refresh_token: string; -``` - -#### Description - -The `refresh_token` param as described in the OAuth spec. - -#### Inherited from - -`OAuthGrantRefresh.refresh_token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:141](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L141) diff --git a/docs/content/reference/web-api/interfaces/OAuthV2ExchangeArguments.md b/docs/content/reference/web-api/interfaces/OAuthV2ExchangeArguments.md deleted file mode 100644 index 5daaa1cfe..000000000 --- a/docs/content/reference/web-api/interfaces/OAuthV2ExchangeArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: OAuthV2ExchangeArguments - -## Extends - -- `Pick`\<`OAuthCredentials`, `"client_id"` \| `"client_secret"`\> - -## Properties - -### client\_id - -```ts -client_id: string; -``` - -#### Description - -Issued when you created your application. - -#### Inherited from - -`Pick.client_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L125) - -*** - -### client\_secret - -```ts -client_secret: string; -``` - -#### Description - -Issued when you created your application. - -#### Inherited from - -`Pick.client_secret` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L127) - -*** - -### token - -```ts -token: string; -``` - -#### Description - -The legacy xoxb or xoxp token being migrated. - -#### Defined in - -[packages/web-api/src/types/request/oauth.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/oauth.ts#L13) diff --git a/docs/content/reference/web-api/interfaces/OpenIDConnectTokenArguments.md b/docs/content/reference/web-api/interfaces/OpenIDConnectTokenArguments.md deleted file mode 100644 index 95f450563..000000000 --- a/docs/content/reference/web-api/interfaces/OpenIDConnectTokenArguments.md +++ /dev/null @@ -1,126 +0,0 @@ -# Interface: OpenIDConnectTokenArguments - -## Extends - -- `OAuthCredentials`.`OAuthGrantRefresh` - -## Properties - -### client\_id - -```ts -client_id: string; -``` - -#### Description - -Issued when you created your application. - -#### Inherited from - -`OAuthCredentials.client_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L125) - -*** - -### client\_secret - -```ts -client_secret: string; -``` - -#### Description - -Issued when you created your application. - -#### Inherited from - -`OAuthCredentials.client_secret` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L127) - -*** - -### code? - -```ts -optional code: string; -``` - -#### Description - -The `code` parameter returned via the OAuth callback. - -#### Inherited from - -`OAuthCredentials.code` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:129](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L129) - -*** - -### grant\_type? - -```ts -optional grant_type: "authorization_code" | "refresh_token"; -``` - -#### Description - -The `grant_type` param as described in the OAuth spec. - -#### Inherited from - -`OAuthGrantRefresh.grant_type` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:139](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L139) - -*** - -### redirect\_uri? - -```ts -optional redirect_uri: string; -``` - -#### Description - -While optional, it is _required_ if your app passed it as a parameter to the OpenID/OAuth flow's -first step and must match the originally submitted URI. - -#### Inherited from - -`OAuthCredentials.redirect_uri` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:134](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L134) - -*** - -### refresh\_token? - -```ts -optional refresh_token: string; -``` - -#### Description - -The `refresh_token` param as described in the OAuth spec. - -#### Inherited from - -`OAuthGrantRefresh.refresh_token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:141](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L141) diff --git a/docs/content/reference/web-api/interfaces/OptionField.md b/docs/content/reference/web-api/interfaces/OptionField.md deleted file mode 100644 index 2a999bc90..000000000 --- a/docs/content/reference/web-api/interfaces/OptionField.md +++ /dev/null @@ -1,37 +0,0 @@ -# Interface: OptionField - -## Properties - -### description? - -```ts -optional description: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:157 - -*** - -### text - -```ts -text: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:158 - -*** - -### value - -```ts -value: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:159 diff --git a/docs/content/reference/web-api/interfaces/OptionGroup.md b/docs/content/reference/web-api/interfaces/OptionGroup.md deleted file mode 100644 index 0721bcf07..000000000 --- a/docs/content/reference/web-api/interfaces/OptionGroup.md +++ /dev/null @@ -1,42 +0,0 @@ -# Interface: OptionGroup - -## Description - -Defines a way to group options in a select or multi-select menu. - -## See - -[Option group object reference](https://api.slack.com/reference/block-kit/composition-objects#option_group). - -## Properties - -### label - -```ts -label: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) text object that defines the label shown above this group of options. -Maximum length for the `text` in this field is 75 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:102 - -*** - -### options - -```ts -options: Option[]; -``` - -#### Description - -An array of [Option](../type-aliases/Option.md) that belong to this specific group. Maximum of 100 items. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:106 diff --git a/docs/content/reference/web-api/interfaces/Overflow.md b/docs/content/reference/web-api/interfaces/Overflow.md deleted file mode 100644 index df71a2c7b..000000000 --- a/docs/content/reference/web-api/interfaces/Overflow.md +++ /dev/null @@ -1,95 +0,0 @@ -# Interface: Overflow - -## Description - -Allows users to press a button to view a list of options. -Unlike the select menu, there is no typeahead field, and the button always appears with an ellipsis ('…') rather -than customizable text. As such, it is usually used if you want a more compact layout than a select menu, or to -supply a list of less visually important actions after a row of buttons. You can also specify simple URL links as -overflow menu options, instead of actions. - -## See - - - [Overflow menu element reference](https://api.slack.com/reference/block-kit/block-elements#overflow). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### options - -```ts -options: PlainTextOption[]; -``` - -#### Description - -An array of up to 5 [PlainTextOption](PlainTextOption.md) to display in the menu. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:481 - -*** - -### type - -```ts -type: "overflow"; -``` - -#### Description - -The type of element. In this case `type` is always `number_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:477 diff --git a/docs/content/reference/web-api/interfaces/PageReducer.md b/docs/content/reference/web-api/interfaces/PageReducer.md deleted file mode 100644 index 5ba4e6c30..000000000 --- a/docs/content/reference/web-api/interfaces/PageReducer.md +++ /dev/null @@ -1,28 +0,0 @@ -# Interface: PageReducer()\ - -## Type Parameters - -• **A** = `any` - -```ts -interface PageReducer( - accumulator, - page, - index): A -``` - -## Parameters - -• **accumulator**: `undefined` \| `A` - -• **page**: [`WebAPICallResult`](WebAPICallResult.md) - -• **index**: `number` - -## Returns - -`A` - -## Defined in - -[packages/web-api/src/WebClient.ts:114](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L114) diff --git a/docs/content/reference/web-api/interfaces/PaginatePredicate.md b/docs/content/reference/web-api/interfaces/PaginatePredicate.md deleted file mode 100644 index c7ba6a2d0..000000000 --- a/docs/content/reference/web-api/interfaces/PaginatePredicate.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: PaginatePredicate() - -```ts -interface PaginatePredicate(page): undefined | boolean | void -``` - -## Parameters - -• **page**: [`WebAPICallResult`](WebAPICallResult.md) - -## Returns - -`undefined` \| `boolean` \| `void` - -## Defined in - -[packages/web-api/src/WebClient.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L109) diff --git a/docs/content/reference/web-api/interfaces/PinsAddArguments.md b/docs/content/reference/web-api/interfaces/PinsAddArguments.md deleted file mode 100644 index 2e12c567b..000000000 --- a/docs/content/reference/web-api/interfaces/PinsAddArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: PinsAddArguments - -## Extends - -- `MessageArgument`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -Channel where the message was posted. - -#### Inherited from - -`MessageArgument.channel` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L98) - -*** - -### timestamp - -```ts -timestamp: string; -``` - -#### Description - -Timestamp of the message. - -#### Inherited from - -`MessageArgument.timestamp` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L100) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/PinsListArguments.md b/docs/content/reference/web-api/interfaces/PinsListArguments.md deleted file mode 100644 index 18505b1ad..000000000 --- a/docs/content/reference/web-api/interfaces/PinsListArguments.md +++ /dev/null @@ -1,41 +0,0 @@ -# Interface: PinsListArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -Channel to get pinned items for. - -#### Defined in - -[packages/web-api/src/types/request/pins.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/pins.ts#L8) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/PinsRemoveArguments.md b/docs/content/reference/web-api/interfaces/PinsRemoveArguments.md deleted file mode 100644 index 1fbd4fcfc..000000000 --- a/docs/content/reference/web-api/interfaces/PinsRemoveArguments.md +++ /dev/null @@ -1,65 +0,0 @@ -# Interface: PinsRemoveArguments - -## Extends - -- `MessageArgument`.`TokenOverridable` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -Channel where the message was posted. - -#### Inherited from - -`MessageArgument.channel` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L98) - -*** - -### timestamp - -```ts -timestamp: string; -``` - -#### Description - -Timestamp of the message. - -#### Inherited from - -`MessageArgument.timestamp` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L100) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/Placeholdable.md b/docs/content/reference/web-api/interfaces/Placeholdable.md deleted file mode 100644 index 811bc19d4..000000000 --- a/docs/content/reference/web-api/interfaces/Placeholdable.md +++ /dev/null @@ -1,38 +0,0 @@ -# Interface: Placeholdable - -## Extended by - -- [`Datepicker`](Datepicker.md) -- [`EmailInput`](EmailInput.md) -- [`UsersSelect`](UsersSelect.md) -- [`MultiUsersSelect`](MultiUsersSelect.md) -- [`StaticSelect`](StaticSelect.md) -- [`MultiStaticSelect`](MultiStaticSelect.md) -- [`ConversationsSelect`](ConversationsSelect.md) -- [`MultiConversationsSelect`](MultiConversationsSelect.md) -- [`ChannelsSelect`](ChannelsSelect.md) -- [`MultiChannelsSelect`](MultiChannelsSelect.md) -- [`ExternalSelect`](ExternalSelect.md) -- [`MultiExternalSelect`](MultiExternalSelect.md) -- [`NumberInput`](NumberInput.md) -- [`PlainTextInput`](PlainTextInput.md) -- [`Timepicker`](Timepicker.md) -- [`URLInput`](URLInput.md) -- [`RichTextInput`](RichTextInput.md) - -## Properties - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 diff --git a/docs/content/reference/web-api/interfaces/PlainTextElement.md b/docs/content/reference/web-api/interfaces/PlainTextElement.md deleted file mode 100644 index 0bdc0c0ad..000000000 --- a/docs/content/reference/web-api/interfaces/PlainTextElement.md +++ /dev/null @@ -1,57 +0,0 @@ -# Interface: PlainTextElement - -## Description - -Defines an object containing some text. - -## See - -[Text object reference](https://api.slack.com/reference/block-kit/composition-objects#text). - -## Properties - -### emoji? - -```ts -optional emoji: boolean; -``` - -#### Description - -Indicates whether emojis in a text field should be escaped into the colon emoji format. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:124 - -*** - -### text - -```ts -text: string; -``` - -#### Description - -The text for the block. The minimum length is 1 and maximum length is 3000 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:120 - -*** - -### type - -```ts -type: "plain_text"; -``` - -#### Description - -The formatting to use for this text object. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:116 diff --git a/docs/content/reference/web-api/interfaces/PlainTextInput.md b/docs/content/reference/web-api/interfaces/PlainTextInput.md deleted file mode 100644 index c0b270a40..000000000 --- a/docs/content/reference/web-api/interfaces/PlainTextInput.md +++ /dev/null @@ -1,185 +0,0 @@ -# Interface: PlainTextInput - -## Description - -Allows users to enter freeform text data into a single-line or multi-line field. - -## See - - - [Plain-text input element reference](https://api.slack.com/reference/block-kit/block-elements#input). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Inherited from - -[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_value? - -```ts -optional initial_value: string; -``` - -#### Description - -The initial value in the plain-text input when it is loaded. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:496 - -*** - -### max\_length? - -```ts -optional max_length: number; -``` - -#### Description - -The maximum length of input that the user can provide. If the user provides more, -they will receive an error. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:511 - -*** - -### min\_length? - -```ts -optional min_length: number; -``` - -#### Description - -The minimum length of input that the user must provide. If the user provides less, they will receive -an error. Maximum value is 3000. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:506 - -*** - -### multiline? - -```ts -optional multiline: boolean; -``` - -#### Description - -Indicates whether the input will be a single line (`false`) or a larger textarea (`true`). -Defaults to `false`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:501 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "plain_text_input"; -``` - -#### Description - -The type of element. In this case `type` is always `plain_text_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:492 diff --git a/docs/content/reference/web-api/interfaces/PlainTextOption.md b/docs/content/reference/web-api/interfaces/PlainTextOption.md deleted file mode 100644 index 119fb95e6..000000000 --- a/docs/content/reference/web-api/interfaces/PlainTextOption.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: PlainTextOption - -## Extends - -- `OptionDescriptor` - -## Properties - -### description? - -```ts -optional description: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) that defines a line of descriptive text shown below the `text` field. -Maximum length for the `text` within this field is 75 characters. - -#### Inherited from - -`OptionDescriptor.description` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:71 - -*** - -### text - -```ts -text: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) that defines the text shown in the option on the menu. To be used with -overflow, select and multi-select menus. Maximum length for the `text` in this field is 75 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:85 - -*** - -### url? - -```ts -optional url: string; -``` - -#### Description - -Only available in overflow menus! A URL to load in the user's browser when the option is clicked. -Maximum length for this field is 3000 characters. - -#### Inherited from - -`OptionDescriptor.url` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:66 - -*** - -### value? - -```ts -optional value: string; -``` - -#### Description - -A unique string value that will be passed to your app when this option is chosen. -Maximum length for this field is 75 characters. - -#### Inherited from - -`OptionDescriptor.value` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:61 diff --git a/docs/content/reference/web-api/interfaces/RadioButtons.md b/docs/content/reference/web-api/interfaces/RadioButtons.md deleted file mode 100644 index f3d634c07..000000000 --- a/docs/content/reference/web-api/interfaces/RadioButtons.md +++ /dev/null @@ -1,130 +0,0 @@ -# Interface: RadioButtons - -## Description - -Allows users to choose one item from a list of possible options. - -## See - - - [Radio button group element reference](https://api.slack.com/reference/block-kit/block-elements#radio). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_option? - -```ts -optional initial_option: Option; -``` - -#### Description - -An [Option](../type-aliases/Option.md) object that exactly matches one of the options within `options`. This option will -be selected when the radio button group initially loads. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:527 - -*** - -### options - -```ts -options: Option[]; -``` - -#### Description - -An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options are allowed. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:531 - -*** - -### type - -```ts -type: "radio_buttons"; -``` - -#### Description - -The type of element. In this case `type` is always `radio_buttons`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:522 diff --git a/docs/content/reference/web-api/interfaces/ReactionsAddArguments.md b/docs/content/reference/web-api/interfaces/ReactionsAddArguments.md deleted file mode 100644 index e622d4dd3..000000000 --- a/docs/content/reference/web-api/interfaces/ReactionsAddArguments.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: ReactionsAddArguments - -## Extends - -- `MessageArgument`.`TokenOverridable`.`ReactionName` - -## Properties - -### channel - -```ts -channel: string; -``` - -#### Description - -Channel where the message was posted. - -#### Inherited from - -`MessageArgument.channel` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L98) - -*** - -### name - -```ts -name: string; -``` - -#### Description - -Reaction (emoji) name. - -#### Inherited from - -`ReactionName.name` - -#### Defined in - -[packages/web-api/src/types/request/reactions.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reactions.ts#L18) - -*** - -### timestamp - -```ts -timestamp: string; -``` - -#### Description - -Timestamp of the message. - -#### Inherited from - -`MessageArgument.timestamp` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L100) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/RemindersAddArguments.md b/docs/content/reference/web-api/interfaces/RemindersAddArguments.md deleted file mode 100644 index 8da4220e7..000000000 --- a/docs/content/reference/web-api/interfaces/RemindersAddArguments.md +++ /dev/null @@ -1,119 +0,0 @@ -# Interface: RemindersAddArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable` - -## Properties - -### recurrence? - -```ts -optional recurrence: ReminderRecurrence; -``` - -#### Description - -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. - -#### Defined in - -[packages/web-api/src/types/request/reminders.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L37) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### text - -```ts -text: string; -``` - -#### Description - -The content of the reminder. - -#### Defined in - -[packages/web-api/src/types/request/reminders.ts:19](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L19) - -*** - -### time - -```ts -time: string | number; -``` - -#### Description - -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"). - -#### Defined in - -[packages/web-api/src/types/request/reminders.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L26) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### ~~user?~~ - -```ts -optional user: string; -``` - -#### Description - -No longer supported - reminders cannot be set for other users. - -#### Deprecated - -#### See - -[Changes to `reminders.*` APIs announcement](https://api.slack.com/changelog/2023-07-its-later-already-for-stars-and-reminders#what). - -#### Defined in - -[packages/web-api/src/types/request/reminders.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L32) diff --git a/docs/content/reference/web-api/interfaces/RemindersCompleteArguments.md b/docs/content/reference/web-api/interfaces/RemindersCompleteArguments.md deleted file mode 100644 index da2d0b0e6..000000000 --- a/docs/content/reference/web-api/interfaces/RemindersCompleteArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: RemindersCompleteArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable` - -## Properties - -### reminder - -```ts -reminder: string; -``` - -#### Description - -The ID of the reminder to be marked as complete. - -#### Defined in - -[packages/web-api/src/types/request/reminders.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L42) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/RemindersDeleteArguments.md b/docs/content/reference/web-api/interfaces/RemindersDeleteArguments.md deleted file mode 100644 index d59ce5e0b..000000000 --- a/docs/content/reference/web-api/interfaces/RemindersDeleteArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: RemindersDeleteArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable` - -## Properties - -### reminder - -```ts -reminder: string; -``` - -#### Description - -The ID of the reminder to delete. - -#### Defined in - -[packages/web-api/src/types/request/reminders.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L47) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/RemindersInfoArguments.md b/docs/content/reference/web-api/interfaces/RemindersInfoArguments.md deleted file mode 100644 index e14c66f63..000000000 --- a/docs/content/reference/web-api/interfaces/RemindersInfoArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: RemindersInfoArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable` - -## Properties - -### reminder - -```ts -reminder: string; -``` - -#### Description - -The ID of the reminder to retrieve information about. - -#### Defined in - -[packages/web-api/src/types/request/reminders.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L52) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/RetryOptions.md b/docs/content/reference/web-api/interfaces/RetryOptions.md deleted file mode 100644 index 5c0d07a4c..000000000 --- a/docs/content/reference/web-api/interfaces/RetryOptions.md +++ /dev/null @@ -1,199 +0,0 @@ -# Interface: RetryOptions - -Options to create retry policies. Extends from https://github.com/tim-kos/node-retry. - -## Extends - -- `OperationOptions` - -## Properties - -### factor? - -```ts -optional factor: number; -``` - -The exponential factor to use. - -#### Default - -```ts -2 -``` - -#### Inherited from - -`OperationOptions.factor` - -#### Defined in - -packages/web-api/node\_modules/@types/retry/index.d.ts:125 - -*** - -### forever? - -```ts -optional forever: boolean; -``` - -Whether to retry forever. - -#### Default - -```ts -false -``` - -#### Inherited from - -`OperationOptions.forever` - -#### Defined in - -packages/web-api/node\_modules/@types/retry/index.d.ts:88 - -*** - -### maxRetryTime? - -```ts -optional maxRetryTime: number; -``` - -The maximum time (in milliseconds) that the retried operation is allowed to run. - -#### Default - -```ts -Infinity -``` - -#### Inherited from - -`OperationOptions.maxRetryTime` - -#### Defined in - -packages/web-api/node\_modules/@types/retry/index.d.ts:98 - -*** - -### maxTimeout? - -```ts -optional maxTimeout: number; -``` - -The maximum number of milliseconds between two retries. - -#### Default - -```ts -Infinity -``` - -#### Inherited from - -`OperationOptions.maxTimeout` - -#### Defined in - -packages/web-api/node\_modules/@types/retry/index.d.ts:135 - -*** - -### minTimeout? - -```ts -optional minTimeout: number; -``` - -The number of milliseconds before starting the first retry. - -#### Default - -```ts -1000 -``` - -#### Inherited from - -`OperationOptions.minTimeout` - -#### Defined in - -packages/web-api/node\_modules/@types/retry/index.d.ts:130 - -*** - -### randomize? - -```ts -optional randomize: boolean; -``` - -Randomizes the timeouts by multiplying a factor between 1-2. - -#### Default - -```ts -false -``` - -#### Inherited from - -`OperationOptions.randomize` - -#### Defined in - -packages/web-api/node\_modules/@types/retry/index.d.ts:140 - -*** - -### retries? - -```ts -optional retries: number; -``` - -The maximum amount of times to retry the operation. - -#### Default - -```ts -10 -``` - -#### Inherited from - -`OperationOptions.retries` - -#### Defined in - -packages/web-api/node\_modules/@types/retry/index.d.ts:109 - -*** - -### unref? - -```ts -optional unref: boolean; -``` - -Whether to [unref](https://nodejs.org/api/timers.html#timers_unref) the setTimeout's. - -#### Default - -```ts -false -``` - -#### Inherited from - -`OperationOptions.unref` - -#### Defined in - -packages/web-api/node\_modules/@types/retry/index.d.ts:93 diff --git a/docs/content/reference/web-api/interfaces/RichTextBlock.md b/docs/content/reference/web-api/interfaces/RichTextBlock.md deleted file mode 100644 index b275bff97..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextBlock.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: RichTextBlock - -## Extends - -- [`Block`](Block.md) - -## Properties - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 - -*** - -### elements - -```ts -elements: (RichTextSection | RichTextList | RichTextQuote | RichTextPreformatted)[]; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:235 - -*** - -### type - -```ts -type: "rich_text"; -``` - -#### Description - -The type of block. For a rich text block, `type` is always `rich_text`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:234 diff --git a/docs/content/reference/web-api/interfaces/RichTextBroadcastMention.md b/docs/content/reference/web-api/interfaces/RichTextBroadcastMention.md deleted file mode 100644 index f347ba9c7..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextBroadcastMention.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextBroadcastMention - -## Description - -A broadcast mention element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### range - -```ts -range: "channel" | "here" | "everyone"; -``` - -#### Description - -The range of the broadcast; can be one of `here`, `channel` and `everyone`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:643 - -*** - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 - -*** - -### type - -```ts -type: "broadcast"; -``` - -#### Description - -The type of element. In this case `type` is always `broadcast`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:639 diff --git a/docs/content/reference/web-api/interfaces/RichTextChannelMention.md b/docs/content/reference/web-api/interfaces/RichTextChannelMention.md deleted file mode 100644 index f5e6483e7..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextChannelMention.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextChannelMention - -## Description - -A channel mention element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### channel\_id - -```ts -channel_id: string; -``` - -#### Description - -The encoded channel ID, e.g. C1234ABCD. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:669 - -*** - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 - -*** - -### type - -```ts -type: "channel"; -``` - -#### Description - -The type of element. In this case `type` is always `channel`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:665 diff --git a/docs/content/reference/web-api/interfaces/RichTextColor.md b/docs/content/reference/web-api/interfaces/RichTextColor.md deleted file mode 100644 index cb933f86e..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextColor.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextColor - -## Description - -A hex color element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 - -*** - -### type - -```ts -type: "color"; -``` - -#### Description - -The type of element. In this case `type` is always `color`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:652 - -*** - -### value - -```ts -value: string; -``` - -#### Description - -The hex value for the color. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:656 diff --git a/docs/content/reference/web-api/interfaces/RichTextDate.md b/docs/content/reference/web-api/interfaces/RichTextDate.md deleted file mode 100644 index dc59e8e18..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextDate.md +++ /dev/null @@ -1,169 +0,0 @@ -# Interface: RichTextDate - -## Description - -A date element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### fallback? - -```ts -optional fallback: string; -``` - -#### Description - -Text to display in place of the date should parsing, formatting or displaying fails. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:714 - -*** - -### format - -```ts -format: string; -``` - -#### Description - -A template string containing curly-brace-enclosed tokens to substitute your provided `timestamp` -in a particularly-formatted way. For example: `Posted at {date_long}`. The available date formatting tokens are: -- `{day_divider_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable. Otherwise, if the date is in - current year, uses the `{date_long}` format without the year. Otherwise, falls back to using the `{date_long}` - format. -- `{date_num}`: Shows date as YYYY-MM-DD. -- `{date_slash}`: Shows date as DD/MM/YYYY (subject to locale preferences). -- `{date_long}`: Shows date as a long-form sentence including day-of-week, e.g. `Monday, December 23rd, 2013`. -- `{date_long_full}`: Shows date as a long-form sentence without day-of-week, e.g. `August 9, 2020`. -- `{date_long_pretty}`: Shows `yesterday`, `today` or `tomorrow`, otherwise uses the `{date_long}` format. -- `{date}`: Same as `{date_long_full}` but without the year. -- `{date_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable, otherwise uses the `{date}` format. -- `{date_short}`: Shows date using short month names without day-of-week, e.g. `Aug 9, 2020`. -- `{date_short_pretty}`: Shows `today`, `yesterday` or `tomorrow` if applicable, otherwise uses the `{date_short}` - format. -- `{time}`: Depending on user preferences, shows just the time-of-day portion of the timestamp using either 12 or - 24 hour clock formats, e.g. `2:34 PM` or `14:34`. -- `{time_secs}`: Depending on user preferences, shows just the time-of-day portion of the timestamp using either 12 - or 24 hour clock formats, including seconds, e.g. `2:34:56 PM` or `14:34:56`. -- `{ago}`: A human-readable period of time, e.g. `3 minutes ago`, `4 hours ago`, `2 days ago`. -TODO: test/document `{member_local_time}`, `{status_expiration}` and `{calendar_header}` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:706 - -*** - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 - -*** - -### timestamp - -```ts -timestamp: number; -``` - -#### Description - -A UNIX timestamp for the date to be displayed in seconds. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:682 - -*** - -### type - -```ts -type: "date"; -``` - -#### Description - -The type of element. In this case `type` is always `date`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:678 - -*** - -### url? - -```ts -optional url: string; -``` - -#### Description - -URL to link the entire `format` string to. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:710 diff --git a/docs/content/reference/web-api/interfaces/RichTextEmoji.md b/docs/content/reference/web-api/interfaces/RichTextEmoji.md deleted file mode 100644 index f609fc0e1..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextEmoji.md +++ /dev/null @@ -1,133 +0,0 @@ -# Interface: RichTextEmoji - -## Description - -An emoji element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### name - -```ts -name: string; -``` - -#### Description - -Name of emoji, without colons or skin tones, e.g. `wave` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:727 - -*** - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 - -*** - -### type - -```ts -type: "emoji"; -``` - -#### Description - -The type of element. In this case `type` is always `emoji`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:723 - -*** - -### unicode? - -```ts -optional unicode: string; -``` - -#### Description - -Lowercase hexadecimal Unicode representation of a standard emoji (not for use with custom emoji). - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:731 - -*** - -### url? - -```ts -optional url: string; -``` - -#### Description - -URL of emoji asset. Only used when sharing custom emoji across workspaces. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:735 diff --git a/docs/content/reference/web-api/interfaces/RichTextInput.md b/docs/content/reference/web-api/interfaces/RichTextInput.md deleted file mode 100644 index ad3e7c70e..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextInput.md +++ /dev/null @@ -1,135 +0,0 @@ -# Interface: RichTextInput - -## Description - -A rich text input creates a composer/WYSIWYG editor for entering formatted text, offering nearly the -same experience you have writing messages in Slack. - -## See - - - [Rich-text input element reference](https://api.slack.com/reference/block-kit/block-elements#rich_text_input). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Inherited from - -[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_value? - -```ts -optional initial_value: RichTextBlock; -``` - -#### Description - -Initial contents of the input when it is loaded. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:902 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "rich_text_input"; -``` - -#### Description - -The type of element. In this case `type` is always `rich_text_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:898 diff --git a/docs/content/reference/web-api/interfaces/RichTextLink.md b/docs/content/reference/web-api/interfaces/RichTextLink.md deleted file mode 100644 index 92691364d..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextLink.md +++ /dev/null @@ -1,133 +0,0 @@ -# Interface: RichTextLink - -## Description - -A link element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 - -*** - -### text? - -```ts -optional text: string; -``` - -#### Description - -The text to link. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:748 - -*** - -### type - -```ts -type: "link"; -``` - -#### Description - -The type of element. In this case `type` is always `link`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:744 - -*** - -### unsafe? - -```ts -optional unsafe: boolean; -``` - -#### Description - -TODO: ? - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:752 - -*** - -### url - -```ts -url: string; -``` - -#### Description - -URL to link to. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:756 diff --git a/docs/content/reference/web-api/interfaces/RichTextList.md b/docs/content/reference/web-api/interfaces/RichTextList.md deleted file mode 100644 index 6042be75c..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextList.md +++ /dev/null @@ -1,88 +0,0 @@ -# Interface: RichTextList - -## Description - -A list block within a rich text field. - -## Properties - -### border? - -```ts -optional border: 0 | 1; -``` - -#### Description - -Whether to render a quote-block-like border on the inline side of the list. `0` renders no border -while `1` renders a border. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:850 - -*** - -### elements - -```ts -elements: RichTextSection[]; -``` - -#### Description - -An array of [RichTextSection](RichTextSection.md) elements comprising each list item. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:835 - -*** - -### indent? - -```ts -optional indent: number; -``` - -#### Description - -The style of the list points. Can be a number from `0` (default) to `8`. Yields a different character -or characters rendered as the list points. Also affected by the `style` property. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:845 - -*** - -### style - -```ts -style: "bullet" | "ordered"; -``` - -#### Description - -The type of list. Can be either `bullet` (the list points are all rendered the same way) or `ordered` -(the list points increase numerically from 1). - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:840 - -*** - -### type - -```ts -type: "rich_text_list"; -``` - -#### Description - -The type of element. In this case `type` is always `rich_text_list`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:831 diff --git a/docs/content/reference/web-api/interfaces/RichTextPreformatted.md b/docs/content/reference/web-api/interfaces/RichTextPreformatted.md deleted file mode 100644 index bf3e0ed4c..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextPreformatted.md +++ /dev/null @@ -1,54 +0,0 @@ -# Interface: RichTextPreformatted - -## Description - -A block of preformatted text within a rich text field. - -## Properties - -### border? - -```ts -optional border: 0 | 1; -``` - -#### Description - -Whether to render a quote-block-like border on the inline side of the preformatted text. -`0` renders no border, while `1` renders a border. Defaults to `0`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:886 - -*** - -### elements - -```ts -elements: (RichTextLink | RichTextText)[]; -``` - -#### Description - -An array of either [RichTextLink](RichTextLink.md) or [RichTextText](RichTextText.md) comprising the preformatted text. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:881 - -*** - -### type - -```ts -type: "rich_text_preformatted"; -``` - -#### Description - -The type of element. In this case `type` is always `rich_text_preformatted`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:877 diff --git a/docs/content/reference/web-api/interfaces/RichTextQuote.md b/docs/content/reference/web-api/interfaces/RichTextQuote.md deleted file mode 100644 index 1b3b40a54..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextQuote.md +++ /dev/null @@ -1,54 +0,0 @@ -# Interface: RichTextQuote - -## Description - -A quote block within a rich text field. - -## Properties - -### border? - -```ts -optional border: 0 | 1; -``` - -#### Description - -Whether to render a quote-block-like border on the inline side of the text quote. -`0` renders no border, while `1` renders a border. Defaults to `0`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:868 - -*** - -### elements - -```ts -elements: RichTextElement[]; -``` - -#### Description - -An array of [RichTextElement](../type-aliases/RichTextElement.md) comprising the quote block. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:863 - -*** - -### type - -```ts -type: "rich_text_quote"; -``` - -#### Description - -The type of element. In this case `type` is always `rich_text_quote`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:859 diff --git a/docs/content/reference/web-api/interfaces/RichTextSection.md b/docs/content/reference/web-api/interfaces/RichTextSection.md deleted file mode 100644 index f76a878bf..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextSection.md +++ /dev/null @@ -1,33 +0,0 @@ -# Interface: RichTextSection - -## Description - -A section block within a rich text field. - -## Properties - -### elements - -```ts -elements: RichTextElement[]; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:822 - -*** - -### type - -```ts -type: "rich_text_section"; -``` - -#### Description - -The type of element. In this case `type` is always `rich_text_section`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:821 diff --git a/docs/content/reference/web-api/interfaces/RichTextStyleable.md b/docs/content/reference/web-api/interfaces/RichTextStyleable.md deleted file mode 100644 index 2c32bbe6b..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextStyleable.md +++ /dev/null @@ -1,74 +0,0 @@ -# Interface: RichTextStyleable - -## Description - -For use styling Rich Text sub-elements. - -## Extended by - -- [`RichTextBroadcastMention`](RichTextBroadcastMention.md) -- [`RichTextColor`](RichTextColor.md) -- [`RichTextChannelMention`](RichTextChannelMention.md) -- [`RichTextDate`](RichTextDate.md) -- [`RichTextEmoji`](RichTextEmoji.md) -- [`RichTextLink`](RichTextLink.md) -- [`RichTextTeamMention`](RichTextTeamMention.md) -- [`RichTextText`](RichTextText.md) -- [`RichTextUserMention`](RichTextUserMention.md) -- [`RichTextUsergroupMention`](RichTextUsergroupMention.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 diff --git a/docs/content/reference/web-api/interfaces/RichTextTeamMention.md b/docs/content/reference/web-api/interfaces/RichTextTeamMention.md deleted file mode 100644 index 824aa44e2..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextTeamMention.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextTeamMention - -## Description - -A workspace or team mention element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 - -*** - -### team\_id - -```ts -team_id: string; -``` - -#### Description - -The encoded team ID, e.g. T1234ABCD. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:769 - -*** - -### type - -```ts -type: "team"; -``` - -#### Description - -The type of element. In this case `type` is always `team`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:765 diff --git a/docs/content/reference/web-api/interfaces/RichTextText.md b/docs/content/reference/web-api/interfaces/RichTextText.md deleted file mode 100644 index 189071a6c..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextText.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextText - -## Description - -A generic text element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 - -*** - -### text - -```ts -text: string; -``` - -#### Description - -The text to render. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:782 - -*** - -### type - -```ts -type: "text"; -``` - -#### Description - -The type of element. In this case `type` is always `text`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:778 diff --git a/docs/content/reference/web-api/interfaces/RichTextUserMention.md b/docs/content/reference/web-api/interfaces/RichTextUserMention.md deleted file mode 100644 index 1e519876e..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextUserMention.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextUserMention - -## Description - -A user mention element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 - -*** - -### type - -```ts -type: "user"; -``` - -#### Description - -The type of element. In this case `type` is always `user`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:791 - -*** - -### user\_id - -```ts -user_id: string; -``` - -#### Description - -The encoded user ID, e.g. U1234ABCD. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:795 diff --git a/docs/content/reference/web-api/interfaces/RichTextUsergroupMention.md b/docs/content/reference/web-api/interfaces/RichTextUsergroupMention.md deleted file mode 100644 index 800caf15d..000000000 --- a/docs/content/reference/web-api/interfaces/RichTextUsergroupMention.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: RichTextUsergroupMention - -## Description - -A usergroup mention element for use in a rich text message. - -## Extends - -- [`RichTextStyleable`](RichTextStyleable.md) - -## Properties - -### style? - -```ts -optional style: object; -``` - -#### bold? - -```ts -optional bold: boolean; -``` - -##### Description - -When `true`, boldens the text in this element. Defaults to `false`. - -#### code? - -```ts -optional code: boolean; -``` - -##### Description - -When `true`, the text is preformatted in an inline code style. Defaults to `false. - -#### italic? - -```ts -optional italic: boolean; -``` - -##### Description - -When `true`, italicizes the text in this element. Defaults to `false`. - -#### strike? - -```ts -optional strike: boolean; -``` - -##### Description - -When `true`, strikes through the text in this element. Defaults to `false`. - -#### Description - -A limited style object for styling rich text `text` elements. - -#### Inherited from - -[`RichTextStyleable`](RichTextStyleable.md).[`style`](RichTextStyleable.md#style) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:52 - -*** - -### type - -```ts -type: "usergroup"; -``` - -#### Description - -The type of element. In this case `type` is always `usergroup`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:804 - -*** - -### usergroup\_id - -```ts -usergroup_id: string; -``` - -#### Description - -The encoded usergroup ID, e.g. S1234ABCD. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:808 diff --git a/docs/content/reference/web-api/interfaces/SearchAllArguments.md b/docs/content/reference/web-api/interfaces/SearchAllArguments.md deleted file mode 100644 index 7dc54af58..000000000 --- a/docs/content/reference/web-api/interfaces/SearchAllArguments.md +++ /dev/null @@ -1,169 +0,0 @@ -# Interface: SearchAllArguments - -## Extends - -- `TokenOverridable`.`TraditionalPagingEnabled`.`Searchable` - -## Properties - -### count? - -```ts -optional count: number; -``` - -#### Description - -Number of items to return per page. Defaults to `20` - -#### Inherited from - -`TraditionalPagingEnabled.count` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) - -*** - -### highlight? - -```ts -optional highlight: boolean; -``` - -#### Description - -Set to `true` to enable query highlight markers. Defaults to `false`. - -#### See - -[`search.messages` Usage info](https://api.slack.com/methods/search.messages#markdown) for details. - -#### Inherited from - -`Searchable.highlight` - -#### Defined in - -[packages/web-api/src/types/request/search.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L10) - -*** - -### page? - -```ts -optional page: number; -``` - -#### Description - -Page number of results to return. Defaults to `1`. - -#### Inherited from - -`TraditionalPagingEnabled.page` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) - -*** - -### query - -```ts -query: string; -``` - -#### Description - -Search query. - -#### Inherited from - -`Searchable.query` - -#### Defined in - -[packages/web-api/src/types/request/search.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L5) - -*** - -### sort? - -```ts -optional sort: "score" | "timestamp"; -``` - -#### Description - -Return matches sorted by either `score` or `timestamp`. Defaults to `score`. - -#### Inherited from - -`Searchable.sort` - -#### Defined in - -[packages/web-api/src/types/request/search.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L12) - -*** - -### sort\_dir? - -```ts -optional sort_dir: "asc" | "desc"; -``` - -#### Description - -Change sort direction to ascending (`asc`) or descending (`desc`). Defaults to `desc`. - -#### Inherited from - -`Searchable.sort_dir` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L117) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`Searchable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/SearchFilesArguments.md b/docs/content/reference/web-api/interfaces/SearchFilesArguments.md deleted file mode 100644 index bbbc55080..000000000 --- a/docs/content/reference/web-api/interfaces/SearchFilesArguments.md +++ /dev/null @@ -1,169 +0,0 @@ -# Interface: SearchFilesArguments - -## Extends - -- `TokenOverridable`.`TraditionalPagingEnabled`.`Searchable` - -## Properties - -### count? - -```ts -optional count: number; -``` - -#### Description - -Number of items to return per page. Defaults to `20` - -#### Inherited from - -`TraditionalPagingEnabled.count` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) - -*** - -### highlight? - -```ts -optional highlight: boolean; -``` - -#### Description - -Set to `true` to enable query highlight markers. Defaults to `false`. - -#### See - -[`search.messages` Usage info](https://api.slack.com/methods/search.messages#markdown) for details. - -#### Inherited from - -`Searchable.highlight` - -#### Defined in - -[packages/web-api/src/types/request/search.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L10) - -*** - -### page? - -```ts -optional page: number; -``` - -#### Description - -Page number of results to return. Defaults to `1`. - -#### Inherited from - -`TraditionalPagingEnabled.page` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) - -*** - -### query - -```ts -query: string; -``` - -#### Description - -Search query. - -#### Inherited from - -`Searchable.query` - -#### Defined in - -[packages/web-api/src/types/request/search.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L5) - -*** - -### sort? - -```ts -optional sort: "score" | "timestamp"; -``` - -#### Description - -Return matches sorted by either `score` or `timestamp`. Defaults to `score`. - -#### Inherited from - -`Searchable.sort` - -#### Defined in - -[packages/web-api/src/types/request/search.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L12) - -*** - -### sort\_dir? - -```ts -optional sort_dir: "asc" | "desc"; -``` - -#### Description - -Change sort direction to ascending (`asc`) or descending (`desc`). Defaults to `desc`. - -#### Inherited from - -`Searchable.sort_dir` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L117) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`Searchable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/SearchMessagesArguments.md b/docs/content/reference/web-api/interfaces/SearchMessagesArguments.md deleted file mode 100644 index 23901e796..000000000 --- a/docs/content/reference/web-api/interfaces/SearchMessagesArguments.md +++ /dev/null @@ -1,169 +0,0 @@ -# Interface: SearchMessagesArguments - -## Extends - -- `TokenOverridable`.`TraditionalPagingEnabled`.`Searchable` - -## Properties - -### count? - -```ts -optional count: number; -``` - -#### Description - -Number of items to return per page. Defaults to `20` - -#### Inherited from - -`TraditionalPagingEnabled.count` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) - -*** - -### highlight? - -```ts -optional highlight: boolean; -``` - -#### Description - -Set to `true` to enable query highlight markers. Defaults to `false`. - -#### See - -[`search.messages` Usage info](https://api.slack.com/methods/search.messages#markdown) for details. - -#### Inherited from - -`Searchable.highlight` - -#### Defined in - -[packages/web-api/src/types/request/search.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L10) - -*** - -### page? - -```ts -optional page: number; -``` - -#### Description - -Page number of results to return. Defaults to `1`. - -#### Inherited from - -`TraditionalPagingEnabled.page` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) - -*** - -### query - -```ts -query: string; -``` - -#### Description - -Search query. - -#### Inherited from - -`Searchable.query` - -#### Defined in - -[packages/web-api/src/types/request/search.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L5) - -*** - -### sort? - -```ts -optional sort: "score" | "timestamp"; -``` - -#### Description - -Return matches sorted by either `score` or `timestamp`. Defaults to `score`. - -#### Inherited from - -`Searchable.sort` - -#### Defined in - -[packages/web-api/src/types/request/search.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/search.ts#L12) - -*** - -### sort\_dir? - -```ts -optional sort_dir: "asc" | "desc"; -``` - -#### Description - -Change sort direction to ascending (`asc`) or descending (`desc`). Defaults to `desc`. - -#### Inherited from - -`Searchable.sort_dir` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L117) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`Searchable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/SectionBlock.md b/docs/content/reference/web-api/interfaces/SectionBlock.md deleted file mode 100644 index dd8733c18..000000000 --- a/docs/content/reference/web-api/interfaces/SectionBlock.md +++ /dev/null @@ -1,122 +0,0 @@ -# Interface: SectionBlock - -## Description - -Displays text, possibly alongside block elements. A section can be used as a simple text block, in -combination with text fields, or side-by-side with certain -[block elements](https://api.slack.com/reference/messaging/block-elements). - -## See - -[Section block reference](https://api.slack.com/reference/block-kit/blocks#section). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### accessory? - -```ts -optional accessory: - | Button - | Actionable - | Checkboxes - | Datepicker - | MultiSelect - | Overflow - | RadioButtons - | Select - | Timepicker - | ImageElement; -``` - -#### Description - -One of the compatible element objects. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:177 - -*** - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 - -*** - -### fields? - -```ts -optional fields: (PlainTextElement | MrkdwnElement)[]; -``` - -#### Description - -Required if no `text` is provided. An array of text objects. Any text objects included with `fields` -will be rendered in a compact format that allows for 2 columns of side-by-side text. Maximum number of items is 10. -Maximum length for the text in each item is 2000 characters. -[Click here for an example](https://app.slack.com/block-kit-builder/#%7B%22blocks%22:%5B%7B%22type%22:%22section%22,%22text%22:%7B%22text%22:%22A%20message%20*with%20some%20bold%20text*%20and%20_some%20italicized%20text_.%22,%22type%22:%22mrkdwn%22%7D,%22fields%22:%5B%7B%22type%22:%22mrkdwn%22,%22text%22:%22*Priority*%22%7D,%7B%22type%22:%22mrkdwn%22,%22text%22:%22*Type*%22%7D,%7B%22type%22:%22plain_text%22,%22text%22:%22High%22%7D,%7B%22type%22:%22plain_text%22,%22text%22:%22String%22%7D%5D%7D%5D%7D). - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:173 - -*** - -### text? - -```ts -optional text: PlainTextElement | MrkdwnElement; -``` - -#### Description - -The text for the block, in the form of a text object. Minimum length for the `text` in this field is -1 and maximum length is 3000 characters. This field is not required if a valid array of `fields` objects is -provided instead. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:166 - -*** - -### type - -```ts -type: "section"; -``` - -#### Description - -The type of block. For a section block, `type` is always `section`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:160 diff --git a/docs/content/reference/web-api/interfaces/SelectOption.md b/docs/content/reference/web-api/interfaces/SelectOption.md deleted file mode 100644 index 8f174f015..000000000 --- a/docs/content/reference/web-api/interfaces/SelectOption.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: SelectOption - -## Properties - -### label - -```ts -label: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:33 - -*** - -### value - -```ts -value: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:34 diff --git a/docs/content/reference/web-api/interfaces/SlackFileImageObject.md b/docs/content/reference/web-api/interfaces/SlackFileImageObject.md deleted file mode 100644 index d83269def..000000000 --- a/docs/content/reference/web-api/interfaces/SlackFileImageObject.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: SlackFileImageObject - -## Description - -Object for image which contains a slack_file. - -## Properties - -### slack\_file - -```ts -slack_file: SlackFile; -``` - -#### Description - -The slack file of the image to be displayed. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:188 diff --git a/docs/content/reference/web-api/interfaces/StarsListArguments.md b/docs/content/reference/web-api/interfaces/StarsListArguments.md deleted file mode 100644 index 3bde10813..000000000 --- a/docs/content/reference/web-api/interfaces/StarsListArguments.md +++ /dev/null @@ -1,132 +0,0 @@ -# Interface: StarsListArguments - -## Extends - -- `TokenOverridable`.`TraditionalPagingEnabled`.`CursorPaginationEnabled`.`OptionalTeamAssignable` - -## Properties - -### count? - -```ts -optional count: number; -``` - -#### Description - -Number of items to return per page. Defaults to `20` - -#### Inherited from - -`TraditionalPagingEnabled.count` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L33) - -*** - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### page? - -```ts -optional page: number; -``` - -#### Description - -Page number of results to return. Defaults to `1`. - -#### Inherited from - -`TraditionalPagingEnabled.page` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:35](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L35) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/StaticSelect.md b/docs/content/reference/web-api/interfaces/StaticSelect.md deleted file mode 100644 index 279c9fafa..000000000 --- a/docs/content/reference/web-api/interfaces/StaticSelect.md +++ /dev/null @@ -1,170 +0,0 @@ -# Interface: StaticSelect - -## Description - -This is the simplest form of select menu, with a static list of options passed in when defining the -element. - -## See - - - [Select menu of static options reference](https://api.slack.com/reference/block-kit/block-elements#static_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_option? - -```ts -optional initial_option: PlainTextOption; -``` - -#### Description - -A single option that exactly matches one of the options within `options` or `option_groups`. -This option will be selected when the menu initially loads. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:225 - -*** - -### option\_groups? - -```ts -optional option_groups: object[]; -``` - -#### Description - -An array of option group objects. Maximum number of option groups is 100. If `options` is specified, -this field should not be. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:235 - -*** - -### options? - -```ts -optional options: PlainTextOption[]; -``` - -#### Description - -An array of [PlainTextOption](PlainTextOption.md). Maximum number of options is 100. If `option_groups` is -specified, this field should not be. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:230 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "static_select"; -``` - -#### Description - -The type of element. In this case `type` is always `static_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:220 diff --git a/docs/content/reference/web-api/interfaces/Timepicker.md b/docs/content/reference/web-api/interfaces/Timepicker.md deleted file mode 100644 index c3673383b..000000000 --- a/docs/content/reference/web-api/interfaces/Timepicker.md +++ /dev/null @@ -1,155 +0,0 @@ -# Interface: Timepicker - -## Description - -Allows users to choose a time from a rich dropdown UI. On desktop clients, this time picker will take -the form of a dropdown list with free-text entry for precise choices. On mobile clients, the time picker will use -native time picker UIs. - -## See - - - [Time picker element reference](https://api.slack.com/reference/block-kit/block-elements#timepicker). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_time? - -```ts -optional initial_time: string; -``` - -#### Description - -The initial time that is selected when the element is loaded. This should be in the format `HH:mm`, -where `HH` is the 24-hour format of an hour (00 to 23) and `mm` is minutes with leading zeros (00 to 59), -for example 22:25 for 10:25pm. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:550 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### timezone? - -```ts -optional timezone: string; -``` - -#### Description - -A string in the IANA format, e.g. 'America/Chicago'. The timezone is displayed to end users as hint -text underneath the time picker. It is also passed to the app upon certain interactions, such as view_submission. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:555 - -*** - -### type - -```ts -type: "timepicker"; -``` - -#### Description - -The type of element. In this case `type` is always `timepicker`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:544 diff --git a/docs/content/reference/web-api/interfaces/ToolingTokensRotateArguments.md b/docs/content/reference/web-api/interfaces/ToolingTokensRotateArguments.md deleted file mode 100644 index 9588d86cf..000000000 --- a/docs/content/reference/web-api/interfaces/ToolingTokensRotateArguments.md +++ /dev/null @@ -1,17 +0,0 @@ -# Interface: ToolingTokensRotateArguments - -## Properties - -### refresh\_token - -```ts -refresh_token: string; -``` - -#### Description - -The `xoxe` refresh token that was issued along with the old app configuration token. - -#### Defined in - -[packages/web-api/src/types/request/tooling.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/tooling.ts#L4) diff --git a/docs/content/reference/web-api/interfaces/URLInput.md b/docs/content/reference/web-api/interfaces/URLInput.md deleted file mode 100644 index b9f2fc77a..000000000 --- a/docs/content/reference/web-api/interfaces/URLInput.md +++ /dev/null @@ -1,134 +0,0 @@ -# Interface: URLInput - -## Description - -Allows user to enter a URL into a single-line field. - -## See - - - [URL input element reference](https://api.slack.com/reference/block-kit/block-elements#url). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Dispatchable`](Dispatchable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### dispatch\_action\_config? - -```ts -optional dispatch_action_config: DispatchActionConfig; -``` - -#### Description - -A [DispatchActionConfig](DispatchActionConfig.md) object that determines when during text input the element returns a -[`block_actions` payload](https://api.slack.com/reference/interaction-payloads/block-actions). - -#### Inherited from - -[`Dispatchable`](Dispatchable.md).[`dispatch_action_config`](Dispatchable.md#dispatch_action_config) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:43 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_value? - -```ts -optional initial_value: string; -``` - -#### Description - -The initial value in the URL input when it is loaded. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:570 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "url_text_input"; -``` - -#### Description - -The type of element. In this case `type` is always `url_text_input`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:566 diff --git a/docs/content/reference/web-api/interfaces/UrlImageObject.md b/docs/content/reference/web-api/interfaces/UrlImageObject.md deleted file mode 100644 index 5dfb148a0..000000000 --- a/docs/content/reference/web-api/interfaces/UrlImageObject.md +++ /dev/null @@ -1,21 +0,0 @@ -# Interface: UrlImageObject - -## Description - -Object for image which contains a image_url. - -## Properties - -### image\_url - -```ts -image_url: string; -``` - -#### Description - -The URL of the image to be displayed. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:179 diff --git a/docs/content/reference/web-api/interfaces/UsergroupsCreateArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsCreateArguments.md deleted file mode 100644 index 124ffe088..000000000 --- a/docs/content/reference/web-api/interfaces/UsergroupsCreateArguments.md +++ /dev/null @@ -1,129 +0,0 @@ -# Interface: UsergroupsCreateArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable`.`UsergroupsIncludeCount` - -## Properties - -### channels? - -```ts -optional channels: string; -``` - -#### Description - -A comma separated string of encoded channel IDs for which the User Group uses as a default. - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L14) - -*** - -### description? - -```ts -optional description: string; -``` - -#### Description - -A short description of the User Group. - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L16) - -*** - -### handle? - -```ts -optional handle: string; -``` - -#### Description - -A mention handle. Must be unique among channels, users and User Groups. - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L18) - -*** - -### include\_count? - -```ts -optional include_count: boolean; -``` - -#### Description - -Include the number of users in each User Group. - -#### Inherited from - -`UsergroupsIncludeCount.include_count` - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L6) - -*** - -### name - -```ts -name: string; -``` - -#### Description - -A name for the User Group. Must be unique among User Groups. - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L12) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsergroupsDisableArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsDisableArguments.md deleted file mode 100644 index 420717121..000000000 --- a/docs/content/reference/web-api/interfaces/UsergroupsDisableArguments.md +++ /dev/null @@ -1,81 +0,0 @@ -# Interface: UsergroupsDisableArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable`.`UsergroupsIncludeCount` - -## Properties - -### include\_count? - -```ts -optional include_count: boolean; -``` - -#### Description - -Include the number of users in each User Group. - -#### Inherited from - -`UsergroupsIncludeCount.include_count` - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L6) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### usergroup - -```ts -usergroup: string; -``` - -#### Description - -The encoded ID of the User Group to disable. - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L23) diff --git a/docs/content/reference/web-api/interfaces/UsergroupsEnableArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsEnableArguments.md deleted file mode 100644 index 3a01fba51..000000000 --- a/docs/content/reference/web-api/interfaces/UsergroupsEnableArguments.md +++ /dev/null @@ -1,81 +0,0 @@ -# Interface: UsergroupsEnableArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable`.`UsergroupsIncludeCount` - -## Properties - -### include\_count? - -```ts -optional include_count: boolean; -``` - -#### Description - -Include the number of users in each User Group. - -#### Inherited from - -`UsergroupsIncludeCount.include_count` - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L6) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### usergroup - -```ts -usergroup: string; -``` - -#### Description - -The encoded ID of the User Group to enable. - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L28) diff --git a/docs/content/reference/web-api/interfaces/UsergroupsUpdateArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsUpdateArguments.md deleted file mode 100644 index 9c58e24e7..000000000 --- a/docs/content/reference/web-api/interfaces/UsergroupsUpdateArguments.md +++ /dev/null @@ -1,161 +0,0 @@ -# Interface: UsergroupsUpdateArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable`.`Partial`\<[`UsergroupsCreateArguments`](UsergroupsCreateArguments.md)\> - -## Properties - -### channels? - -```ts -optional channels: string; -``` - -#### Description - -A comma separated string of encoded channel IDs for which the User Group uses as a default. - -#### Inherited from - -`Partial.channels` - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L14) - -*** - -### description? - -```ts -optional description: string; -``` - -#### Description - -A short description of the User Group. - -#### Inherited from - -`Partial.description` - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L16) - -*** - -### handle? - -```ts -optional handle: string; -``` - -#### Description - -A mention handle. Must be unique among channels, users and User Groups. - -#### Inherited from - -`Partial.handle` - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L18) - -*** - -### include\_count? - -```ts -optional include_count: boolean; -``` - -#### Description - -Include the number of users in each User Group. - -#### Inherited from - -`Partial.include_count` - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L6) - -*** - -### name? - -```ts -optional name: string; -``` - -#### Description - -A name for the User Group. Must be unique among User Groups. - -#### Inherited from - -`Partial.name` - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L12) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### usergroup - -```ts -usergroup: string; -``` - -#### Description - -The encoded ID of the User Group to update. - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsergroupsUsersListArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsUsersListArguments.md deleted file mode 100644 index 808006e7f..000000000 --- a/docs/content/reference/web-api/interfaces/UsergroupsUsersListArguments.md +++ /dev/null @@ -1,77 +0,0 @@ -# Interface: UsergroupsUsersListArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable` - -## Properties - -### include\_disabled? - -```ts -optional include_disabled: boolean; -``` - -#### Description - -Allow results that involve disabled User Groups. - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L50) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### usergroup - -```ts -usergroup: string; -``` - -#### Description - -The encoded ID of the User Group to list users for. - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L48) diff --git a/docs/content/reference/web-api/interfaces/UsergroupsUsersUpdateArguments.md b/docs/content/reference/web-api/interfaces/UsergroupsUsersUpdateArguments.md deleted file mode 100644 index b08c913e8..000000000 --- a/docs/content/reference/web-api/interfaces/UsergroupsUsersUpdateArguments.md +++ /dev/null @@ -1,98 +0,0 @@ -# Interface: UsergroupsUsersUpdateArguments - -## Extends - -- `TokenOverridable`.`OptionalTeamAssignable`.`UsergroupsIncludeCount` - -## Properties - -### include\_count? - -```ts -optional include_count: boolean; -``` - -#### Description - -Include the number of users in each User Group. - -#### Inherited from - -`UsergroupsIncludeCount.include_count` - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L6) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### usergroup - -```ts -usergroup: string; -``` - -#### Description - -The encoded ID of the User Group to update users for. - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:56](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L56) - -*** - -### users - -```ts -users: string; -``` - -#### Description - -A comma separated string of encoded user IDs that represent the entire list of users for -the User Group. - -#### Defined in - -[packages/web-api/src/types/request/usergroups.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L61) diff --git a/docs/content/reference/web-api/interfaces/UsersConversationsArguments.md b/docs/content/reference/web-api/interfaces/UsersConversationsArguments.md deleted file mode 100644 index 57609021d..000000000 --- a/docs/content/reference/web-api/interfaces/UsersConversationsArguments.md +++ /dev/null @@ -1,142 +0,0 @@ -# Interface: UsersConversationsArguments - -## Extends - -- `TokenOverridable`.`CursorPaginationEnabled`.`OptionalTeamAssignable` - -## Properties - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### exclude\_archived? - -```ts -optional exclude_archived: boolean; -``` - -#### Description - -Set to `true` to exclude archived channels from the list. Default is `false`. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L13) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### types? - -```ts -optional types: string; -``` - -#### Description - -Mix and match channel types by providing a comma-separated list of any combination of -`public_channel`, `private_channel`, `mpim` and `im`. Defaults to `public_channel`. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L18) - -*** - -### user? - -```ts -optional user: string; -``` - -#### Description - -Browse conversations by a specific user ID's membership. -Non-public channels are restricted to those where the calling user shares membership. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L23) diff --git a/docs/content/reference/web-api/interfaces/UsersDeletePhotoArguments.md b/docs/content/reference/web-api/interfaces/UsersDeletePhotoArguments.md deleted file mode 100644 index 6fc61ea40..000000000 --- a/docs/content/reference/web-api/interfaces/UsersDeletePhotoArguments.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: UsersDeletePhotoArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersDiscoverableContactsLookupArguments.md b/docs/content/reference/web-api/interfaces/UsersDiscoverableContactsLookupArguments.md deleted file mode 100644 index bf99a36eb..000000000 --- a/docs/content/reference/web-api/interfaces/UsersDiscoverableContactsLookupArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: UsersDiscoverableContactsLookupArguments - -## Extends - -- `Email`.`TokenOverridable` - -## Properties - -### email - -```ts -email: string; -``` - -#### Description - -An email address belonging to a user in the workspace - -#### Inherited from - -`Email.email` - -#### Defined in - -[packages/web-api/src/types/request/users.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L7) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersGetPresenceArguments.md b/docs/content/reference/web-api/interfaces/UsersGetPresenceArguments.md deleted file mode 100644 index a3c1d6d03..000000000 --- a/docs/content/reference/web-api/interfaces/UsersGetPresenceArguments.md +++ /dev/null @@ -1,41 +0,0 @@ -# Interface: UsersGetPresenceArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user? - -```ts -optional user: string; -``` - -#### Description - -User to get presence info on. Defaults to the authed user. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L32) diff --git a/docs/content/reference/web-api/interfaces/UsersIdentityArguments.md b/docs/content/reference/web-api/interfaces/UsersIdentityArguments.md deleted file mode 100644 index 70aac6f5a..000000000 --- a/docs/content/reference/web-api/interfaces/UsersIdentityArguments.md +++ /dev/null @@ -1,25 +0,0 @@ -# Interface: UsersIdentityArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersInfoArguments.md b/docs/content/reference/web-api/interfaces/UsersInfoArguments.md deleted file mode 100644 index 7ea08d370..000000000 --- a/docs/content/reference/web-api/interfaces/UsersInfoArguments.md +++ /dev/null @@ -1,61 +0,0 @@ -# Interface: UsersInfoArguments - -## Extends - -- `TokenOverridable`.`LocaleAware` - -## Properties - -### include\_locale? - -```ts -optional include_locale: boolean; -``` - -#### Description - -Set this to `true` to receive the locale with the response. - -#### Inherited from - -`LocaleAware.include_locale` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L51) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user - -```ts -user: string; -``` - -#### Description - -User to get info on. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:39](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L39) diff --git a/docs/content/reference/web-api/interfaces/UsersListArguments.md b/docs/content/reference/web-api/interfaces/UsersListArguments.md deleted file mode 100644 index 21f88888b..000000000 --- a/docs/content/reference/web-api/interfaces/UsersListArguments.md +++ /dev/null @@ -1,112 +0,0 @@ -# Interface: UsersListArguments - -## Extends - -- `TokenOverridable`.`CursorPaginationEnabled`.`LocaleAware`.`OptionalTeamAssignable` - -## Properties - -### cursor? - -```ts -optional cursor: string; -``` - -#### Description - -Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute -returned by a previous request's `response_metadata`. -Default value fetches the first "page" of the collection. - -#### See - -[pagination](https://api.slack.com/docs/pagination) for more detail. - -#### Inherited from - -`CursorPaginationEnabled.cursor` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L16) - -*** - -### include\_locale? - -```ts -optional include_locale: boolean; -``` - -#### Description - -Set this to `true` to receive the locale with the response. - -#### Inherited from - -`LocaleAware.include_locale` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L51) - -*** - -### limit? - -```ts -optional limit: number; -``` - -#### Description - -The maximum number of items to return. Fewer than the requested number of items may be returned, -even if the end of the list hasn't been reached. Must be an integer with a max value of `999`. Default is `100`. - -#### Inherited from - -`CursorPaginationEnabled.limit` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L9) - -*** - -### team\_id? - -```ts -optional team_id: string; -``` - -#### Description - -If using an org token, `team_id` is required. - -#### Inherited from - -`OptionalTeamAssignable.team_id` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L65) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersLookupByEmailArguments.md b/docs/content/reference/web-api/interfaces/UsersLookupByEmailArguments.md deleted file mode 100644 index 99e647c15..000000000 --- a/docs/content/reference/web-api/interfaces/UsersLookupByEmailArguments.md +++ /dev/null @@ -1,45 +0,0 @@ -# Interface: UsersLookupByEmailArguments - -## Extends - -- `Email`.`TokenOverridable` - -## Properties - -### email - -```ts -email: string; -``` - -#### Description - -An email address belonging to a user in the workspace - -#### Inherited from - -`Email.email` - -#### Defined in - -[packages/web-api/src/types/request/users.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L7) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersProfileGetArguments.md b/docs/content/reference/web-api/interfaces/UsersProfileGetArguments.md deleted file mode 100644 index 4641f11fb..000000000 --- a/docs/content/reference/web-api/interfaces/UsersProfileGetArguments.md +++ /dev/null @@ -1,58 +0,0 @@ -# Interface: UsersProfileGetArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### include\_labels? - -```ts -optional include_labels: boolean; -``` - -#### Description - -Include labels for each ID in custom profile fields. -Using this parameter will heavily rate-limit your requests and is not recommended. Defaults to `false`. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:68](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L68) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user? - -```ts -optional user: string; -``` - -#### Description - -User to retrieve profile info for. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:70](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L70) diff --git a/docs/content/reference/web-api/interfaces/UsersProfileSetArguments.md b/docs/content/reference/web-api/interfaces/UsersProfileSetArguments.md deleted file mode 100644 index 956f683da..000000000 --- a/docs/content/reference/web-api/interfaces/UsersProfileSetArguments.md +++ /dev/null @@ -1,103 +0,0 @@ -# Interface: UsersProfileSetArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### name? - -```ts -optional name: string; -``` - -#### Description - -Name of a single profile field to set. If both `name` and `profile` are set, `name` takes precedence. - -#### See - -[`users.profile.set` Profile fields usage info](https://api.slack.com/methods/users.profile.set#profile-fields). - -#### Defined in - -[packages/web-api/src/types/request/users.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L87) - -*** - -### profile? - -```ts -optional profile: Record; -``` - -#### Description - -Sets profile fields using a single argument. -Collection of key:value pairs presented. -At most 50 fields may be set. Each field name is limited to 255 characters. - -#### See - -[`users.profile.set` Profile fields usage info](https://api.slack.com/methods/users.profile.set#profile-fields). - -#### Defined in - -[packages/web-api/src/types/request/users.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L80) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user? - -```ts -optional user: string; -``` - -#### Description - -ID of user to change. This argument may only be specified by admins on paid teams. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:82](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L82) - -*** - -### value? - -```ts -optional value: string; -``` - -#### Description - -Value to set for the profile field specified by `name`. Usable only if profile is not passed. - -#### See - -[`users.profile.set` Profile fields usage info](https://api.slack.com/methods/users.profile.set#profile-fields). - -#### Defined in - -[packages/web-api/src/types/request/users.ts:92](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L92) diff --git a/docs/content/reference/web-api/interfaces/UsersSelect.md b/docs/content/reference/web-api/interfaces/UsersSelect.md deleted file mode 100644 index bd6778f0a..000000000 --- a/docs/content/reference/web-api/interfaces/UsersSelect.md +++ /dev/null @@ -1,135 +0,0 @@ -# Interface: UsersSelect - -## Description - -This select menu will populate its options with a list of Slack users visible to the current user in the -active workspace. - -## See - - - [Select menu of users reference](https://api.slack.com/reference/block-kit/block-elements#users_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Extends - -- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md).[`Focusable`](Focusable.md).[`Placeholdable`](Placeholdable.md) - -## Properties - -### action\_id? - -```ts -optional action_id: string; -``` - -@description: An identifier for this action. You can use this when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). Should be unique -among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. - -#### Inherited from - -[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### focus\_on\_load? - -```ts -optional focus_on_load: boolean; -``` - -#### Description - -Indicates whether the element will be set to auto focus within the -[`view` object](https://api.slack.com/reference/surfaces/views). Only one element can be set to `true`. -Defaults to `false`. - -#### Inherited from - -[`Focusable`](Focusable.md).[`focus_on_load`](Focusable.md#focus_on_load) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:29 - -*** - -### initial\_user? - -```ts -optional initial_user: string; -``` - -#### Description - -The user ID of any valid user to be pre-selected when the menu loads. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:188 - -*** - -### placeholder? - -```ts -optional placeholder: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) object that defines the placeholder text shown on the element. Maximum -length for the `text` field in this object is 150 characters. - -#### Inherited from - -[`Placeholdable`](Placeholdable.md).[`placeholder`](Placeholdable.md#placeholder) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 - -*** - -### type - -```ts -type: "users_select"; -``` - -#### Description - -The type of element. In this case `type` is always `users_select`. - -#### Overrides - -[`Actionable`](Actionable.md).[`type`](Actionable.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:184 diff --git a/docs/content/reference/web-api/interfaces/UsersSetPhotoArguments.md b/docs/content/reference/web-api/interfaces/UsersSetPhotoArguments.md deleted file mode 100644 index 513aecde0..000000000 --- a/docs/content/reference/web-api/interfaces/UsersSetPhotoArguments.md +++ /dev/null @@ -1,89 +0,0 @@ -# Interface: UsersSetPhotoArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### crop\_w? - -```ts -optional crop_w: number; -``` - -#### Description - -Width/height of crop box (always square). - -#### Defined in - -[packages/web-api/src/types/request/users.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L51) - -*** - -### crop\_x? - -```ts -optional crop_x: number; -``` - -#### Description - -X coordinate of top-left corner of crop box. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:53](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L53) - -*** - -### crop\_y? - -```ts -optional crop_y: number; -``` - -#### Description - -Y coordinate of top-left corner of crop box. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L55) - -*** - -### image - -```ts -image: Buffer | Stream; -``` - -#### Description - -Image file contents. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L49) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/UsersSetPresenceArguments.md b/docs/content/reference/web-api/interfaces/UsersSetPresenceArguments.md deleted file mode 100644 index d6ee8d308..000000000 --- a/docs/content/reference/web-api/interfaces/UsersSetPresenceArguments.md +++ /dev/null @@ -1,41 +0,0 @@ -# Interface: UsersSetPresenceArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### presence - -```ts -presence: "auto" | "away"; -``` - -#### Description - -Either `auto` or `away`. - -#### Defined in - -[packages/web-api/src/types/request/users.ts:60](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/users.ts#L60) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) diff --git a/docs/content/reference/web-api/interfaces/VideoBlock.md b/docs/content/reference/web-api/interfaces/VideoBlock.md deleted file mode 100644 index 8e9814619..000000000 --- a/docs/content/reference/web-api/interfaces/VideoBlock.md +++ /dev/null @@ -1,206 +0,0 @@ -# Interface: VideoBlock - -## Description - -Displays an embedded video player. A video block is designed to embed videos in all app surfaces (e.g. -link unfurls, messages, modals, App Home) — anywhere you can put blocks! To use the video block within your app, you -must have the [`links.embed:write` scope](https://api.slack.com/scopes/links.embed:write). - -## See - -[Video block reference](https://api.slack.com/reference/block-kit/blocks#video). - -## Extends - -- [`Block`](Block.md) - -## Properties - -### alt\_text - -```ts -alt_text: string; -``` - -#### Description - -A tooltip for the video. Required for accessibility. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:203 - -*** - -### author\_name? - -```ts -optional author_name: string; -``` - -#### Description - -Author name to be displayed. Must be less than 50 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:216 - -*** - -### block\_id? - -```ts -optional block_id: string; -``` - -#### Description - -A string acting as a unique identifier for a block. If not specified, a `block_id` will be generated. -You can use this `block_id` when you receive an interaction payload to -[identify the source of the action](https://api.slack.com/interactivity/handling#payloads). -Maximum length for this field is 255 characters. `block_id` should be unique for each message and each iteration of -a message. If a message is updated, use a new `block_id`. - -#### Inherited from - -[`Block`](Block.md).[`block_id`](Block.md#block_id) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:13 - -*** - -### description? - -```ts -optional description: PlainTextElement; -``` - -#### Description - -Description for video using a [PlainTextElement](PlainTextElement.md) object. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:228 - -*** - -### provider\_icon\_url? - -```ts -optional provider_icon_url: string; -``` - -#### Description - -Icon for the video provider, e.g. YouTube icon. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:224 - -*** - -### provider\_name? - -```ts -optional provider_name: string; -``` - -#### Description - -The originating application or domain of the video, e.g. YouTube. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:220 - -*** - -### thumbnail\_url - -```ts -thumbnail_url: string; -``` - -#### Description - -The thumbnail image URL. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:199 - -*** - -### title - -```ts -title: PlainTextElement; -``` - -#### Description - -Video title as a [PlainTextElement](PlainTextElement.md) object. `text` within must be less than 200 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:207 - -*** - -### title\_url? - -```ts -optional title_url: string; -``` - -#### Description - -Hyperlink for the title text. Must correspond to the non-embeddable URL for the video. -Must go to an HTTPS URL. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:212 - -*** - -### type - -```ts -type: "video"; -``` - -#### Description - -The type of block. For a video block, `type` is always `video`. - -#### Overrides - -[`Block`](Block.md).[`type`](Block.md#type) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:189 - -*** - -### video\_url - -```ts -video_url: string; -``` - -#### Description - -The URL to be embedded. Must match any existing -[unfurl domains](https://api.slack.com/reference/messaging/link-unfurling#configuring_domains) within the app -and point to a HTTPS URL. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:195 diff --git a/docs/content/reference/web-api/interfaces/ViewsPublishArguments.md b/docs/content/reference/web-api/interfaces/ViewsPublishArguments.md deleted file mode 100644 index 27746541f..000000000 --- a/docs/content/reference/web-api/interfaces/ViewsPublishArguments.md +++ /dev/null @@ -1,85 +0,0 @@ -# Interface: ViewsPublishArguments - -## Extends - -- `BaseViewsArguments`.`TokenOverridable`.`ViewHash` - -## Properties - -### hash? - -```ts -optional hash: string; -``` - -#### Description - -A string that represents view state to protect against possible race conditions. - -#### See - -[Avoiding race conditions when using views](https://api.slack.com/surfaces/modals#handling_race_conditions). - -#### Inherited from - -`ViewHash.hash` - -#### Defined in - -[packages/web-api/src/types/request/views.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L36) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### user\_id - -```ts -user_id: string; -``` - -#### Description - -ID of the user you want publish a view to. - -#### Defined in - -[packages/web-api/src/types/request/views.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L42) - -*** - -### view - -```ts -view: View; -``` - -#### Description - -A [view payload](https://api.slack.com/reference/surfaces/views). - -#### Inherited from - -`BaseViewsArguments.view` - -#### Defined in - -[packages/web-api/src/types/request/views.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L7) diff --git a/docs/content/reference/web-api/interfaces/WebAPICallResult.md b/docs/content/reference/web-api/interfaces/WebAPICallResult.md deleted file mode 100644 index 7cd7ea695..000000000 --- a/docs/content/reference/web-api/interfaces/WebAPICallResult.md +++ /dev/null @@ -1,73 +0,0 @@ -# Interface: WebAPICallResult - -## Properties - -### error? - -```ts -optional error: string; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:93](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L93) - -*** - -### ok - -```ts -ok: boolean; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:92](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L92) - -*** - -### response\_metadata? - -```ts -optional response_metadata: object; -``` - -#### acceptedScopes? - -```ts -optional acceptedScopes: string[]; -``` - -#### messages? - -```ts -optional messages: string[]; -``` - -#### next\_cursor? - -```ts -optional next_cursor: string; -``` - -#### retryAfter? - -```ts -optional retryAfter: number; -``` - -#### scopes? - -```ts -optional scopes: string[]; -``` - -#### warnings? - -```ts -optional warnings: string[]; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:94](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L94) diff --git a/docs/content/reference/web-api/interfaces/WebAPIHTTPError.md b/docs/content/reference/web-api/interfaces/WebAPIHTTPError.md deleted file mode 100644 index d2d213ab8..000000000 --- a/docs/content/reference/web-api/interfaces/WebAPIHTTPError.md +++ /dev/null @@ -1,167 +0,0 @@ -# Interface: WebAPIHTTPError - -All errors produced by this package adhere to this interface - -## Extends - -- [`CodedError`](CodedError.md) - -## Properties - -### body? - -```ts -optional body: any; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L57) - -*** - -### code - -```ts -code: HTTPError; -``` - -#### Overrides - -[`CodedError`](CodedError.md).[`code`](CodedError.md#code) - -#### Defined in - -[packages/web-api/src/errors.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L52) - -*** - -### errno? - -```ts -optional errno: number; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`errno`](CodedError.md#errno) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:268 - -*** - -### headers - -```ts -headers: IncomingHttpHeaders; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L55) - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`message`](CodedError.md#message) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`name`](CodedError.md#name) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### path? - -```ts -optional path: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`path`](CodedError.md#path) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:270 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`stack`](CodedError.md#stack) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 - -*** - -### statusCode - -```ts -statusCode: number; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:53](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L53) - -*** - -### statusMessage - -```ts -statusMessage: string; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:54](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L54) - -*** - -### syscall? - -```ts -optional syscall: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`syscall`](CodedError.md#syscall) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:271 diff --git a/docs/content/reference/web-api/interfaces/WebAPIPlatformError.md b/docs/content/reference/web-api/interfaces/WebAPIPlatformError.md deleted file mode 100644 index c74976db3..000000000 --- a/docs/content/reference/web-api/interfaces/WebAPIPlatformError.md +++ /dev/null @@ -1,139 +0,0 @@ -# Interface: WebAPIPlatformError - -All errors produced by this package adhere to this interface - -## Extends - -- [`CodedError`](CodedError.md) - -## Properties - -### code - -```ts -code: PlatformError; -``` - -#### Overrides - -[`CodedError`](CodedError.md).[`code`](CodedError.md#code) - -#### Defined in - -[packages/web-api/src/errors.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L40) - -*** - -### data - -```ts -data: WebAPICallResult & object; -``` - -#### Type declaration - -##### error - -```ts -error: string; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L41) - -*** - -### errno? - -```ts -optional errno: number; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`errno`](CodedError.md#errno) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:268 - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`message`](CodedError.md#message) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`name`](CodedError.md#name) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### path? - -```ts -optional path: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`path`](CodedError.md#path) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:270 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`stack`](CodedError.md#stack) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 - -*** - -### syscall? - -```ts -optional syscall: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`syscall`](CodedError.md#syscall) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:271 diff --git a/docs/content/reference/web-api/interfaces/WebAPIRateLimitedError.md b/docs/content/reference/web-api/interfaces/WebAPIRateLimitedError.md deleted file mode 100644 index 0bae9cb23..000000000 --- a/docs/content/reference/web-api/interfaces/WebAPIRateLimitedError.md +++ /dev/null @@ -1,131 +0,0 @@ -# Interface: WebAPIRateLimitedError - -All errors produced by this package adhere to this interface - -## Extends - -- [`CodedError`](CodedError.md) - -## Properties - -### code - -```ts -code: RateLimitedError; -``` - -#### Overrides - -[`CodedError`](CodedError.md).[`code`](CodedError.md#code) - -#### Defined in - -[packages/web-api/src/errors.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L61) - -*** - -### errno? - -```ts -optional errno: number; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`errno`](CodedError.md#errno) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:268 - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`message`](CodedError.md#message) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`name`](CodedError.md#name) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### path? - -```ts -optional path: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`path`](CodedError.md#path) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:270 - -*** - -### retryAfter - -```ts -retryAfter: number; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:62](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L62) - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`stack`](CodedError.md#stack) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 - -*** - -### syscall? - -```ts -optional syscall: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`syscall`](CodedError.md#syscall) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:271 diff --git a/docs/content/reference/web-api/interfaces/WebAPIRequestError.md b/docs/content/reference/web-api/interfaces/WebAPIRequestError.md deleted file mode 100644 index 04fd79c8f..000000000 --- a/docs/content/reference/web-api/interfaces/WebAPIRequestError.md +++ /dev/null @@ -1,131 +0,0 @@ -# Interface: WebAPIRequestError - -All errors produced by this package adhere to this interface - -## Extends - -- [`CodedError`](CodedError.md) - -## Properties - -### code - -```ts -code: RequestError; -``` - -#### Overrides - -[`CodedError`](CodedError.md).[`code`](CodedError.md#code) - -#### Defined in - -[packages/web-api/src/errors.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L47) - -*** - -### errno? - -```ts -optional errno: number; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`errno`](CodedError.md#errno) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:268 - -*** - -### message - -```ts -message: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`message`](CodedError.md#message) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### name - -```ts -name: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`name`](CodedError.md#name) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### original - -```ts -original: Error; -``` - -#### Defined in - -[packages/web-api/src/errors.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L48) - -*** - -### path? - -```ts -optional path: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`path`](CodedError.md#path) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:270 - -*** - -### stack? - -```ts -optional stack: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`stack`](CodedError.md#stack) - -#### Defined in - -docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 - -*** - -### syscall? - -```ts -optional syscall: string; -``` - -#### Inherited from - -[`CodedError`](CodedError.md).[`syscall`](CodedError.md#syscall) - -#### Defined in - -packages/web-api/node\_modules/@types/node/globals.d.ts:271 diff --git a/docs/content/reference/web-api/interfaces/WebClientOptions.md b/docs/content/reference/web-api/interfaces/WebClientOptions.md deleted file mode 100644 index 233716196..000000000 --- a/docs/content/reference/web-api/interfaces/WebClientOptions.md +++ /dev/null @@ -1,154 +0,0 @@ -# Interface: WebClientOptions - -## Properties - -### agent? - -```ts -optional agent: Agent; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:68](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L68) - -*** - -### attachOriginalToWebAPIRequestError? - -```ts -optional attachOriginalToWebAPIRequestError: boolean; -``` - -Indicates whether to attach the original error to a Web API request error. -When set to true, the original error object will be attached to the Web API request error. - -#### Default - -```ts -true -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L80) - -*** - -### headers? - -```ts -optional headers: Record; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:72](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L72) - -*** - -### logLevel? - -```ts -optional logLevel: LogLevel; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L65) - -*** - -### logger? - -```ts -optional logger: Logger; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:64](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L64) - -*** - -### maxRequestConcurrency? - -```ts -optional maxRequestConcurrency: number; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:66](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L66) - -*** - -### rejectRateLimitedCalls? - -```ts -optional rejectRateLimitedCalls: boolean; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:71](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L71) - -*** - -### retryConfig? - -```ts -optional retryConfig: RetryOptions; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L67) - -*** - -### slackApiUrl? - -```ts -optional slackApiUrl: string; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:63](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L63) - -*** - -### teamId? - -```ts -optional teamId: string; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L73) - -*** - -### timeout? - -```ts -optional timeout: number; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:70](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L70) - -*** - -### tls? - -```ts -optional tls: TLSOptions; -``` - -#### Defined in - -[packages/web-api/src/WebClient.ts:69](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L69) diff --git a/docs/content/reference/web-api/interfaces/WorkflowButton.md b/docs/content/reference/web-api/interfaces/WorkflowButton.md deleted file mode 100644 index 198f6c865..000000000 --- a/docs/content/reference/web-api/interfaces/WorkflowButton.md +++ /dev/null @@ -1,153 +0,0 @@ -# Interface: WorkflowButton - -## Description - -Allows users to run a [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) with customizable inputs. - -## See - -[Workflow button element reference](https://api.slack.com/reference/block-kit/block-elements#workflow_button). - -## Extends - -- [`Confirmable`](Confirmable.md) - -## Properties - -### accessibility\_label? - -```ts -optional accessibility_label: string; -``` - -#### Description - -A label for longer descriptive text about a button element. This label will be read out by screen -readers instead of the button `text` object. Maximum length for this field is 75 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:630 - -*** - -### confirm? - -```ts -optional confirm: ConfirmationDialog; -``` - -#### Description - -A [Confirm](Confirm.md) object that defines an optional confirmation dialog after the element is interacted -with. - -#### Inherited from - -[`Confirmable`](Confirmable.md).[`confirm`](Confirmable.md#confirm) - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 - -*** - -### style? - -```ts -optional style: "danger" | "primary"; -``` - -#### Description - -Decorates buttons with alternative visual color schemes. Use this option with restraint. -`primary` gives buttons a green outline and text, ideal for affirmation or confirmation actions. `primary` should -only be used for one button within a set. -`danger` gives buttons a red outline and text, and should be used when the action is destructive. Use `danger` even -more sparingly than primary. -If you don't include this field, the default button style will be used. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:625 - -*** - -### text - -```ts -text: PlainTextElement; -``` - -#### Description - -A [PlainTextElement](PlainTextElement.md) that defines the button's text. `text` may truncate with ~30 characters. -Maximum length for the `text` in this field is 75 characters. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:585 - -*** - -### type - -```ts -type: "workflow_button"; -``` - -#### Description - -The type of element. In this case `type` is always `workflow_button`. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:580 - -*** - -### workflow - -```ts -workflow: object; -``` - -#### trigger - -```ts -trigger: object; -``` - -##### Description - -Properties of the [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) -that will be invoked via this button. - -#### trigger.customizable\_input\_parameters? - -```ts -optional customizable_input_parameters: object[]; -``` - -##### Description - -List of customizable input parameters and their values. Should match input parameters specified on -the provided trigger. - -#### trigger.url - -```ts -url: string; -``` - -##### Description - -The trigger URL of the [link trigger](https://api.slack.com/automation/triggers/link#workflow_buttons) - -#### Description - -A workflow object that contains details about the workflow that will run when the button is clicked. - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:589 diff --git a/docs/content/reference/web-api/interfaces/WorkflowStepView.md b/docs/content/reference/web-api/interfaces/WorkflowStepView.md deleted file mode 100644 index 9ffa47536..000000000 --- a/docs/content/reference/web-api/interfaces/WorkflowStepView.md +++ /dev/null @@ -1,79 +0,0 @@ -# Interface: ~~WorkflowStepView~~ - -[Configuration modal](https://api.slack.com/legacy/workflows/steps#handle_config_view) for [legacy Workflow Steps from Apps](https://api.slack.com/legacy/workflows/steps). - -## Deprecated - -Steps from Apps are deprecated and will no longer be executed starting September 12, 2024. For more information, see our [deprecation announcement](https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back). - -## Properties - -### ~~blocks~~ - -```ts -blocks: (Block | KnownBlock)[]; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:28 - -*** - -### ~~callback\_id?~~ - -```ts -optional callback_id: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:30 - -*** - -### ~~external\_id?~~ - -```ts -optional external_id: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:32 - -*** - -### ~~private\_metadata?~~ - -```ts -optional private_metadata: string; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:29 - -*** - -### ~~submit\_disabled?~~ - -```ts -optional submit_disabled: boolean; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:31 - -*** - -### ~~type~~ - -```ts -type: "workflow_step"; -``` - -#### Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:27 diff --git a/docs/content/reference/web-api/interfaces/WorkflowsStepCompletedArguments.md b/docs/content/reference/web-api/interfaces/WorkflowsStepCompletedArguments.md deleted file mode 100644 index ec0e0c1b5..000000000 --- a/docs/content/reference/web-api/interfaces/WorkflowsStepCompletedArguments.md +++ /dev/null @@ -1,49 +0,0 @@ -# Interface: WorkflowsStepCompletedArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### outputs? - -```ts -optional outputs: Record; -``` - -#### Defined in - -[packages/web-api/src/types/request/workflows.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L9) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### workflow\_step\_execute\_id - -```ts -workflow_step_execute_id: string; -``` - -#### Defined in - -[packages/web-api/src/types/request/workflows.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L8) diff --git a/docs/content/reference/web-api/interfaces/WorkflowsStepFailedArguments.md b/docs/content/reference/web-api/interfaces/WorkflowsStepFailedArguments.md deleted file mode 100644 index 5b766087f..000000000 --- a/docs/content/reference/web-api/interfaces/WorkflowsStepFailedArguments.md +++ /dev/null @@ -1,55 +0,0 @@ -# Interface: WorkflowsStepFailedArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### error - -```ts -error: object; -``` - -#### message - -```ts -message: string; -``` - -#### Defined in - -[packages/web-api/src/types/request/workflows.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L14) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### workflow\_step\_execute\_id - -```ts -workflow_step_execute_id: string; -``` - -#### Defined in - -[packages/web-api/src/types/request/workflows.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L13) diff --git a/docs/content/reference/web-api/interfaces/WorkflowsUpdateStepArguments.md b/docs/content/reference/web-api/interfaces/WorkflowsUpdateStepArguments.md deleted file mode 100644 index 0390e1dec..000000000 --- a/docs/content/reference/web-api/interfaces/WorkflowsUpdateStepArguments.md +++ /dev/null @@ -1,89 +0,0 @@ -# Interface: WorkflowsUpdateStepArguments - -## Extends - -- `TokenOverridable` - -## Properties - -### inputs? - -```ts -optional inputs: object; -``` - -#### Index Signature - - \[`name`: `string`\]: `object` - -#### Defined in - -[packages/web-api/src/types/request/workflows.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L23) - -*** - -### outputs? - -```ts -optional outputs: object[]; -``` - -#### Defined in - -[packages/web-api/src/types/request/workflows.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L34) - -*** - -### step\_image\_url? - -```ts -optional step_image_url: string; -``` - -#### Defined in - -[packages/web-api/src/types/request/workflows.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L21) - -*** - -### step\_name? - -```ts -optional step_name: string; -``` - -#### Defined in - -[packages/web-api/src/types/request/workflows.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L22) - -*** - -### token? - -```ts -optional token: string; -``` - -#### Description - -Overridable authentication token bearing required scopes. - -#### Inherited from - -`TokenOverridable.token` - -#### Defined in - -[packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) - -*** - -### workflow\_step\_edit\_id - -```ts -workflow_step_edit_id: string; -``` - -#### Defined in - -[packages/web-api/src/types/request/workflows.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/workflows.ts#L20) diff --git a/docs/content/reference/web-api/type-aliases/APITestArguments.md b/docs/content/reference/web-api/type-aliases/APITestArguments.md deleted file mode 100644 index 608e79b7d..000000000 --- a/docs/content/reference/web-api/type-aliases/APITestArguments.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: APITestArguments - -```ts -type APITestArguments: OptionalArgument; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -#### Description - -Error response to return. - -## Defined in - -[packages/web-api/src/types/request/api.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/api.ts#L4) diff --git a/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileArguments.md b/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileArguments.md deleted file mode 100644 index f9c7a1e3a..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminAnalyticsGetFileArguments - -```ts -type AdminAnalyticsGetFileArguments: TokenOverridable & MemberArgs | PublicChannelArgs; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/analytics.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/analytics.ts#L44) diff --git a/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileResponse.md b/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileResponse.md deleted file mode 100644 index 45bc209ac..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAnalyticsGetFileResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminAnalyticsGetFileResponse - -```ts -type AdminAnalyticsGetFileResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### file\_data? - -```ts -optional file_data: (AdminAnalyticsMemberDetails | AdminAnalyticsPublicChannelDetails | AdminAnalyticsPublicChannelMetadataDetails)[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAnalyticsGetFileResponse.ts#L4) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListArguments.md deleted file mode 100644 index 0451934b4..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminAppsActivitiesListArguments - -```ts -type AdminAppsActivitiesListArguments: OptionalArgument & Partial & TokenOverridable & CursorPaginationEnabled & object>; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/apps.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L29) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListResponse.md deleted file mode 100644 index 72b43cdc2..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsActivitiesListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminAppsActivitiesListResponse - -```ts -type AdminAppsActivitiesListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### activities? - -```ts -optional activities: Activity[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAppsActivitiesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsActivitiesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsApproveArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsApproveArguments.md deleted file mode 100644 index 5cf57cc72..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsApproveArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminAppsApproveArguments - -```ts -type AdminAppsApproveArguments: AppOrRequestID & TeamOrEnterpriseID & TokenOverridable; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/apps.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L55) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsApproveResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsApproveResponse.md deleted file mode 100644 index 69d36ad34..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsApproveResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminAppsApproveResponse - -```ts -type AdminAppsApproveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAppsApproveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsApproveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListArguments.md deleted file mode 100644 index b4d0efd60..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminAppsApprovedListArguments - -```ts -type AdminAppsApprovedListArguments: Partial & TokenOverridable & CursorPaginationEnabled & Certified; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/apps.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L58) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListResponse.md deleted file mode 100644 index 42efda7c9..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsApprovedListResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: AdminAppsApprovedListResponse - -```ts -type AdminAppsApprovedListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### approved\_apps? - -```ts -optional approved_apps: ApprovedApp[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAppsApprovedListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsApprovedListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionArguments.md deleted file mode 100644 index c61aeaabb..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminAppsClearResolutionArguments - -```ts -type AdminAppsClearResolutionArguments: AppID & TeamOrEnterpriseID; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/apps.ts:62](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L62) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionResponse.md deleted file mode 100644 index 026e4eb81..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsClearResolutionResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminAppsClearResolutionResponse - -```ts -type AdminAppsClearResolutionResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAppsClearResolutionResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsClearResolutionResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsConfigLookupResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsConfigLookupResponse.md deleted file mode 100644 index 6f2aa1dc6..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsConfigLookupResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminAppsConfigLookupResponse - -```ts -type AdminAppsConfigLookupResponse: WebAPICallResult & object; -``` - -## Type declaration - -### configs? - -```ts -optional configs: Config[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAppsConfigLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsConfigLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsConfigSetResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsConfigSetResponse.md deleted file mode 100644 index a7aa6a2cc..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsConfigSetResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminAppsConfigSetResponse - -```ts -type AdminAppsConfigSetResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAppsConfigSetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsConfigSetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelArguments.md deleted file mode 100644 index 6b62cb53c..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminAppsRequestsCancelArguments - -```ts -type AdminAppsRequestsCancelArguments: RequestID & TeamOrEnterpriseID & TokenOverridable; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/apps.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L84) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelResponse.md deleted file mode 100644 index 3933afbd0..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsCancelResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminAppsRequestsCancelResponse - -```ts -type AdminAppsRequestsCancelResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAppsRequestsCancelResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsRequestsCancelResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListArguments.md deleted file mode 100644 index 61bd2e11b..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminAppsRequestsListArguments - -```ts -type AdminAppsRequestsListArguments: TeamOrEnterpriseID & Certified & TokenOverridable & CursorPaginationEnabled; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/apps.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L87) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListResponse.md deleted file mode 100644 index 956ef1abe..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsRequestsListResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: AdminAppsRequestsListResponse - -```ts -type AdminAppsRequestsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### app\_requests? - -```ts -optional app_requests: AppRequest[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAppsRequestsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsRequestsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictArguments.md deleted file mode 100644 index 33efa5dcb..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminAppsRestrictArguments - -```ts -type AdminAppsRestrictArguments: AppOrRequestID & TeamOrEnterpriseID & TokenOverridable; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/apps.ts:91](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L91) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictResponse.md deleted file mode 100644 index e2179528f..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminAppsRestrictResponse - -```ts -type AdminAppsRestrictResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAppsRestrictResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsRestrictResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListArguments.md deleted file mode 100644 index 5af19dc30..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminAppsRestrictedListArguments - -```ts -type AdminAppsRestrictedListArguments: TeamOrEnterpriseID & Certified & TokenOverridable & CursorPaginationEnabled; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/apps.ts:94](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L94) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListResponse.md deleted file mode 100644 index 8fb3398a4..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsRestrictedListResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: AdminAppsRestrictedListResponse - -```ts -type AdminAppsRestrictedListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### restricted\_apps? - -```ts -optional restricted_apps: RestrictedApp[]; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAppsRestrictedListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsRestrictedListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsUninstallArguments.md b/docs/content/reference/web-api/type-aliases/AdminAppsUninstallArguments.md deleted file mode 100644 index 86f2e3ff2..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsUninstallArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminAppsUninstallArguments - -```ts -type AdminAppsUninstallArguments: AppID & TeamOrEnterpriseID; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/apps.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/apps.ts#L98) diff --git a/docs/content/reference/web-api/type-aliases/AdminAppsUninstallResponse.md b/docs/content/reference/web-api/type-aliases/AdminAppsUninstallResponse.md deleted file mode 100644 index bd246ebab..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAppsUninstallResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminAppsUninstallResponse - -```ts -type AdminAppsUninstallResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAppsUninstallResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAppsUninstallResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAuthPolicyAssignEntitiesResponse.md b/docs/content/reference/web-api/type-aliases/AdminAuthPolicyAssignEntitiesResponse.md deleted file mode 100644 index b95775790..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAuthPolicyAssignEntitiesResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminAuthPolicyAssignEntitiesResponse - -```ts -type AdminAuthPolicyAssignEntitiesResponse: WebAPICallResult & object; -``` - -## Type declaration - -### entity\_total\_count? - -```ts -optional entity_total_count: number; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAuthPolicyAssignEntitiesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAuthPolicyAssignEntitiesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAuthPolicyGetEntitiesResponse.md b/docs/content/reference/web-api/type-aliases/AdminAuthPolicyGetEntitiesResponse.md deleted file mode 100644 index c5fbc6563..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAuthPolicyGetEntitiesResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminAuthPolicyGetEntitiesResponse - -```ts -type AdminAuthPolicyGetEntitiesResponse: WebAPICallResult & object; -``` - -## Type declaration - -### entities? - -```ts -optional entities: Entity[]; -``` - -### entity\_total\_count? - -```ts -optional entity_total_count: number; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAuthPolicyGetEntitiesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAuthPolicyGetEntitiesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminAuthPolicyRemoveEntitiesResponse.md b/docs/content/reference/web-api/type-aliases/AdminAuthPolicyRemoveEntitiesResponse.md deleted file mode 100644 index ede5beadb..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminAuthPolicyRemoveEntitiesResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminAuthPolicyRemoveEntitiesResponse - -```ts -type AdminAuthPolicyRemoveEntitiesResponse: WebAPICallResult & object; -``` - -## Type declaration - -### entity\_total\_count? - -```ts -optional entity_total_count: number; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminAuthPolicyRemoveEntitiesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminAuthPolicyRemoveEntitiesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminBarriersCreateResponse.md b/docs/content/reference/web-api/type-aliases/AdminBarriersCreateResponse.md deleted file mode 100644 index 2968a79d9..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminBarriersCreateResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminBarriersCreateResponse - -```ts -type AdminBarriersCreateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### barrier? - -```ts -optional barrier: Barrier; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminBarriersCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminBarriersCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminBarriersDeleteResponse.md b/docs/content/reference/web-api/type-aliases/AdminBarriersDeleteResponse.md deleted file mode 100644 index 92bc8312f..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminBarriersDeleteResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminBarriersDeleteResponse - -```ts -type AdminBarriersDeleteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminBarriersDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminBarriersDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminBarriersListArguments.md b/docs/content/reference/web-api/type-aliases/AdminBarriersListArguments.md deleted file mode 100644 index d9b4b0e62..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminBarriersListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminBarriersListArguments - -```ts -type AdminBarriersListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/barriers.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/barriers.ts#L27) diff --git a/docs/content/reference/web-api/type-aliases/AdminBarriersListResponse.md b/docs/content/reference/web-api/type-aliases/AdminBarriersListResponse.md deleted file mode 100644 index 3d9ed58da..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminBarriersListResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminBarriersListResponse - -```ts -type AdminBarriersListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### barriers? - -```ts -optional barriers: Barrier[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminBarriersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminBarriersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminBarriersUpdateResponse.md b/docs/content/reference/web-api/type-aliases/AdminBarriersUpdateResponse.md deleted file mode 100644 index f1c665954..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminBarriersUpdateResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminBarriersUpdateResponse - -```ts -type AdminBarriersUpdateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### barrier? - -```ts -optional barrier: Barrier; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminBarriersUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminBarriersUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsArchiveResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsArchiveResponse.md deleted file mode 100644 index fce99cda4..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsArchiveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminConversationsArchiveResponse - -```ts -type AdminConversationsArchiveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsArchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsArchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsBulkArchiveResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsBulkArchiveResponse.md deleted file mode 100644 index c914058f9..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsBulkArchiveResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: AdminConversationsBulkArchiveResponse - -```ts -type AdminConversationsBulkArchiveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### bulk\_action\_id? - -```ts -optional bulk_action_id: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### not\_added? - -```ts -optional not_added: NotAdded[]; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsBulkArchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsBulkArchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsBulkDeleteResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsBulkDeleteResponse.md deleted file mode 100644 index 0a83ac72c..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsBulkDeleteResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: AdminConversationsBulkDeleteResponse - -```ts -type AdminConversationsBulkDeleteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### bulk\_action\_id? - -```ts -optional bulk_action_id: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### not\_added? - -```ts -optional not_added: NotAdded[]; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsBulkDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsBulkDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsBulkMoveResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsBulkMoveResponse.md deleted file mode 100644 index 048a65470..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsBulkMoveResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: AdminConversationsBulkMoveResponse - -```ts -type AdminConversationsBulkMoveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### bulk\_action\_id? - -```ts -optional bulk_action_id: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### not\_added? - -```ts -optional not_added: NotAdded[]; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsBulkMoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsBulkMoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPrivateResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPrivateResponse.md deleted file mode 100644 index 684d9b9cd..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPrivateResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminConversationsConvertToPrivateResponse - -```ts -type AdminConversationsConvertToPrivateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsConvertToPrivateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsConvertToPrivateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPublicResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPublicResponse.md deleted file mode 100644 index 7a32de827..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsConvertToPublicResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminConversationsConvertToPublicResponse - -```ts -type AdminConversationsConvertToPublicResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsConvertToPublicResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsConvertToPublicResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsCreateArguments.md b/docs/content/reference/web-api/type-aliases/AdminConversationsCreateArguments.md deleted file mode 100644 index d65f91c8f..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsCreateArguments.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminConversationsCreateArguments - -```ts -type AdminConversationsCreateArguments: TokenOverridable & WorkspaceAccess & object; -``` - -## Type declaration - -### description? - -```ts -optional description: string; -``` - -#### Description - -Description of the public or private channel to create. - -### is\_private - -```ts -is_private: boolean; -``` - -#### Description - -When `true`, creates a private channel instead of a public channel. - -### name - -```ts -name: string; -``` - -#### Description - -Name of the public or private channel to create. - -## Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:81](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L81) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsCreateResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsCreateResponse.md deleted file mode 100644 index cafb56265..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsCreateResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminConversationsCreateResponse - -```ts -type AdminConversationsCreateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel\_id? - -```ts -optional channel_id: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsDeleteResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsDeleteResponse.md deleted file mode 100644 index a25d96b3d..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsDeleteResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminConversationsDeleteResponse - -```ts -type AdminConversationsDeleteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsDisconnectSharedResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsDisconnectSharedResponse.md deleted file mode 100644 index a669bf27c..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsDisconnectSharedResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminConversationsDisconnectSharedResponse - -```ts -type AdminConversationsDisconnectSharedResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsDisconnectSharedResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsDisconnectSharedResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsEKMListOriginalConnectedChannelInfoArguments.md b/docs/content/reference/web-api/type-aliases/AdminConversationsEKMListOriginalConnectedChannelInfoArguments.md deleted file mode 100644 index 5e7f9128f..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsEKMListOriginalConnectedChannelInfoArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminConversationsEKMListOriginalConnectedChannelInfoArguments - -```ts -type AdminConversationsEKMListOriginalConnectedChannelInfoArguments: OptionalArgument & TokenOverridable & CursorPaginationEnabled & object>; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L100) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.md deleted file mode 100644 index 24be302cc..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminConversationsEkmListOriginalConnectedChannelInfoResponse - -```ts -type AdminConversationsEkmListOriginalConnectedChannelInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsEkmListOriginalConnectedChannelInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsGetConversationPrefsResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsGetConversationPrefsResponse.md deleted file mode 100644 index 86667f227..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsGetConversationPrefsResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminConversationsGetConversationPrefsResponse - -```ts -type AdminConversationsGetConversationPrefsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### prefs? - -```ts -optional prefs: Prefs; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsGetConversationPrefsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsGetConversationPrefsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsGetCustomRetentionResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsGetCustomRetentionResponse.md deleted file mode 100644 index 648310dac..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsGetCustomRetentionResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminConversationsGetCustomRetentionResponse - -```ts -type AdminConversationsGetCustomRetentionResponse: WebAPICallResult & object; -``` - -## Type declaration - -### duration\_days? - -```ts -optional duration_days: number; -``` - -### error? - -```ts -optional error: string; -``` - -### is\_policy\_enabled? - -```ts -optional is_policy_enabled: boolean; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsGetCustomRetentionResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsGetCustomRetentionResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsGetTeamsResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsGetTeamsResponse.md deleted file mode 100644 index 6844e1360..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsGetTeamsResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminConversationsGetTeamsResponse - -```ts -type AdminConversationsGetTeamsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### team\_ids? - -```ts -optional team_ids: string[]; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsGetTeamsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsGetTeamsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsInviteResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsInviteResponse.md deleted file mode 100644 index 2f5b88c61..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsInviteResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminConversationsInviteResponse - -```ts -type AdminConversationsInviteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### failed\_user\_ids? - -```ts -optional failed_user_ids: FailedUserids; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsLookupResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsLookupResponse.md deleted file mode 100644 index b702c4e70..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsLookupResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminConversationsLookupResponse - -```ts -type AdminConversationsLookupResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel\_ids? - -```ts -optional channel_ids: string[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsRemoveCustomRetentionResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsRemoveCustomRetentionResponse.md deleted file mode 100644 index fb56b5f57..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsRemoveCustomRetentionResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminConversationsRemoveCustomRetentionResponse - -```ts -type AdminConversationsRemoveCustomRetentionResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsRemoveCustomRetentionResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsRemoveCustomRetentionResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsRenameResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsRenameResponse.md deleted file mode 100644 index 01dff0957..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsRenameResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminConversationsRenameResponse - -```ts -type AdminConversationsRenameResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsRenameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsRenameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessAddGroupResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessAddGroupResponse.md deleted file mode 100644 index 9701db635..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessAddGroupResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminConversationsRestrictAccessAddGroupResponse - -```ts -type AdminConversationsRestrictAccessAddGroupResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsRestrictAccessAddGroupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsRestrictAccessAddGroupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessListGroupsResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessListGroupsResponse.md deleted file mode 100644 index 37353abfc..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessListGroupsResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminConversationsRestrictAccessListGroupsResponse - -```ts -type AdminConversationsRestrictAccessListGroupsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### group\_ids? - -```ts -optional group_ids: string[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsRestrictAccessListGroupsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsRestrictAccessListGroupsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessRemoveGroupResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessRemoveGroupResponse.md deleted file mode 100644 index 756fc431c..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsRestrictAccessRemoveGroupResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminConversationsRestrictAccessRemoveGroupResponse - -```ts -type AdminConversationsRestrictAccessRemoveGroupResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsRestrictAccessRemoveGroupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsRestrictAccessRemoveGroupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsSearchArguments.md b/docs/content/reference/web-api/type-aliases/AdminConversationsSearchArguments.md deleted file mode 100644 index ea1f8db29..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsSearchArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminConversationsSearchArguments - -```ts -type AdminConversationsSearchArguments: OptionalArgument & TokenOverridable & CursorPaginationEnabled & object>; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/conversations.ts:153](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/conversations.ts#L153) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsSearchResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsSearchResponse.md deleted file mode 100644 index 6eee36532..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsSearchResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -# Type Alias: AdminConversationsSearchResponse - -```ts -type AdminConversationsSearchResponse: WebAPICallResult & object; -``` - -## Type declaration - -### conversations? - -```ts -optional conversations: Conversation[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### next\_cursor? - -```ts -optional next_cursor: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### total\_count? - -```ts -optional total_count: number; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsSearchResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsSearchResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsSetConversationPrefsResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsSetConversationPrefsResponse.md deleted file mode 100644 index c3393c39a..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsSetConversationPrefsResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminConversationsSetConversationPrefsResponse - -```ts -type AdminConversationsSetConversationPrefsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsSetConversationPrefsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsSetConversationPrefsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsSetCustomRetentionResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsSetCustomRetentionResponse.md deleted file mode 100644 index 75aa99a93..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsSetCustomRetentionResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminConversationsSetCustomRetentionResponse - -```ts -type AdminConversationsSetCustomRetentionResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsSetCustomRetentionResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsSetCustomRetentionResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsSetTeamsResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsSetTeamsResponse.md deleted file mode 100644 index fc8c6d0de..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsSetTeamsResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminConversationsSetTeamsResponse - -```ts -type AdminConversationsSetTeamsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsSetTeamsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsSetTeamsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsUnarchiveResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsUnarchiveResponse.md deleted file mode 100644 index 0025a2a98..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsUnarchiveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminConversationsUnarchiveResponse - -```ts -type AdminConversationsUnarchiveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsUnarchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsUnarchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistAddResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistAddResponse.md deleted file mode 100644 index 4ed71d345..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistAddResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminConversationsWhitelistAddResponse - -```ts -type AdminConversationsWhitelistAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsWhitelistAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsWhitelistAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.md deleted file mode 100644 index 727b9abc4..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: AdminConversationsWhitelistListGroupsLinkedToChannelResponse - -```ts -type AdminConversationsWhitelistListGroupsLinkedToChannelResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### group\_ids? - -```ts -optional group_ids: string[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsWhitelistListGroupsLinkedToChannelResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistRemoveResponse.md b/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistRemoveResponse.md deleted file mode 100644 index 38d690018..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminConversationsWhitelistRemoveResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminConversationsWhitelistRemoveResponse - -```ts -type AdminConversationsWhitelistRemoveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminConversationsWhitelistRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminConversationsWhitelistRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiAddAliasResponse.md b/docs/content/reference/web-api/type-aliases/AdminEmojiAddAliasResponse.md deleted file mode 100644 index a50b506a0..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminEmojiAddAliasResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminEmojiAddAliasResponse - -```ts -type AdminEmojiAddAliasResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminEmojiAddAliasResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminEmojiAddAliasResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiAddResponse.md b/docs/content/reference/web-api/type-aliases/AdminEmojiAddResponse.md deleted file mode 100644 index 29264cd8e..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminEmojiAddResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminEmojiAddResponse - -```ts -type AdminEmojiAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminEmojiAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminEmojiAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiListArguments.md b/docs/content/reference/web-api/type-aliases/AdminEmojiListArguments.md deleted file mode 100644 index ccac7a109..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminEmojiListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminEmojiListArguments - -```ts -type AdminEmojiListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/emoji.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/emoji.ts#L32) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiListResponse.md b/docs/content/reference/web-api/type-aliases/AdminEmojiListResponse.md deleted file mode 100644 index 69f23043b..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminEmojiListResponse.md +++ /dev/null @@ -1,51 +0,0 @@ -# Type Alias: AdminEmojiListResponse - -```ts -type AdminEmojiListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### emoji? - -```ts -optional emoji: object; -``` - -#### Index Signature - - \[`key`: `string`\]: `Emoji` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminEmojiListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminEmojiListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiRemoveResponse.md b/docs/content/reference/web-api/type-aliases/AdminEmojiRemoveResponse.md deleted file mode 100644 index 845ae8e81..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminEmojiRemoveResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminEmojiRemoveResponse - -```ts -type AdminEmojiRemoveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminEmojiRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminEmojiRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminEmojiRenameResponse.md b/docs/content/reference/web-api/type-aliases/AdminEmojiRenameResponse.md deleted file mode 100644 index 381753e90..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminEmojiRenameResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminEmojiRenameResponse - -```ts -type AdminEmojiRenameResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminEmojiRenameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminEmojiRenameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminFunctionsListResponse.md b/docs/content/reference/web-api/type-aliases/AdminFunctionsListResponse.md deleted file mode 100644 index 6f123aae4..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminFunctionsListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminFunctionsListResponse - -```ts -type AdminFunctionsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### functions? - -```ts -optional functions: Function[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminFunctionsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminFunctionsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsLookupResponse.md b/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsLookupResponse.md deleted file mode 100644 index 1cbcceab5..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsLookupResponse.md +++ /dev/null @@ -1,57 +0,0 @@ -# Type Alias: AdminFunctionsPermissionsLookupResponse - -```ts -type AdminFunctionsPermissionsLookupResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### errors? - -```ts -optional errors: Errors; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### permissions? - -```ts -optional permissions: object; -``` - -#### Index Signature - - \[`key`: `string`\]: `Permission` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminFunctionsPermissionsLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminFunctionsPermissionsLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsSetResponse.md b/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsSetResponse.md deleted file mode 100644 index 355dd0d2d..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminFunctionsPermissionsSetResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminFunctionsPermissionsSetResponse - -```ts -type AdminFunctionsPermissionsSetResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminFunctionsPermissionsSetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminFunctionsPermissionsSetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApproveResponse.md b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApproveResponse.md deleted file mode 100644 index aaa3935a4..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApproveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminInviteRequestsApproveResponse - -```ts -type AdminInviteRequestsApproveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminInviteRequestsApproveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminInviteRequestsApproveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApprovedListResponse.md b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApprovedListResponse.md deleted file mode 100644 index 060ccb13c..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsApprovedListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminInviteRequestsApprovedListResponse - -```ts -type AdminInviteRequestsApprovedListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### approved\_requests? - -```ts -optional approved_requests: ApprovedRequest[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminInviteRequestsApprovedListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminInviteRequestsApprovedListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDeniedListResponse.md b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDeniedListResponse.md deleted file mode 100644 index 431484cb5..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDeniedListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminInviteRequestsDeniedListResponse - -```ts -type AdminInviteRequestsDeniedListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### denied\_requests? - -```ts -optional denied_requests: DeniedRequest[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminInviteRequestsDeniedListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminInviteRequestsDeniedListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDenyResponse.md b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDenyResponse.md deleted file mode 100644 index 2257d3053..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsDenyResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminInviteRequestsDenyResponse - -```ts -type AdminInviteRequestsDenyResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminInviteRequestsDenyResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminInviteRequestsDenyResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsListResponse.md b/docs/content/reference/web-api/type-aliases/AdminInviteRequestsListResponse.md deleted file mode 100644 index 0764ccf0a..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminInviteRequestsListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminInviteRequestsListResponse - -```ts -type AdminInviteRequestsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### invite\_requests? - -```ts -optional invite_requests: InviteRequest[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminInviteRequestsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminInviteRequestsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminRolesAddAssignmentsResponse.md b/docs/content/reference/web-api/type-aliases/AdminRolesAddAssignmentsResponse.md deleted file mode 100644 index bc376c72a..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminRolesAddAssignmentsResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminRolesAddAssignmentsResponse - -```ts -type AdminRolesAddAssignmentsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### rejected\_users? - -```ts -optional rejected_users: RejectedUser[]; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminRolesAddAssignmentsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminRolesAddAssignmentsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsArguments.md b/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsArguments.md deleted file mode 100644 index b7c96bfec..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminRolesListAssignmentsArguments - -```ts -type AdminRolesListAssignmentsArguments: OptionalArgument & TokenOverridable & CursorPaginationEnabled & SortDir & object>; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/roles.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/roles.ts#L25) diff --git a/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsResponse.md b/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsResponse.md deleted file mode 100644 index 06bc3352d..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminRolesListAssignmentsResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminRolesListAssignmentsResponse - -```ts -type AdminRolesListAssignmentsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### role\_assignments? - -```ts -optional role_assignments: RoleAssignment[]; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminRolesListAssignmentsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminRolesListAssignmentsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminRolesRemoveAssignmentsResponse.md b/docs/content/reference/web-api/type-aliases/AdminRolesRemoveAssignmentsResponse.md deleted file mode 100644 index 12042bf01..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminRolesRemoveAssignmentsResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminRolesRemoveAssignmentsResponse - -```ts -type AdminRolesRemoveAssignmentsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminRolesRemoveAssignmentsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminRolesRemoveAssignmentsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsAdminsListResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsAdminsListResponse.md deleted file mode 100644 index 862347c8f..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminTeamsAdminsListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminTeamsAdminsListResponse - -```ts -type AdminTeamsAdminsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### admin\_ids? - -```ts -optional admin_ids: string[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminTeamsAdminsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsAdminsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsCreateResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsCreateResponse.md deleted file mode 100644 index bb90b4f52..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminTeamsCreateResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminTeamsCreateResponse - -```ts -type AdminTeamsCreateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### team? - -```ts -optional team: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminTeamsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsListArguments.md b/docs/content/reference/web-api/type-aliases/AdminTeamsListArguments.md deleted file mode 100644 index 3071782b8..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminTeamsListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminTeamsListArguments - -```ts -type AdminTeamsListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/teams.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/teams.ts#L23) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsListResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsListResponse.md deleted file mode 100644 index 922261718..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminTeamsListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminTeamsListResponse - -```ts -type AdminTeamsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### teams? - -```ts -optional teams: Team[]; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminTeamsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsOwnersListResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsOwnersListResponse.md deleted file mode 100644 index ba7b1682e..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminTeamsOwnersListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminTeamsOwnersListResponse - -```ts -type AdminTeamsOwnersListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### owner\_ids? - -```ts -optional owner_ids: string[]; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminTeamsOwnersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsOwnersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsInfoResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsInfoResponse.md deleted file mode 100644 index be7c592e8..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsInfoResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminTeamsSettingsInfoResponse - -```ts -type AdminTeamsSettingsInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### team? - -```ts -optional team: Team; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminTeamsSettingsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDefaultChannelsResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDefaultChannelsResponse.md deleted file mode 100644 index 6ce27fe47..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDefaultChannelsResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminTeamsSettingsSetDefaultChannelsResponse - -```ts -type AdminTeamsSettingsSetDefaultChannelsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminTeamsSettingsSetDefaultChannelsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsSetDefaultChannelsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDescriptionResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDescriptionResponse.md deleted file mode 100644 index eebf471c8..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDescriptionResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminTeamsSettingsSetDescriptionResponse - -```ts -type AdminTeamsSettingsSetDescriptionResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminTeamsSettingsSetDescriptionResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsSetDescriptionResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDiscoverabilityResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDiscoverabilityResponse.md deleted file mode 100644 index 975c4de1a..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetDiscoverabilityResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminTeamsSettingsSetDiscoverabilityResponse - -```ts -type AdminTeamsSettingsSetDiscoverabilityResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminTeamsSettingsSetDiscoverabilityResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsSetDiscoverabilityResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetIconResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetIconResponse.md deleted file mode 100644 index affc17940..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetIconResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminTeamsSettingsSetIconResponse - -```ts -type AdminTeamsSettingsSetIconResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminTeamsSettingsSetIconResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsSetIconResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetNameResponse.md b/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetNameResponse.md deleted file mode 100644 index 08956b092..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminTeamsSettingsSetNameResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminTeamsSettingsSetNameResponse - -```ts -type AdminTeamsSettingsSetNameResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminTeamsSettingsSetNameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminTeamsSettingsSetNameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddChannelsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddChannelsResponse.md deleted file mode 100644 index f9b5e0fd0..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddChannelsResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsergroupsAddChannelsResponse - -```ts -type AdminUsergroupsAddChannelsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsergroupsAddChannelsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsergroupsAddChannelsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddTeamsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddTeamsResponse.md deleted file mode 100644 index 2cb44dd6b..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsergroupsAddTeamsResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsergroupsAddTeamsResponse - -```ts -type AdminUsergroupsAddTeamsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsergroupsAddTeamsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsergroupsAddTeamsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsergroupsListChannelsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsergroupsListChannelsResponse.md deleted file mode 100644 index 379383e1a..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsergroupsListChannelsResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminUsergroupsListChannelsResponse - -```ts -type AdminUsergroupsListChannelsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channels? - -```ts -optional channels: Channel[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsergroupsListChannelsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsergroupsListChannelsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsergroupsRemoveChannelsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsergroupsRemoveChannelsResponse.md deleted file mode 100644 index bbb81f84c..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsergroupsRemoveChannelsResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsergroupsRemoveChannelsResponse - -```ts -type AdminUsergroupsRemoveChannelsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsergroupsRemoveChannelsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsergroupsRemoveChannelsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersAssignResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersAssignResponse.md deleted file mode 100644 index 1751c47ce..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersAssignResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsersAssignResponse - -```ts -type AdminUsersAssignResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersAssignResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersAssignResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersInviteResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersInviteResponse.md deleted file mode 100644 index 906bb4823..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersInviteResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminUsersInviteResponse - -```ts -type AdminUsersInviteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersListArguments.md b/docs/content/reference/web-api/type-aliases/AdminUsersListArguments.md deleted file mode 100644 index 8a3a1afef..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminUsersListArguments - -```ts -type AdminUsersListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/users.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L88) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersListResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersListResponse.md deleted file mode 100644 index 6818de6bd..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminUsersListResponse - -```ts -type AdminUsersListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### users? - -```ts -optional users: User[]; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersRemoveResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersRemoveResponse.md deleted file mode 100644 index 93c40e032..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersRemoveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsersRemoveResponse - -```ts -type AdminUsersRemoveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionClearSettingsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionClearSettingsResponse.md deleted file mode 100644 index 996a37907..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSessionClearSettingsResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsersSessionClearSettingsResponse - -```ts -type AdminUsersSessionClearSettingsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersSessionClearSettingsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionClearSettingsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionGetSettingsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionGetSettingsResponse.md deleted file mode 100644 index c84c369b3..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSessionGetSettingsResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminUsersSessionGetSettingsResponse - -```ts -type AdminUsersSessionGetSettingsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### no\_settings\_applied? - -```ts -optional no_settings_applied: string[]; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### session\_settings? - -```ts -optional session_settings: SessionSetting[]; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersSessionGetSettingsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionGetSettingsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionInvalidateResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionInvalidateResponse.md deleted file mode 100644 index b497a8fb8..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSessionInvalidateResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminUsersSessionInvalidateResponse - -```ts -type AdminUsersSessionInvalidateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersSessionInvalidateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionInvalidateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionListArguments.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionListArguments.md deleted file mode 100644 index 672475ff4..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSessionListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminUsersSessionListArguments - -```ts -type AdminUsersSessionListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/users.ts:113](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/users.ts#L113) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionListResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionListResponse.md deleted file mode 100644 index 3fbb9a344..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSessionListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminUsersSessionListResponse - -```ts -type AdminUsersSessionListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### active\_sessions? - -```ts -optional active_sessions: ActiveSession[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersSessionListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetBulkResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetBulkResponse.md deleted file mode 100644 index 902121137..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetBulkResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsersSessionResetBulkResponse - -```ts -type AdminUsersSessionResetBulkResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersSessionResetBulkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionResetBulkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetResponse.md deleted file mode 100644 index 36821e9aa..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSessionResetResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsersSessionResetResponse - -```ts -type AdminUsersSessionResetResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersSessionResetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionResetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSessionSetSettingsResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSessionSetSettingsResponse.md deleted file mode 100644 index 52e181417..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSessionSetSettingsResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsersSessionSetSettingsResponse - -```ts -type AdminUsersSessionSetSettingsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersSessionSetSettingsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSessionSetSettingsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSetAdminResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSetAdminResponse.md deleted file mode 100644 index e38d9f8d4..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSetAdminResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsersSetAdminResponse - -```ts -type AdminUsersSetAdminResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersSetAdminResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSetAdminResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSetExpirationResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSetExpirationResponse.md deleted file mode 100644 index 28c039da1..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSetExpirationResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsersSetExpirationResponse - -```ts -type AdminUsersSetExpirationResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersSetExpirationResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSetExpirationResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSetOwnerResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSetOwnerResponse.md deleted file mode 100644 index 800186573..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSetOwnerResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsersSetOwnerResponse - -```ts -type AdminUsersSetOwnerResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersSetOwnerResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSetOwnerResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersSetRegularResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersSetRegularResponse.md deleted file mode 100644 index 7bc561d0b..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersSetRegularResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsersSetRegularResponse - -```ts -type AdminUsersSetRegularResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersSetRegularResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersSetRegularResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminUsersUnsupportedVersionsExportResponse.md b/docs/content/reference/web-api/type-aliases/AdminUsersUnsupportedVersionsExportResponse.md deleted file mode 100644 index dd9f46d9b..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminUsersUnsupportedVersionsExportResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AdminUsersUnsupportedVersionsExportResponse - -```ts -type AdminUsersUnsupportedVersionsExportResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminUsersUnsupportedVersionsExportResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminUsersUnsupportedVersionsExportResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsAddResponse.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsAddResponse.md deleted file mode 100644 index 47927cec4..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsAddResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AdminWorkflowsCollaboratorsAddResponse - -```ts -type AdminWorkflowsCollaboratorsAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### errors? - -```ts -optional errors: Error[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminWorkflowsCollaboratorsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminWorkflowsCollaboratorsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsRemoveResponse.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsRemoveResponse.md deleted file mode 100644 index a95085bbe..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminWorkflowsCollaboratorsRemoveResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminWorkflowsCollaboratorsRemoveResponse - -```ts -type AdminWorkflowsCollaboratorsRemoveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### errors? - -```ts -optional errors: Error[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminWorkflowsCollaboratorsRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminWorkflowsCollaboratorsRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsPermissionsLookupResponse.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsPermissionsLookupResponse.md deleted file mode 100644 index 4d7abcb9e..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminWorkflowsPermissionsLookupResponse.md +++ /dev/null @@ -1,45 +0,0 @@ -# Type Alias: AdminWorkflowsPermissionsLookupResponse - -```ts -type AdminWorkflowsPermissionsLookupResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### permissions? - -```ts -optional permissions: object; -``` - -#### Index Signature - - \[`key`: `string`\]: `Permission` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminWorkflowsPermissionsLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminWorkflowsPermissionsLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchArguments.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchArguments.md deleted file mode 100644 index 76876c8b8..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AdminWorkflowsSearchArguments - -```ts -type AdminWorkflowsSearchArguments: OptionalArgument & Partial & SortDir & TokenOverridable & CursorPaginationEnabled & object>; -``` - -## Defined in - -[packages/web-api/src/types/request/admin/workflows.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/admin/workflows.ts#L31) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchResponse.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchResponse.md deleted file mode 100644 index 888072ac5..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminWorkflowsSearchResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: AdminWorkflowsSearchResponse - -```ts -type AdminWorkflowsSearchResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### total\_found? - -```ts -optional total_found: number; -``` - -### workflows? - -```ts -optional workflows: Workflow[]; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminWorkflowsSearchResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminWorkflowsSearchResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AdminWorkflowsUnpublishResponse.md b/docs/content/reference/web-api/type-aliases/AdminWorkflowsUnpublishResponse.md deleted file mode 100644 index 9cc86052d..000000000 --- a/docs/content/reference/web-api/type-aliases/AdminWorkflowsUnpublishResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AdminWorkflowsUnpublishResponse - -```ts -type AdminWorkflowsUnpublishResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AdminWorkflowsUnpublishResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AdminWorkflowsUnpublishResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ApiTestResponse.md b/docs/content/reference/web-api/type-aliases/ApiTestResponse.md deleted file mode 100644 index 9acb1b95d..000000000 --- a/docs/content/reference/web-api/type-aliases/ApiTestResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ApiTestResponse - -```ts -type ApiTestResponse: WebAPICallResult & object; -``` - -## Type declaration - -### args? - -```ts -optional args: Args; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ApiTestResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ApiTestResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenArguments.md b/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenArguments.md deleted file mode 100644 index 67dee1c59..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AppsConnectionsOpenArguments - -```ts -type AppsConnectionsOpenArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/apps.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L7) diff --git a/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenResponse.md b/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenResponse.md deleted file mode 100644 index 34f14ff7b..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsConnectionsOpenResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AppsConnectionsOpenResponse - -```ts -type AppsConnectionsOpenResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### url? - -```ts -optional url: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsConnectionsOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsConnectionsOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsEventAuthorizationsListResponse.md b/docs/content/reference/web-api/type-aliases/AppsEventAuthorizationsListResponse.md deleted file mode 100644 index 53918ccaf..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsEventAuthorizationsListResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AppsEventAuthorizationsListResponse - -```ts -type AppsEventAuthorizationsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### authorizations? - -```ts -optional authorizations: Authorization[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsEventAuthorizationsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsEventAuthorizationsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsManifestCreateResponse.md b/docs/content/reference/web-api/type-aliases/AppsManifestCreateResponse.md deleted file mode 100644 index 03f104670..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsManifestCreateResponse.md +++ /dev/null @@ -1,65 +0,0 @@ -# Type Alias: AppsManifestCreateResponse - -```ts -type AppsManifestCreateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### app\_id? - -```ts -optional app_id: string; -``` - -### credentials? - -```ts -optional credentials: Credentials; -``` - -### error? - -```ts -optional error: string; -``` - -### errors? - -```ts -optional errors: Error[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### oauth\_authorize\_url? - -```ts -optional oauth_authorize_url: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsManifestCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsManifestCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsManifestDeleteResponse.md b/docs/content/reference/web-api/type-aliases/AppsManifestDeleteResponse.md deleted file mode 100644 index 4bea0e8a1..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsManifestDeleteResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AppsManifestDeleteResponse - -```ts -type AppsManifestDeleteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsManifestDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsManifestDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsManifestExportResponse.md b/docs/content/reference/web-api/type-aliases/AppsManifestExportResponse.md deleted file mode 100644 index 1de2ea755..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsManifestExportResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AppsManifestExportResponse - -```ts -type AppsManifestExportResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### manifest? - -```ts -optional manifest: Manifest; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsManifestExportResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsManifestExportResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsManifestUpdateResponse.md b/docs/content/reference/web-api/type-aliases/AppsManifestUpdateResponse.md deleted file mode 100644 index dcc19cf5f..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsManifestUpdateResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AppsManifestUpdateResponse - -```ts -type AppsManifestUpdateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### app\_id? - -```ts -optional app_id: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### permissions\_updated? - -```ts -optional permissions_updated: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsManifestUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsManifestUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsManifestValidateResponse.md b/docs/content/reference/web-api/type-aliases/AppsManifestValidateResponse.md deleted file mode 100644 index 028a77bbc..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsManifestValidateResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AppsManifestValidateResponse - -```ts -type AppsManifestValidateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### errors? - -```ts -optional errors: Error[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsManifestValidateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsManifestValidateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsInfoResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsInfoResponse.md deleted file mode 100644 index e0e2a043f..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsPermissionsInfoResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AppsPermissionsInfoResponse - -```ts -type AppsPermissionsInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsPermissionsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsRequestResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsRequestResponse.md deleted file mode 100644 index a54d6737c..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsPermissionsRequestResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AppsPermissionsRequestResponse - -```ts -type AppsPermissionsRequestResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsPermissionsRequestResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsRequestResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsResourcesListResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsResourcesListResponse.md deleted file mode 100644 index fd686ac84..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsPermissionsResourcesListResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AppsPermissionsResourcesListResponse - -```ts -type AppsPermissionsResourcesListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsPermissionsResourcesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsResourcesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsScopesListResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsScopesListResponse.md deleted file mode 100644 index b12717095..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsPermissionsScopesListResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AppsPermissionsScopesListResponse - -```ts -type AppsPermissionsScopesListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsPermissionsScopesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsScopesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersListResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersListResponse.md deleted file mode 100644 index 5da7cf284..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersListResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AppsPermissionsUsersListResponse - -```ts -type AppsPermissionsUsersListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsPermissionsUsersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsUsersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersRequestResponse.md b/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersRequestResponse.md deleted file mode 100644 index 323249eba..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsPermissionsUsersRequestResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AppsPermissionsUsersRequestResponse - -```ts -type AppsPermissionsUsersRequestResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsPermissionsUsersRequestResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsPermissionsUsersRequestResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AppsUninstallResponse.md b/docs/content/reference/web-api/type-aliases/AppsUninstallResponse.md deleted file mode 100644 index e5e130614..000000000 --- a/docs/content/reference/web-api/type-aliases/AppsUninstallResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: AppsUninstallResponse - -```ts -type AppsUninstallResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/AppsUninstallResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsUninstallResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AuthRevokeArguments.md b/docs/content/reference/web-api/type-aliases/AuthRevokeArguments.md deleted file mode 100644 index cce2a5828..000000000 --- a/docs/content/reference/web-api/type-aliases/AuthRevokeArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AuthRevokeArguments - -```ts -type AuthRevokeArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/auth.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/auth.ts#L5) diff --git a/docs/content/reference/web-api/type-aliases/AuthRevokeResponse.md b/docs/content/reference/web-api/type-aliases/AuthRevokeResponse.md deleted file mode 100644 index c770ac0ba..000000000 --- a/docs/content/reference/web-api/type-aliases/AuthRevokeResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: AuthRevokeResponse - -```ts -type AuthRevokeResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AuthRevokeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AuthRevokeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AuthTeamsListArguments.md b/docs/content/reference/web-api/type-aliases/AuthTeamsListArguments.md deleted file mode 100644 index fcba5aac3..000000000 --- a/docs/content/reference/web-api/type-aliases/AuthTeamsListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AuthTeamsListArguments - -```ts -type AuthTeamsListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/auth.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/auth.ts#L14) diff --git a/docs/content/reference/web-api/type-aliases/AuthTeamsListResponse.md b/docs/content/reference/web-api/type-aliases/AuthTeamsListResponse.md deleted file mode 100644 index 60c8423c2..000000000 --- a/docs/content/reference/web-api/type-aliases/AuthTeamsListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: AuthTeamsListResponse - -```ts -type AuthTeamsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### teams? - -```ts -optional teams: Team[]; -``` - -## Defined in - -[packages/web-api/src/types/response/AuthTeamsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AuthTeamsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/AuthTestArguments.md b/docs/content/reference/web-api/type-aliases/AuthTestArguments.md deleted file mode 100644 index cb550955f..000000000 --- a/docs/content/reference/web-api/type-aliases/AuthTestArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: AuthTestArguments - -```ts -type AuthTestArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/auth.ts:24](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/auth.ts#L24) diff --git a/docs/content/reference/web-api/type-aliases/AuthTestResponse.md b/docs/content/reference/web-api/type-aliases/AuthTestResponse.md deleted file mode 100644 index d5d8fd5b2..000000000 --- a/docs/content/reference/web-api/type-aliases/AuthTestResponse.md +++ /dev/null @@ -1,101 +0,0 @@ -# Type Alias: AuthTestResponse - -```ts -type AuthTestResponse: WebAPICallResult & object; -``` - -## Type declaration - -### app\_id? - -```ts -optional app_id: string; -``` - -### app\_name? - -```ts -optional app_name: string; -``` - -### bot\_id? - -```ts -optional bot_id: string; -``` - -### enterprise\_id? - -```ts -optional enterprise_id: string; -``` - -### error? - -```ts -optional error: string; -``` - -### expires\_in? - -```ts -optional expires_in: number; -``` - -### is\_enterprise\_install? - -```ts -optional is_enterprise_install: boolean; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### team? - -```ts -optional team: string; -``` - -### team\_id? - -```ts -optional team_id: string; -``` - -### url? - -```ts -optional url: string; -``` - -### user? - -```ts -optional user: string; -``` - -### user\_id? - -```ts -optional user_id: string; -``` - -## Defined in - -[packages/web-api/src/types/response/AuthTestResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AuthTestResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/BookmarksAddResponse.md b/docs/content/reference/web-api/type-aliases/BookmarksAddResponse.md deleted file mode 100644 index 61718e13d..000000000 --- a/docs/content/reference/web-api/type-aliases/BookmarksAddResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: BookmarksAddResponse - -```ts -type BookmarksAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### bookmark? - -```ts -optional bookmark: Bookmark; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/BookmarksAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/BookmarksAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/BookmarksEditResponse.md b/docs/content/reference/web-api/type-aliases/BookmarksEditResponse.md deleted file mode 100644 index ada0c20f5..000000000 --- a/docs/content/reference/web-api/type-aliases/BookmarksEditResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: BookmarksEditResponse - -```ts -type BookmarksEditResponse: WebAPICallResult & object; -``` - -## Type declaration - -### bookmark? - -```ts -optional bookmark: Bookmark; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/BookmarksEditResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/BookmarksEditResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/BookmarksListResponse.md b/docs/content/reference/web-api/type-aliases/BookmarksListResponse.md deleted file mode 100644 index f8da1e313..000000000 --- a/docs/content/reference/web-api/type-aliases/BookmarksListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: BookmarksListResponse - -```ts -type BookmarksListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### bookmarks? - -```ts -optional bookmarks: Bookmark[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/BookmarksListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/BookmarksListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/BookmarksRemoveResponse.md b/docs/content/reference/web-api/type-aliases/BookmarksRemoveResponse.md deleted file mode 100644 index 6274ed501..000000000 --- a/docs/content/reference/web-api/type-aliases/BookmarksRemoveResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: BookmarksRemoveResponse - -```ts -type BookmarksRemoveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/BookmarksRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/BookmarksRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/BotsInfoArguments.md b/docs/content/reference/web-api/type-aliases/BotsInfoArguments.md deleted file mode 100644 index 1b20cb0c7..000000000 --- a/docs/content/reference/web-api/type-aliases/BotsInfoArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: BotsInfoArguments - -```ts -type BotsInfoArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/bots.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/bots.ts#L6) diff --git a/docs/content/reference/web-api/type-aliases/BotsInfoResponse.md b/docs/content/reference/web-api/type-aliases/BotsInfoResponse.md deleted file mode 100644 index d3cb6981c..000000000 --- a/docs/content/reference/web-api/type-aliases/BotsInfoResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: BotsInfoResponse - -```ts -type BotsInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### bot? - -```ts -optional bot: Bot; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/BotsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/BotsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallUser.md b/docs/content/reference/web-api/type-aliases/CallUser.md deleted file mode 100644 index fb469b1a9..000000000 --- a/docs/content/reference/web-api/type-aliases/CallUser.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: CallUser - -```ts -type CallUser: CallUserSlack | CallUserExternal; -``` - -## Description - -For use in representing [users in a Slack Call](https://api.slack.com/apis/calls#users). - -## Defined in - -packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:4 diff --git a/docs/content/reference/web-api/type-aliases/CallsAddResponse.md b/docs/content/reference/web-api/type-aliases/CallsAddResponse.md deleted file mode 100644 index d2a189ce0..000000000 --- a/docs/content/reference/web-api/type-aliases/CallsAddResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: CallsAddResponse - -```ts -type CallsAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### call? - -```ts -optional call: Call; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/CallsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallsEndResponse.md b/docs/content/reference/web-api/type-aliases/CallsEndResponse.md deleted file mode 100644 index 805760713..000000000 --- a/docs/content/reference/web-api/type-aliases/CallsEndResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: CallsEndResponse - -```ts -type CallsEndResponse: WebAPICallResult & object; -``` - -## Type declaration - -### call? - -```ts -optional call: Call; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/CallsEndResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsEndResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallsInfoResponse.md b/docs/content/reference/web-api/type-aliases/CallsInfoResponse.md deleted file mode 100644 index ac801035e..000000000 --- a/docs/content/reference/web-api/type-aliases/CallsInfoResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: CallsInfoResponse - -```ts -type CallsInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### call? - -```ts -optional call: Call; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/CallsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallsParticipantsAddResponse.md b/docs/content/reference/web-api/type-aliases/CallsParticipantsAddResponse.md deleted file mode 100644 index 53808a027..000000000 --- a/docs/content/reference/web-api/type-aliases/CallsParticipantsAddResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: CallsParticipantsAddResponse - -```ts -type CallsParticipantsAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### call? - -```ts -optional call: Call; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/CallsParticipantsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsParticipantsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallsParticipantsRemoveResponse.md b/docs/content/reference/web-api/type-aliases/CallsParticipantsRemoveResponse.md deleted file mode 100644 index d94a07044..000000000 --- a/docs/content/reference/web-api/type-aliases/CallsParticipantsRemoveResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: CallsParticipantsRemoveResponse - -```ts -type CallsParticipantsRemoveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### call? - -```ts -optional call: Call; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/CallsParticipantsRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsParticipantsRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CallsUpdateResponse.md b/docs/content/reference/web-api/type-aliases/CallsUpdateResponse.md deleted file mode 100644 index 36a0caf6e..000000000 --- a/docs/content/reference/web-api/type-aliases/CallsUpdateResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: CallsUpdateResponse - -```ts -type CallsUpdateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### call? - -```ts -optional call: Call; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/CallsUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CallsUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesAccessDeleteResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesAccessDeleteResponse.md deleted file mode 100644 index f1d926e47..000000000 --- a/docs/content/reference/web-api/type-aliases/CanvasesAccessDeleteResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: CanvasesAccessDeleteResponse - -```ts -type CanvasesAccessDeleteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### failed\_to\_update\_channel\_ids? - -```ts -optional failed_to_update_channel_ids: string[]; -``` - -### failed\_to\_update\_user\_ids? - -```ts -optional failed_to_update_user_ids: string[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/CanvasesAccessDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesAccessDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesAccessSetResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesAccessSetResponse.md deleted file mode 100644 index bff76e048..000000000 --- a/docs/content/reference/web-api/type-aliases/CanvasesAccessSetResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: CanvasesAccessSetResponse - -```ts -type CanvasesAccessSetResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### failed\_to\_update\_channel\_ids? - -```ts -optional failed_to_update_channel_ids: string[]; -``` - -### failed\_to\_update\_user\_ids? - -```ts -optional failed_to_update_user_ids: string[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/CanvasesAccessSetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesAccessSetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesCreateArguments.md b/docs/content/reference/web-api/type-aliases/CanvasesCreateArguments.md deleted file mode 100644 index 4b2f99ebb..000000000 --- a/docs/content/reference/web-api/type-aliases/CanvasesCreateArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: CanvasesCreateArguments - -```ts -type CanvasesCreateArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/canvas.ts:63](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L63) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesCreateResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesCreateResponse.md deleted file mode 100644 index f700ba718..000000000 --- a/docs/content/reference/web-api/type-aliases/CanvasesCreateResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: CanvasesCreateResponse - -```ts -type CanvasesCreateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### canvas\_id? - -```ts -optional canvas_id: string; -``` - -### detail? - -```ts -optional detail: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/CanvasesCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesDeleteResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesDeleteResponse.md deleted file mode 100644 index 3a5529b03..000000000 --- a/docs/content/reference/web-api/type-aliases/CanvasesDeleteResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: CanvasesDeleteResponse - -```ts -type CanvasesDeleteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/CanvasesDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesEditResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesEditResponse.md deleted file mode 100644 index 1eee2e3f2..000000000 --- a/docs/content/reference/web-api/type-aliases/CanvasesEditResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: CanvasesEditResponse - -```ts -type CanvasesEditResponse: WebAPICallResult & object; -``` - -## Type declaration - -### detail? - -```ts -optional detail: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/CanvasesEditResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesEditResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/CanvasesSectionsLookupResponse.md b/docs/content/reference/web-api/type-aliases/CanvasesSectionsLookupResponse.md deleted file mode 100644 index d0421e3e7..000000000 --- a/docs/content/reference/web-api/type-aliases/CanvasesSectionsLookupResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: CanvasesSectionsLookupResponse - -```ts -type CanvasesSectionsLookupResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### sections? - -```ts -optional sections: Section[]; -``` - -## Defined in - -[packages/web-api/src/types/response/CanvasesSectionsLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesSectionsLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsArchiveResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsArchiveResponse.md deleted file mode 100644 index a5beca4f9..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsArchiveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ChannelsArchiveResponse - -```ts -type ChannelsArchiveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsArchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsArchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsCreateResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsCreateResponse.md deleted file mode 100644 index 42a98beea..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsCreateResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ChannelsCreateResponse - -```ts -type ChannelsCreateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsHistoryResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsHistoryResponse.md deleted file mode 100644 index 58feaf87a..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsHistoryResponse.md +++ /dev/null @@ -1,77 +0,0 @@ -# Type Alias: ChannelsHistoryResponse - -```ts -type ChannelsHistoryResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel\_actions\_count? - -```ts -optional channel_actions_count: number; -``` - -### channel\_actions\_ts? - -```ts -optional channel_actions_ts: number; -``` - -### error? - -```ts -optional error: string; -``` - -### has\_more? - -```ts -optional has_more: boolean; -``` - -### latest? - -```ts -optional latest: string; -``` - -### messages? - -```ts -optional messages: Message[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsHistoryResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsHistoryResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsInfoResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsInfoResponse.md deleted file mode 100644 index 88c69c832..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsInfoResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ChannelsInfoResponse - -```ts -type ChannelsInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsInviteResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsInviteResponse.md deleted file mode 100644 index 2e76a7fb9..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsInviteResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ChannelsInviteResponse - -```ts -type ChannelsInviteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsJoinResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsJoinResponse.md deleted file mode 100644 index 5098b7422..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsJoinResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ChannelsJoinResponse - -```ts -type ChannelsJoinResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsJoinResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsJoinResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsKickResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsKickResponse.md deleted file mode 100644 index cb8ad3a41..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsKickResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ChannelsKickResponse - -```ts -type ChannelsKickResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsKickResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsKickResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsLeaveResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsLeaveResponse.md deleted file mode 100644 index 9b9b403a6..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsLeaveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ChannelsLeaveResponse - -```ts -type ChannelsLeaveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsLeaveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsLeaveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsListResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsListResponse.md deleted file mode 100644 index db2ea28a9..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsListResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ChannelsListResponse - -```ts -type ChannelsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channels? - -```ts -optional channels: Channel[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsMarkResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsMarkResponse.md deleted file mode 100644 index 41c3b2e99..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsMarkResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ChannelsMarkResponse - -```ts -type ChannelsMarkResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsMarkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsMarkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsRenameResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsRenameResponse.md deleted file mode 100644 index 9c5dead13..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsRenameResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ChannelsRenameResponse - -```ts -type ChannelsRenameResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsRenameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsRenameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsRepliesResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsRepliesResponse.md deleted file mode 100644 index 1c88ba634..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsRepliesResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -# Type Alias: ChannelsRepliesResponse - -```ts -type ChannelsRepliesResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### has\_more? - -```ts -optional has_more: boolean; -``` - -### messages? - -```ts -optional messages: Message[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsRepliesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsRepliesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsSetPurposeResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsSetPurposeResponse.md deleted file mode 100644 index 33704363a..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsSetPurposeResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ChannelsSetPurposeResponse - -```ts -type ChannelsSetPurposeResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### purpose? - -```ts -optional purpose: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsSetPurposeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsSetPurposeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsSetTopicResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsSetTopicResponse.md deleted file mode 100644 index 8b8ca9928..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsSetTopicResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ChannelsSetTopicResponse - -```ts -type ChannelsSetTopicResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### topic? - -```ts -optional topic: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsSetTopicResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsSetTopicResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChannelsUnarchiveResponse.md b/docs/content/reference/web-api/type-aliases/ChannelsUnarchiveResponse.md deleted file mode 100644 index 44781d9a5..000000000 --- a/docs/content/reference/web-api/type-aliases/ChannelsUnarchiveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ChannelsUnarchiveResponse - -```ts -type ChannelsUnarchiveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChannelsUnarchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChannelsUnarchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatDeleteResponse.md b/docs/content/reference/web-api/type-aliases/ChatDeleteResponse.md deleted file mode 100644 index fae18eb9b..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatDeleteResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: ChatDeleteResponse - -```ts -type ChatDeleteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### ts? - -```ts -optional ts: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChatDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatDeleteScheduledMessageResponse.md b/docs/content/reference/web-api/type-aliases/ChatDeleteScheduledMessageResponse.md deleted file mode 100644 index 9d3f1d9cd..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatDeleteScheduledMessageResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ChatDeleteScheduledMessageResponse - -```ts -type ChatDeleteScheduledMessageResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChatDeleteScheduledMessageResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatDeleteScheduledMessageResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatGetPermalinkResponse.md b/docs/content/reference/web-api/type-aliases/ChatGetPermalinkResponse.md deleted file mode 100644 index c34195390..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatGetPermalinkResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: ChatGetPermalinkResponse - -```ts -type ChatGetPermalinkResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### permalink? - -```ts -optional permalink: string; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChatGetPermalinkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatGetPermalinkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatMeMessageResponse.md b/docs/content/reference/web-api/type-aliases/ChatMeMessageResponse.md deleted file mode 100644 index c9cd60270..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatMeMessageResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: ChatMeMessageResponse - -```ts -type ChatMeMessageResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### ts? - -```ts -optional ts: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChatMeMessageResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatMeMessageResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatPostEphemeralArguments.md b/docs/content/reference/web-api/type-aliases/ChatPostEphemeralArguments.md deleted file mode 100644 index c6f43278a..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatPostEphemeralArguments.md +++ /dev/null @@ -1,22 +0,0 @@ -# Type Alias: ChatPostEphemeralArguments - -```ts -type ChatPostEphemeralArguments: TokenOverridable & MessageContents & object & Authorship & Parse & LinkNames & Partial; -``` - -## Type declaration - -### user - -```ts -user: string; -``` - -#### Description - -`id` of the user who will receive the ephemeral message. -The user should be in the channel specified by the `channel` argument. - -## Defined in - -[packages/web-api/src/types/request/chat.ts:161](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L161) diff --git a/docs/content/reference/web-api/type-aliases/ChatPostEphemeralResponse.md b/docs/content/reference/web-api/type-aliases/ChatPostEphemeralResponse.md deleted file mode 100644 index f0cb7f55a..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatPostEphemeralResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ChatPostEphemeralResponse - -```ts -type ChatPostEphemeralResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### message\_ts? - -```ts -optional message_ts: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChatPostEphemeralResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatPostEphemeralResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatPostMessageArguments.md b/docs/content/reference/web-api/type-aliases/ChatPostMessageArguments.md deleted file mode 100644 index 99bfc71a3..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatPostMessageArguments.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ChatPostMessageArguments - -```ts -type ChatPostMessageArguments: TokenOverridable & MessageContents & ReplyInThread & Authorship & Parse & LinkNames & Metadata & Unfurls & object; -``` - -## Type declaration - -### mrkdwn? - -```ts -optional mrkdwn: boolean; -``` - -#### Description - -Disable Slack markup parsing by setting to `false`. Enabled by default. - -## Defined in - -[packages/web-api/src/types/request/chat.ts:170](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L170) diff --git a/docs/content/reference/web-api/type-aliases/ChatPostMessageResponse.md b/docs/content/reference/web-api/type-aliases/ChatPostMessageResponse.md deleted file mode 100644 index 6fec5604c..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatPostMessageResponse.md +++ /dev/null @@ -1,71 +0,0 @@ -# Type Alias: ChatPostMessageResponse - -```ts -type ChatPostMessageResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: string; -``` - -### deprecated\_argument? - -```ts -optional deprecated_argument: string; -``` - -### error? - -```ts -optional error: string; -``` - -### errors? - -```ts -optional errors: string[]; -``` - -### message? - -```ts -optional message: ChatPostMessageResponseMessage; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### ts? - -```ts -optional ts: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChatPostMessageResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatPostMessageResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatScheduleMessageArguments.md b/docs/content/reference/web-api/type-aliases/ChatScheduleMessageArguments.md deleted file mode 100644 index 36c4d2a4a..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatScheduleMessageArguments.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ChatScheduleMessageArguments - -```ts -type ChatScheduleMessageArguments: TokenOverridable & MessageContents & object & ReplyInThread & Parse & LinkNames & AsUser & Metadata & Unfurls; -``` - -## Type declaration - -### post\_at - -```ts -post_at: string | number; -``` - -#### Description - -Unix EPOCH timestamp of time in future to send the message. - -## Defined in - -[packages/web-api/src/types/request/chat.ts:177](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L177) diff --git a/docs/content/reference/web-api/type-aliases/ChatScheduleMessageResponse.md b/docs/content/reference/web-api/type-aliases/ChatScheduleMessageResponse.md deleted file mode 100644 index 25cac0ad9..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatScheduleMessageResponse.md +++ /dev/null @@ -1,65 +0,0 @@ -# Type Alias: ChatScheduleMessageResponse - -```ts -type ChatScheduleMessageResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: string; -``` - -### error? - -```ts -optional error: string; -``` - -### message? - -```ts -optional message: Message; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### post\_at? - -```ts -optional post_at: number; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### scheduled\_message\_id? - -```ts -optional scheduled_message_id: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChatScheduleMessageResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatScheduleMessageResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListArguments.md b/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListArguments.md deleted file mode 100644 index c524cb68b..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: ChatScheduledMessagesListArguments - -```ts -type ChatScheduledMessagesListArguments: OptionalArgument & Partial>; -``` - -## Defined in - -[packages/web-api/src/types/request/chat.ts:183](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L183) diff --git a/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListResponse.md b/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListResponse.md deleted file mode 100644 index ed7ded8a2..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatScheduledMessagesListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: ChatScheduledMessagesListResponse - -```ts -type ChatScheduledMessagesListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### scheduled\_messages? - -```ts -optional scheduled_messages: ScheduledMessage[]; -``` - -## Defined in - -[packages/web-api/src/types/response/ChatScheduledMessagesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatScheduledMessagesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatUnfurlArguments.md b/docs/content/reference/web-api/type-aliases/ChatUnfurlArguments.md deleted file mode 100644 index 6a021b6da..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatUnfurlArguments.md +++ /dev/null @@ -1,68 +0,0 @@ -# Type Alias: ChatUnfurlArguments - -```ts -type ChatUnfurlArguments: object & UnfurlTarget & TokenOverridable & object; -``` - -## Type declaration - -### unfurls - -```ts -unfurls: LinkUnfurls; -``` - -#### Description - -URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl -blocks or message attachments. - -## Type declaration - -### user\_auth\_blocks? - -```ts -optional user_auth_blocks: (KnownBlock | Block)[]; -``` - -#### Description - -Provide a JSON based array of structured blocks presented as URL-encoded string to send as an -ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior. - -### user\_auth\_message? - -```ts -optional user_auth_message: string; -``` - -#### Description - -Provide a simply-formatted string to send as an ephemeral message to the user as invitation to -authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again. - -### user\_auth\_required? - -```ts -optional user_auth_required: boolean; -``` - -#### Description - -Set to `true` to indicate the user must install your Slack app to trigger unfurls for this domain. -Defaults to `false`. - -### user\_auth\_url? - -```ts -optional user_auth_url: string; -``` - -#### Description - -Send users to this custom URL where they will complete authentication in your app to fully trigger -unfurling. Value should be properly URL-encoded. - -## Defined in - -[packages/web-api/src/types/request/chat.ts:201](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L201) diff --git a/docs/content/reference/web-api/type-aliases/ChatUnfurlResponse.md b/docs/content/reference/web-api/type-aliases/ChatUnfurlResponse.md deleted file mode 100644 index d727cd6d9..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatUnfurlResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ChatUnfurlResponse - -```ts -type ChatUnfurlResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChatUnfurlResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatUnfurlResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ChatUpdateArguments.md b/docs/content/reference/web-api/type-aliases/ChatUpdateArguments.md deleted file mode 100644 index cabc8f347..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatUpdateArguments.md +++ /dev/null @@ -1,43 +0,0 @@ -# Type Alias: ChatUpdateArguments - -```ts -type ChatUpdateArguments: MessageContents & object & TokenOverridable & AsUser & LinkNames & Metadata & Parse & object; -``` - -## Type declaration - -### ts - -```ts -ts: string; -``` - -#### Description - -Timestamp of the message to be updated. - -## Type declaration - -### file\_ids? - -```ts -optional file_ids: string[]; -``` - -#### Description - -Array of new file ids that will be sent with this message. - -### reply\_broadcast? - -```ts -optional reply_broadcast: boolean; -``` - -#### Description - -Broadcast an existing thread reply to make it visible to everyone in the channel or conversation. - -## Defined in - -[packages/web-api/src/types/request/chat.ts:232](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/chat.ts#L232) diff --git a/docs/content/reference/web-api/type-aliases/ChatUpdateResponse.md b/docs/content/reference/web-api/type-aliases/ChatUpdateResponse.md deleted file mode 100644 index 1a4505400..000000000 --- a/docs/content/reference/web-api/type-aliases/ChatUpdateResponse.md +++ /dev/null @@ -1,65 +0,0 @@ -# Type Alias: ChatUpdateResponse - -```ts -type ChatUpdateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: string; -``` - -### error? - -```ts -optional error: string; -``` - -### message? - -```ts -optional message: Message; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### text? - -```ts -optional text: string; -``` - -### ts? - -```ts -optional ts: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ChatUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ChatUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationFilter.md b/docs/content/reference/web-api/type-aliases/ConversationFilter.md deleted file mode 100644 index 9c5ac0a93..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationFilter.md +++ /dev/null @@ -1,18 +0,0 @@ -# Type Alias: ConversationFilter - -```ts -type ConversationFilter: BaseConversationFilter & Required> | BaseConversationFilter & Required> | BaseConversationFilter & Required>; -``` - -## Description - -Defines a filter for the list of options in a conversation selector menu. The menu can be either a -conversations select menu or a conversations multi-select menu. - -## See - -[Conversation filter object reference](https://api.slack.com/reference/block-kit/composition-objects#filter_conversations). - -## Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:171 diff --git a/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteArguments.md b/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteArguments.md deleted file mode 100644 index bd6a862b5..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteArguments.md +++ /dev/null @@ -1,32 +0,0 @@ -# Type Alias: ConversationsAcceptSharedInviteArguments - -```ts -type ConversationsAcceptSharedInviteArguments: TokenOverridable & OptionalTeamAssignable & ChannelID | InviteID & IsPrivate & object; -``` - -## Type declaration - -### channel\_name - -```ts -channel_name: string; -``` - -#### Description - -Name of the channel. If the channel does not exist already in your workspace, -this name is the one that the channel will take. - -### free\_trial\_accepted? - -```ts -optional free_trial_accepted: boolean; -``` - -#### Description - -Whether you'd like to use your workspace's free trial to begin using Slack Connect. - -## Defined in - -[packages/web-api/src/types/request/conversations.ts:51](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L51) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteResponse.md deleted file mode 100644 index 6ae0e57e8..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsAcceptSharedInviteResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -# Type Alias: ConversationsAcceptSharedInviteResponse - -```ts -type ConversationsAcceptSharedInviteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### can\_open\_scdm? - -```ts -optional can_open_scdm: boolean; -``` - -### channel\_id? - -```ts -optional channel_id: string; -``` - -### error? - -```ts -optional error: string; -``` - -### implicit\_approval? - -```ts -optional implicit_approval: boolean; -``` - -### invite\_id? - -```ts -optional invite_id: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsAcceptSharedInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsAcceptSharedInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsApproveSharedInviteResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsApproveSharedInviteResponse.md deleted file mode 100644 index 547358dfa..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsApproveSharedInviteResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ConversationsApproveSharedInviteResponse - -```ts -type ConversationsApproveSharedInviteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsApproveSharedInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsApproveSharedInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsArchiveResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsArchiveResponse.md deleted file mode 100644 index e3f533843..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsArchiveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ConversationsArchiveResponse - -```ts -type ConversationsArchiveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsArchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsArchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsCanvasesCreateResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsCanvasesCreateResponse.md deleted file mode 100644 index 836d76fa2..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsCanvasesCreateResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ConversationsCanvasesCreateResponse - -```ts -type ConversationsCanvasesCreateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### canvas\_id? - -```ts -optional canvas_id: string; -``` - -### detail? - -```ts -optional detail: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsCanvasesCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsCanvasesCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsCloseResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsCloseResponse.md deleted file mode 100644 index aa10b43e6..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsCloseResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: ConversationsCloseResponse - -```ts -type ConversationsCloseResponse: WebAPICallResult & object; -``` - -## Type declaration - -### already\_closed? - -```ts -optional already_closed: boolean; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### no\_op? - -```ts -optional no_op: boolean; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsCloseResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsCloseResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsCreateResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsCreateResponse.md deleted file mode 100644 index b04dbac89..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsCreateResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: ConversationsCreateResponse - -```ts -type ConversationsCreateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### detail? - -```ts -optional detail: string; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsDeclineSharedInviteResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsDeclineSharedInviteResponse.md deleted file mode 100644 index 822184a20..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsDeclineSharedInviteResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ConversationsDeclineSharedInviteResponse - -```ts -type ConversationsDeclineSharedInviteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsDeclineSharedInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsDeclineSharedInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsExternalInvitePermissionsSetResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsExternalInvitePermissionsSetResponse.md deleted file mode 100644 index a4a5610bf..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsExternalInvitePermissionsSetResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ConversationsExternalInvitePermissionsSetResponse - -```ts -type ConversationsExternalInvitePermissionsSetResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsExternalInvitePermissionsSetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsExternalInvitePermissionsSetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsHistoryResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsHistoryResponse.md deleted file mode 100644 index 5e738ec77..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsHistoryResponse.md +++ /dev/null @@ -1,77 +0,0 @@ -# Type Alias: ConversationsHistoryResponse - -```ts -type ConversationsHistoryResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel\_actions\_count? - -```ts -optional channel_actions_count: number; -``` - -### channel\_actions\_ts? - -```ts -optional channel_actions_ts: number; -``` - -### error? - -```ts -optional error: string; -``` - -### has\_more? - -```ts -optional has_more: boolean; -``` - -### messages? - -```ts -optional messages: MessageElement[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### oldest? - -```ts -optional oldest: string; -``` - -### pin\_count? - -```ts -optional pin_count: number; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsHistoryResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsHistoryResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsInfoResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsInfoResponse.md deleted file mode 100644 index 78e079a4e..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsInfoResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ConversationsInfoResponse - -```ts -type ConversationsInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsInviteResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsInviteResponse.md deleted file mode 100644 index 2ad6c673b..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsInviteResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: ConversationsInviteResponse - -```ts -type ConversationsInviteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### errors? - -```ts -optional errors: Error[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedArguments.md b/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedArguments.md deleted file mode 100644 index 46eac8716..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedArguments.md +++ /dev/null @@ -1,21 +0,0 @@ -# Type Alias: ConversationsInviteSharedArguments - -```ts -type ConversationsInviteSharedArguments: Channel & TokenOverridable & Emails | UserIDs & object; -``` - -## Type declaration - -### external\_limited? - -```ts -optional external_limited: boolean; -``` - -#### Description - -Whether invite is to an external limited member. Defaults to `true`. - -## Defined in - -[packages/web-api/src/types/request/conversations.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L109) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedResponse.md deleted file mode 100644 index 472a2a6c5..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsInviteSharedResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -# Type Alias: ConversationsInviteSharedResponse - -```ts -type ConversationsInviteSharedResponse: WebAPICallResult & object; -``` - -## Type declaration - -### conf\_code? - -```ts -optional conf_code: string; -``` - -### error? - -```ts -optional error: string; -``` - -### invite\_id? - -```ts -optional invite_id: string; -``` - -### is\_legacy\_shared\_channel? - -```ts -optional is_legacy_shared_channel: boolean; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### url? - -```ts -optional url: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsInviteSharedResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsInviteSharedResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsJoinResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsJoinResponse.md deleted file mode 100644 index 180f809cb..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsJoinResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ConversationsJoinResponse - -```ts -type ConversationsJoinResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsJoinResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsJoinResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsKickResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsKickResponse.md deleted file mode 100644 index 784554e11..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsKickResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ConversationsKickResponse - -```ts -type ConversationsKickResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsKickResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsKickResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsLeaveResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsLeaveResponse.md deleted file mode 100644 index 84382c2bc..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsLeaveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ConversationsLeaveResponse - -```ts -type ConversationsLeaveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsLeaveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsLeaveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsListArguments.md b/docs/content/reference/web-api/type-aliases/ConversationsListArguments.md deleted file mode 100644 index 878c95653..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: ConversationsListArguments - -```ts -type ConversationsListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/conversations.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L126) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesArguments.md b/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesArguments.md deleted file mode 100644 index d66f8f837..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: ConversationsListConnectInvitesArguments - -```ts -type ConversationsListConnectInvitesArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/conversations.ts:138](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L138) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesResponse.md deleted file mode 100644 index c49c97063..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsListConnectInvitesResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ConversationsListConnectInvitesResponse - -```ts -type ConversationsListConnectInvitesResponse: WebAPICallResult & object; -``` - -## Type declaration - -### arg? - -```ts -optional arg: string; -``` - -### error? - -```ts -optional error: string; -``` - -### invites? - -```ts -optional invites: InviteElement[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsListConnectInvitesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsListConnectInvitesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsListResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsListResponse.md deleted file mode 100644 index bbd7c0095..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: ConversationsListResponse - -```ts -type ConversationsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channels? - -```ts -optional channels: Channel[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsMarkResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsMarkResponse.md deleted file mode 100644 index 675875433..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsMarkResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ConversationsMarkResponse - -```ts -type ConversationsMarkResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsMarkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsMarkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsMembersResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsMembersResponse.md deleted file mode 100644 index d528ab1e0..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsMembersResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: ConversationsMembersResponse - -```ts -type ConversationsMembersResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### members? - -```ts -optional members: string[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsMembersResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsMembersResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsOpenArguments.md b/docs/content/reference/web-api/type-aliases/ConversationsOpenArguments.md deleted file mode 100644 index 36d9912d8..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsOpenArguments.md +++ /dev/null @@ -1,32 +0,0 @@ -# Type Alias: ConversationsOpenArguments - -```ts -type ConversationsOpenArguments: Channel | Users & TokenOverridable & object; -``` - -## Type declaration - -### prevent\_creation? - -```ts -optional prevent_creation: boolean; -``` - -#### Description - -Do not create a direct message or multi-person direct message. -This is used to see if there is an existing dm or mpdm. - -### return\_im? - -```ts -optional return_im: boolean; -``` - -#### Description - -Indicates you want the full IM channel definition in the response. - -## Defined in - -[packages/web-api/src/types/request/conversations.ts:152](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/conversations.ts#L152) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsOpenResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsOpenResponse.md deleted file mode 100644 index 2daf7a20d..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsOpenResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ConversationsOpenResponse - -```ts -type ConversationsOpenResponse: WebAPICallResult & object; -``` - -## Type declaration - -### already\_open? - -```ts -optional already_open: boolean; -``` - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### no\_op? - -```ts -optional no_op: boolean; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsRenameResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsRenameResponse.md deleted file mode 100644 index 540ceee88..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsRenameResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ConversationsRenameResponse - -```ts -type ConversationsRenameResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsRenameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsRenameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsRepliesResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsRepliesResponse.md deleted file mode 100644 index e8747cbdb..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsRepliesResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ConversationsRepliesResponse - -```ts -type ConversationsRepliesResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### has\_more? - -```ts -optional has_more: boolean; -``` - -### messages? - -```ts -optional messages: MessageElement[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsRepliesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsRepliesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsSetPurposeResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsSetPurposeResponse.md deleted file mode 100644 index 4020a4a25..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsSetPurposeResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ConversationsSetPurposeResponse - -```ts -type ConversationsSetPurposeResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsSetPurposeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsSetPurposeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsSetTopicResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsSetTopicResponse.md deleted file mode 100644 index 108301b8f..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsSetTopicResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: ConversationsSetTopicResponse - -```ts -type ConversationsSetTopicResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsSetTopicResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsSetTopicResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ConversationsUnarchiveResponse.md b/docs/content/reference/web-api/type-aliases/ConversationsUnarchiveResponse.md deleted file mode 100644 index f85d65fe1..000000000 --- a/docs/content/reference/web-api/type-aliases/ConversationsUnarchiveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ConversationsUnarchiveResponse - -```ts -type ConversationsUnarchiveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ConversationsUnarchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ConversationsUnarchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DialogOpenResponse.md b/docs/content/reference/web-api/type-aliases/DialogOpenResponse.md deleted file mode 100644 index fd4024d36..000000000 --- a/docs/content/reference/web-api/type-aliases/DialogOpenResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: DialogOpenResponse - -```ts -type DialogOpenResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/DialogOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DialogOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DndEndDndArguments.md b/docs/content/reference/web-api/type-aliases/DndEndDndArguments.md deleted file mode 100644 index a6eb4a833..000000000 --- a/docs/content/reference/web-api/type-aliases/DndEndDndArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: DndEndDndArguments - -```ts -type DndEndDndArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/dnd.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dnd.ts#L5) diff --git a/docs/content/reference/web-api/type-aliases/DndEndDndResponse.md b/docs/content/reference/web-api/type-aliases/DndEndDndResponse.md deleted file mode 100644 index bc68cf12a..000000000 --- a/docs/content/reference/web-api/type-aliases/DndEndDndResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: DndEndDndResponse - -```ts -type DndEndDndResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/DndEndDndResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DndEndDndResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DndEndSnoozeArguments.md b/docs/content/reference/web-api/type-aliases/DndEndSnoozeArguments.md deleted file mode 100644 index fc554e46d..000000000 --- a/docs/content/reference/web-api/type-aliases/DndEndSnoozeArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: DndEndSnoozeArguments - -```ts -type DndEndSnoozeArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/dnd.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dnd.ts#L7) diff --git a/docs/content/reference/web-api/type-aliases/DndEndSnoozeResponse.md b/docs/content/reference/web-api/type-aliases/DndEndSnoozeResponse.md deleted file mode 100644 index 3e83859e7..000000000 --- a/docs/content/reference/web-api/type-aliases/DndEndSnoozeResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -# Type Alias: DndEndSnoozeResponse - -```ts -type DndEndSnoozeResponse: WebAPICallResult & object; -``` - -## Type declaration - -### dnd\_enabled? - -```ts -optional dnd_enabled: boolean; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### next\_dnd\_end\_ts? - -```ts -optional next_dnd_end_ts: number; -``` - -### next\_dnd\_start\_ts? - -```ts -optional next_dnd_start_ts: number; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### snooze\_enabled? - -```ts -optional snooze_enabled: boolean; -``` - -## Defined in - -[packages/web-api/src/types/response/DndEndSnoozeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DndEndSnoozeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DndInfoArguments.md b/docs/content/reference/web-api/type-aliases/DndInfoArguments.md deleted file mode 100644 index b1c75ce1d..000000000 --- a/docs/content/reference/web-api/type-aliases/DndInfoArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: DndInfoArguments - -```ts -type DndInfoArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/dnd.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/dnd.ts#L9) diff --git a/docs/content/reference/web-api/type-aliases/DndInfoResponse.md b/docs/content/reference/web-api/type-aliases/DndInfoResponse.md deleted file mode 100644 index 278bf9cc2..000000000 --- a/docs/content/reference/web-api/type-aliases/DndInfoResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: DndInfoResponse - -```ts -type DndInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### dnd\_enabled? - -```ts -optional dnd_enabled: boolean; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### next\_dnd\_end\_ts? - -```ts -optional next_dnd_end_ts: number; -``` - -### next\_dnd\_start\_ts? - -```ts -optional next_dnd_start_ts: number; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/DndInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DndInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DndSetSnoozeResponse.md b/docs/content/reference/web-api/type-aliases/DndSetSnoozeResponse.md deleted file mode 100644 index 79715f598..000000000 --- a/docs/content/reference/web-api/type-aliases/DndSetSnoozeResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -# Type Alias: DndSetSnoozeResponse - -```ts -type DndSetSnoozeResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### snooze\_enabled? - -```ts -optional snooze_enabled: boolean; -``` - -### snooze\_endtime? - -```ts -optional snooze_endtime: number; -``` - -### snooze\_is\_indefinite? - -```ts -optional snooze_is_indefinite: boolean; -``` - -### snooze\_remaining? - -```ts -optional snooze_remaining: number; -``` - -## Defined in - -[packages/web-api/src/types/response/DndSetSnoozeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DndSetSnoozeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/DndTeamInfoResponse.md b/docs/content/reference/web-api/type-aliases/DndTeamInfoResponse.md deleted file mode 100644 index 3ca6c4301..000000000 --- a/docs/content/reference/web-api/type-aliases/DndTeamInfoResponse.md +++ /dev/null @@ -1,45 +0,0 @@ -# Type Alias: DndTeamInfoResponse - -```ts -type DndTeamInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### users? - -```ts -optional users: object; -``` - -#### Index Signature - - \[`key`: `string`\]: `User` - -## Defined in - -[packages/web-api/src/types/response/DndTeamInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/DndTeamInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/EmojiListArguments.md b/docs/content/reference/web-api/type-aliases/EmojiListArguments.md deleted file mode 100644 index 724f3c14c..000000000 --- a/docs/content/reference/web-api/type-aliases/EmojiListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: EmojiListArguments - -```ts -type EmojiListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/emoji.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/emoji.ts#L4) diff --git a/docs/content/reference/web-api/type-aliases/EmojiListResponse.md b/docs/content/reference/web-api/type-aliases/EmojiListResponse.md deleted file mode 100644 index 058e4b2e7..000000000 --- a/docs/content/reference/web-api/type-aliases/EmojiListResponse.md +++ /dev/null @@ -1,63 +0,0 @@ -# Type Alias: EmojiListResponse - -```ts -type EmojiListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### cache\_ts? - -```ts -optional cache_ts: string; -``` - -### categories? - -```ts -optional categories: Category[]; -``` - -### categories\_version? - -```ts -optional categories_version: string; -``` - -### emoji? - -```ts -optional emoji: object; -``` - -#### Index Signature - - \[`key`: `string`\]: `string` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/EmojiListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/EmojiListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesCommentsAddResponse.md b/docs/content/reference/web-api/type-aliases/FilesCommentsAddResponse.md deleted file mode 100644 index 14b7a96b1..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesCommentsAddResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: FilesCommentsAddResponse - -```ts -type FilesCommentsAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### req\_method? - -```ts -optional req_method: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesCommentsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesCommentsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesCommentsDeleteResponse.md b/docs/content/reference/web-api/type-aliases/FilesCommentsDeleteResponse.md deleted file mode 100644 index b6aa5955c..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesCommentsDeleteResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: FilesCommentsDeleteResponse - -```ts -type FilesCommentsDeleteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesCommentsDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesCommentsDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesCommentsEditResponse.md b/docs/content/reference/web-api/type-aliases/FilesCommentsEditResponse.md deleted file mode 100644 index 112f384f4..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesCommentsEditResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: FilesCommentsEditResponse - -```ts -type FilesCommentsEditResponse: WebAPICallResult & object; -``` - -## Type declaration - -### comment? - -```ts -optional comment: Comment; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesCommentsEditResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesCommentsEditResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalArguments.md b/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalArguments.md deleted file mode 100644 index e8c559998..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalArguments.md +++ /dev/null @@ -1,31 +0,0 @@ -# Type Alias: FilesCompleteUploadExternalArguments - -```ts -type FilesCompleteUploadExternalArguments: FileDestinationArgument & TokenOverridable & object; -``` - -## Type declaration - -### files - -```ts -files: [FileUploadComplete, ...FileUploadComplete[]]; -``` - -#### Description - -Array of file IDs and their corresponding (optional) titles. - -### initial\_comment? - -```ts -optional initial_comment: string; -``` - -#### Description - -The message text introducing the file in the specified channel. - -## Defined in - -[packages/web-api/src/types/request/files.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L65) diff --git a/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalResponse.md b/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalResponse.md deleted file mode 100644 index ff2ac239b..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesCompleteUploadExternalResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: FilesCompleteUploadExternalResponse - -```ts -type FilesCompleteUploadExternalResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### files? - -```ts -optional files: File[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesCompleteUploadExternalResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesCompleteUploadExternalResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesDeleteResponse.md b/docs/content/reference/web-api/type-aliases/FilesDeleteResponse.md deleted file mode 100644 index 0ad5cfbec..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesDeleteResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: FilesDeleteResponse - -```ts -type FilesDeleteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesGetUploadURLExternalResponse.md b/docs/content/reference/web-api/type-aliases/FilesGetUploadURLExternalResponse.md deleted file mode 100644 index f505e3f90..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesGetUploadURLExternalResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: FilesGetUploadURLExternalResponse - -```ts -type FilesGetUploadURLExternalResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### file\_id? - -```ts -optional file_id: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### upload\_url? - -```ts -optional upload_url: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesGetUploadURLExternalResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesGetUploadURLExternalResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesInfoResponse.md b/docs/content/reference/web-api/type-aliases/FilesInfoResponse.md deleted file mode 100644 index 88148c40c..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesInfoResponse.md +++ /dev/null @@ -1,83 +0,0 @@ -# Type Alias: FilesInfoResponse - -```ts -type FilesInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### comments? - -```ts -optional comments: Comment[]; -``` - -### content? - -```ts -optional content: string; -``` - -### content\_highlight\_css? - -```ts -optional content_highlight_css: string; -``` - -### content\_highlight\_html? - -```ts -optional content_highlight_html: string; -``` - -### content\_highlight\_html\_truncated? - -```ts -optional content_highlight_html_truncated: boolean; -``` - -### error? - -```ts -optional error: string; -``` - -### file? - -```ts -optional file: File; -``` - -### is\_truncated? - -```ts -optional is_truncated: boolean; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### paging? - -```ts -optional paging: Paging; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesListResponse.md b/docs/content/reference/web-api/type-aliases/FilesListResponse.md deleted file mode 100644 index d28f85810..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: FilesListResponse - -```ts -type FilesListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### files? - -```ts -optional files: File[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### paging? - -```ts -optional paging: Paging; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteAddResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteAddResponse.md deleted file mode 100644 index 697ba2b63..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesRemoteAddResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: FilesRemoteAddResponse - -```ts -type FilesRemoteAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### file? - -```ts -optional file: File; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesRemoteAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteInfoArguments.md b/docs/content/reference/web-api/type-aliases/FilesRemoteInfoArguments.md deleted file mode 100644 index f0925e748..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesRemoteInfoArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: FilesRemoteInfoArguments - -```ts -type FilesRemoteInfoArguments: FileOrExternalID & TokenOverridable; -``` - -## Defined in - -[packages/web-api/src/types/request/files.ts:195](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L195) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteInfoResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteInfoResponse.md deleted file mode 100644 index 2c9c434d7..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesRemoteInfoResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: FilesRemoteInfoResponse - -```ts -type FilesRemoteInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### file? - -```ts -optional file: File; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesRemoteInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteListResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteListResponse.md deleted file mode 100644 index 7299a292c..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesRemoteListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: FilesRemoteListResponse - -```ts -type FilesRemoteListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### files? - -```ts -optional files: File[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesRemoteListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveArguments.md b/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveArguments.md deleted file mode 100644 index e272f2f5e..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: FilesRemoteRemoveArguments - -```ts -type FilesRemoteRemoveArguments: FileOrExternalID & TokenOverridable; -``` - -## Defined in - -[packages/web-api/src/types/request/files.ts:206](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L206) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveResponse.md deleted file mode 100644 index 80ceedd31..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesRemoteRemoveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: FilesRemoteRemoveResponse - -```ts -type FilesRemoteRemoveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesRemoteRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteShareArguments.md b/docs/content/reference/web-api/type-aliases/FilesRemoteShareArguments.md deleted file mode 100644 index e27bdc103..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesRemoteShareArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: FilesRemoteShareArguments - -```ts -type FilesRemoteShareArguments: Required & FileOrExternalID & TokenOverridable; -``` - -## Defined in - -[packages/web-api/src/types/request/files.ts:208](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L208) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteShareResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteShareResponse.md deleted file mode 100644 index c73cf1beb..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesRemoteShareResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: FilesRemoteShareResponse - -```ts -type FilesRemoteShareResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### file? - -```ts -optional file: File; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesRemoteShareResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteShareResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateArguments.md b/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateArguments.md deleted file mode 100644 index 73e400f5d..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: FilesRemoteUpdateArguments - -```ts -type FilesRemoteUpdateArguments: Partial & FileOrExternalID & FileType & TokenOverridable; -``` - -## Defined in - -[packages/web-api/src/types/request/files.ts:210](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L210) diff --git a/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateResponse.md b/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateResponse.md deleted file mode 100644 index 7b7cf78ac..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesRemoteUpdateResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: FilesRemoteUpdateResponse - -```ts -type FilesRemoteUpdateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### file? - -```ts -optional file: File; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesRemoteUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRemoteUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesRevokePublicURLResponse.md b/docs/content/reference/web-api/type-aliases/FilesRevokePublicURLResponse.md deleted file mode 100644 index dff96549e..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesRevokePublicURLResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: FilesRevokePublicURLResponse - -```ts -type FilesRevokePublicURLResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### file? - -```ts -optional file: File; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesRevokePublicURLResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesRevokePublicURLResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesSharedPublicURLResponse.md b/docs/content/reference/web-api/type-aliases/FilesSharedPublicURLResponse.md deleted file mode 100644 index 4c9887414..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesSharedPublicURLResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: FilesSharedPublicURLResponse - -```ts -type FilesSharedPublicURLResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### file? - -```ts -optional file: File; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesSharedPublicURLResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesSharedPublicURLResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesUploadArguments.md b/docs/content/reference/web-api/type-aliases/FilesUploadArguments.md deleted file mode 100644 index 5482c38df..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesUploadArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: FilesUploadArguments - -```ts -type FilesUploadArguments: FileUpload & TokenOverridable; -``` - -## Defined in - -[packages/web-api/src/types/request/files.ts:140](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L140) diff --git a/docs/content/reference/web-api/type-aliases/FilesUploadResponse.md b/docs/content/reference/web-api/type-aliases/FilesUploadResponse.md deleted file mode 100644 index e32fa7191..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesUploadResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: FilesUploadResponse - -```ts -type FilesUploadResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### file? - -```ts -optional file: File; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FilesUploadResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FilesUploadResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FilesUploadV2Arguments.md b/docs/content/reference/web-api/type-aliases/FilesUploadV2Arguments.md deleted file mode 100644 index 1f543e0d8..000000000 --- a/docs/content/reference/web-api/type-aliases/FilesUploadV2Arguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: FilesUploadV2Arguments - -```ts -type FilesUploadV2Arguments: TokenOverridable & FileUploadV2 | Omit & FilesUploadV2ArgumentsMultipleFiles; -``` - -## Defined in - -[packages/web-api/src/types/request/files.ts:158](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L158) diff --git a/docs/content/reference/web-api/type-aliases/FunctionsCompleteErrorResponse.md b/docs/content/reference/web-api/type-aliases/FunctionsCompleteErrorResponse.md deleted file mode 100644 index 70b83a8e8..000000000 --- a/docs/content/reference/web-api/type-aliases/FunctionsCompleteErrorResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: FunctionsCompleteErrorResponse - -```ts -type FunctionsCompleteErrorResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FunctionsCompleteErrorResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FunctionsCompleteErrorResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/FunctionsCompleteSuccessResponse.md b/docs/content/reference/web-api/type-aliases/FunctionsCompleteSuccessResponse.md deleted file mode 100644 index c96a612f5..000000000 --- a/docs/content/reference/web-api/type-aliases/FunctionsCompleteSuccessResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: FunctionsCompleteSuccessResponse - -```ts -type FunctionsCompleteSuccessResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/FunctionsCompleteSuccessResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/FunctionsCompleteSuccessResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsArchiveResponse.md b/docs/content/reference/web-api/type-aliases/GroupsArchiveResponse.md deleted file mode 100644 index e0905d9be..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsArchiveResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: GroupsArchiveResponse - -```ts -type GroupsArchiveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsArchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsArchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsCloseResponse.md b/docs/content/reference/web-api/type-aliases/GroupsCloseResponse.md deleted file mode 100644 index e121a40cb..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsCloseResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: GroupsCloseResponse - -```ts -type GroupsCloseResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsCloseResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsCloseResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsCreateChildResponse.md b/docs/content/reference/web-api/type-aliases/GroupsCreateChildResponse.md deleted file mode 100644 index 00965f805..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsCreateChildResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: GroupsCreateChildResponse - -```ts -type GroupsCreateChildResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### group? - -```ts -optional group: Group; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsCreateChildResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsCreateChildResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsCreateResponse.md b/docs/content/reference/web-api/type-aliases/GroupsCreateResponse.md deleted file mode 100644 index 1dee8475b..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsCreateResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: GroupsCreateResponse - -```ts -type GroupsCreateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### group? - -```ts -optional group: Group; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsHistoryResponse.md b/docs/content/reference/web-api/type-aliases/GroupsHistoryResponse.md deleted file mode 100644 index 863cd8273..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsHistoryResponse.md +++ /dev/null @@ -1,65 +0,0 @@ -# Type Alias: GroupsHistoryResponse - -```ts -type GroupsHistoryResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel\_actions\_count? - -```ts -optional channel_actions_count: number; -``` - -### error? - -```ts -optional error: string; -``` - -### has\_more? - -```ts -optional has_more: boolean; -``` - -### messages? - -```ts -optional messages: Message[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsHistoryResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsHistoryResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsInfoResponse.md b/docs/content/reference/web-api/type-aliases/GroupsInfoResponse.md deleted file mode 100644 index 2d29dd4f9..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsInfoResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: GroupsInfoResponse - -```ts -type GroupsInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### group? - -```ts -optional group: Group; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsInviteResponse.md b/docs/content/reference/web-api/type-aliases/GroupsInviteResponse.md deleted file mode 100644 index 4aa24643c..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsInviteResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: GroupsInviteResponse - -```ts -type GroupsInviteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### group? - -```ts -optional group: Group; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsInviteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsInviteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsKickResponse.md b/docs/content/reference/web-api/type-aliases/GroupsKickResponse.md deleted file mode 100644 index 31ae1f65e..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsKickResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: GroupsKickResponse - -```ts -type GroupsKickResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsKickResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsKickResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsLeaveResponse.md b/docs/content/reference/web-api/type-aliases/GroupsLeaveResponse.md deleted file mode 100644 index 545959aaf..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsLeaveResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: GroupsLeaveResponse - -```ts -type GroupsLeaveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsLeaveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsLeaveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsListResponse.md b/docs/content/reference/web-api/type-aliases/GroupsListResponse.md deleted file mode 100644 index 0055569b2..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsListResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: GroupsListResponse - -```ts -type GroupsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### groups? - -```ts -optional groups: Group[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsMarkResponse.md b/docs/content/reference/web-api/type-aliases/GroupsMarkResponse.md deleted file mode 100644 index c83625468..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsMarkResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: GroupsMarkResponse - -```ts -type GroupsMarkResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsMarkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsMarkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsOpenResponse.md b/docs/content/reference/web-api/type-aliases/GroupsOpenResponse.md deleted file mode 100644 index ffe6b9eef..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsOpenResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -# Type Alias: GroupsOpenResponse - -```ts -type GroupsOpenResponse: WebAPICallResult & object; -``` - -## Type declaration - -### already\_open? - -```ts -optional already_open: boolean; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### no\_op? - -```ts -optional no_op: boolean; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsRenameResponse.md b/docs/content/reference/web-api/type-aliases/GroupsRenameResponse.md deleted file mode 100644 index 4bf04f4df..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsRenameResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: GroupsRenameResponse - -```ts -type GroupsRenameResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsRenameResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsRenameResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsRepliesResponse.md b/docs/content/reference/web-api/type-aliases/GroupsRepliesResponse.md deleted file mode 100644 index 237b1e46d..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsRepliesResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -# Type Alias: GroupsRepliesResponse - -```ts -type GroupsRepliesResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### has\_more? - -```ts -optional has_more: boolean; -``` - -### messages? - -```ts -optional messages: Message[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsRepliesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsRepliesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsSetPurposeResponse.md b/docs/content/reference/web-api/type-aliases/GroupsSetPurposeResponse.md deleted file mode 100644 index 6f9507d61..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsSetPurposeResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: GroupsSetPurposeResponse - -```ts -type GroupsSetPurposeResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### purpose? - -```ts -optional purpose: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsSetPurposeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsSetPurposeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsSetTopicResponse.md b/docs/content/reference/web-api/type-aliases/GroupsSetTopicResponse.md deleted file mode 100644 index 67c8c6dfa..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsSetTopicResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: GroupsSetTopicResponse - -```ts -type GroupsSetTopicResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### topic? - -```ts -optional topic: string; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsSetTopicResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsSetTopicResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/GroupsUnarchiveResponse.md b/docs/content/reference/web-api/type-aliases/GroupsUnarchiveResponse.md deleted file mode 100644 index 650dcb2b8..000000000 --- a/docs/content/reference/web-api/type-aliases/GroupsUnarchiveResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: GroupsUnarchiveResponse - -```ts -type GroupsUnarchiveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/GroupsUnarchiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/GroupsUnarchiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImCloseResponse.md b/docs/content/reference/web-api/type-aliases/ImCloseResponse.md deleted file mode 100644 index 710e4d39d..000000000 --- a/docs/content/reference/web-api/type-aliases/ImCloseResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: ImCloseResponse - -```ts -type ImCloseResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ImCloseResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImCloseResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImHistoryResponse.md b/docs/content/reference/web-api/type-aliases/ImHistoryResponse.md deleted file mode 100644 index 9265484f0..000000000 --- a/docs/content/reference/web-api/type-aliases/ImHistoryResponse.md +++ /dev/null @@ -1,65 +0,0 @@ -# Type Alias: ImHistoryResponse - -```ts -type ImHistoryResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel\_actions\_count? - -```ts -optional channel_actions_count: number; -``` - -### error? - -```ts -optional error: string; -``` - -### has\_more? - -```ts -optional has_more: boolean; -``` - -### messages? - -```ts -optional messages: Message[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ImHistoryResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImHistoryResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImListResponse.md b/docs/content/reference/web-api/type-aliases/ImListResponse.md deleted file mode 100644 index 83ca433e6..000000000 --- a/docs/content/reference/web-api/type-aliases/ImListResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ImListResponse - -```ts -type ImListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### ims? - -```ts -optional ims: Im[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ImListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImMarkResponse.md b/docs/content/reference/web-api/type-aliases/ImMarkResponse.md deleted file mode 100644 index 34c0ab824..000000000 --- a/docs/content/reference/web-api/type-aliases/ImMarkResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: ImMarkResponse - -```ts -type ImMarkResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ImMarkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImMarkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImOpenResponse.md b/docs/content/reference/web-api/type-aliases/ImOpenResponse.md deleted file mode 100644 index ed29b2ad7..000000000 --- a/docs/content/reference/web-api/type-aliases/ImOpenResponse.md +++ /dev/null @@ -1,65 +0,0 @@ -# Type Alias: ImOpenResponse - -```ts -type ImOpenResponse: WebAPICallResult & object; -``` - -## Type declaration - -### already\_open? - -```ts -optional already_open: boolean; -``` - -### channel? - -```ts -optional channel: Channel; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### no\_op? - -```ts -optional no_op: boolean; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ImOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImRepliesResponse.md b/docs/content/reference/web-api/type-aliases/ImRepliesResponse.md deleted file mode 100644 index 648f7184e..000000000 --- a/docs/content/reference/web-api/type-aliases/ImRepliesResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -# Type Alias: ImRepliesResponse - -```ts -type ImRepliesResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### has\_more? - -```ts -optional has_more: boolean; -``` - -### messages? - -```ts -optional messages: Message[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ImRepliesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ImRepliesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ImageBlock.md b/docs/content/reference/web-api/type-aliases/ImageBlock.md deleted file mode 100644 index ad11fdda3..000000000 --- a/docs/content/reference/web-api/type-aliases/ImageBlock.md +++ /dev/null @@ -1,51 +0,0 @@ -# Type Alias: ImageBlock - -```ts -type ImageBlock: object & Block & UrlImageObject | SlackFileImageObject; -``` - -## Type declaration - -### alt\_text - -```ts -alt_text: string; -``` - -#### Description - -A plain-text summary of the image. This should not contain any markup. -Maximum length for this field is 2000 characters. - -### title? - -```ts -optional title: PlainTextElement; -``` - -#### Description - -An optional title for the image in the form of a [PlainTextElement](../interfaces/PlainTextElement.md) object. -Maximum length for the text in this field is 2000 characters. - -### type - -```ts -type: "image"; -``` - -#### Description - -The type of block. For an image block, `type` is always `image`. - -## Description - -Displays an image. A simple image block, designed to make those cat photos really pop. - -## See - -[Image block reference](https://api.slack.com/reference/block-kit/blocks#image). - -## Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:98 diff --git a/docs/content/reference/web-api/type-aliases/ImageElement.md b/docs/content/reference/web-api/type-aliases/ImageElement.md deleted file mode 100644 index f6ea1688a..000000000 --- a/docs/content/reference/web-api/type-aliases/ImageElement.md +++ /dev/null @@ -1,40 +0,0 @@ -# Type Alias: ImageElement - -```ts -type ImageElement: object & UrlImageObject | SlackFileImageObject; -``` - -## Type declaration - -### alt\_text - -```ts -alt_text: string; -``` - -#### Description - -A plain-text summary of the image. This should not contain any markup. - -### type - -```ts -type: "image"; -``` - -#### Description - -The type of element. In this case `type` is always `image`. - -## Description - -Displays an image as part of a larger block of content. Use this `image` block if you want a block with -only an image in it. - -## See - -[Image element reference](https://api.slack.com/reference/block-kit/block-elements#image). - -## Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:143 diff --git a/docs/content/reference/web-api/type-aliases/KnownBlock.md b/docs/content/reference/web-api/type-aliases/KnownBlock.md deleted file mode 100644 index 8bc6b8290..000000000 --- a/docs/content/reference/web-api/type-aliases/KnownBlock.md +++ /dev/null @@ -1,19 +0,0 @@ -# Type Alias: KnownBlock - -```ts -type KnownBlock: - | ImageBlock - | ContextBlock - | ActionsBlock - | DividerBlock - | SectionBlock - | InputBlock - | FileBlock - | HeaderBlock - | VideoBlock - | RichTextBlock; -``` - -## Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 diff --git a/docs/content/reference/web-api/type-aliases/MigrationExchangeResponse.md b/docs/content/reference/web-api/type-aliases/MigrationExchangeResponse.md deleted file mode 100644 index 8a2ed0f72..000000000 --- a/docs/content/reference/web-api/type-aliases/MigrationExchangeResponse.md +++ /dev/null @@ -1,69 +0,0 @@ -# Type Alias: MigrationExchangeResponse - -```ts -type MigrationExchangeResponse: WebAPICallResult & object; -``` - -## Type declaration - -### enterprise\_id? - -```ts -optional enterprise_id: string; -``` - -### error? - -```ts -optional error: string; -``` - -### invalid\_user\_ids? - -```ts -optional invalid_user_ids: string[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### team\_id? - -```ts -optional team_id: string; -``` - -### user\_id\_map? - -```ts -optional user_id_map: object; -``` - -#### Index Signature - - \[`key`: `string`\]: `string` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/MigrationExchangeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MigrationExchangeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimCloseResponse.md b/docs/content/reference/web-api/type-aliases/MpimCloseResponse.md deleted file mode 100644 index 8149cf332..000000000 --- a/docs/content/reference/web-api/type-aliases/MpimCloseResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: MpimCloseResponse - -```ts -type MpimCloseResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/MpimCloseResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimCloseResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimHistoryResponse.md b/docs/content/reference/web-api/type-aliases/MpimHistoryResponse.md deleted file mode 100644 index d77868cff..000000000 --- a/docs/content/reference/web-api/type-aliases/MpimHistoryResponse.md +++ /dev/null @@ -1,65 +0,0 @@ -# Type Alias: MpimHistoryResponse - -```ts -type MpimHistoryResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel\_actions\_count? - -```ts -optional channel_actions_count: number; -``` - -### error? - -```ts -optional error: string; -``` - -### has\_more? - -```ts -optional has_more: boolean; -``` - -### messages? - -```ts -optional messages: Message[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/MpimHistoryResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimHistoryResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimListResponse.md b/docs/content/reference/web-api/type-aliases/MpimListResponse.md deleted file mode 100644 index fc751d721..000000000 --- a/docs/content/reference/web-api/type-aliases/MpimListResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: MpimListResponse - -```ts -type MpimListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### groups? - -```ts -optional groups: Group[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/MpimListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimMarkResponse.md b/docs/content/reference/web-api/type-aliases/MpimMarkResponse.md deleted file mode 100644 index 8c2c179bb..000000000 --- a/docs/content/reference/web-api/type-aliases/MpimMarkResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: MpimMarkResponse - -```ts -type MpimMarkResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/MpimMarkResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimMarkResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimOpenResponse.md b/docs/content/reference/web-api/type-aliases/MpimOpenResponse.md deleted file mode 100644 index f236a4717..000000000 --- a/docs/content/reference/web-api/type-aliases/MpimOpenResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: MpimOpenResponse - -```ts -type MpimOpenResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### group? - -```ts -optional group: Group; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/MpimOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MpimRepliesResponse.md b/docs/content/reference/web-api/type-aliases/MpimRepliesResponse.md deleted file mode 100644 index 106e9d6ec..000000000 --- a/docs/content/reference/web-api/type-aliases/MpimRepliesResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -# Type Alias: MpimRepliesResponse - -```ts -type MpimRepliesResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### has\_more? - -```ts -optional has_more: boolean; -``` - -### messages? - -```ts -optional messages: Message[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/MpimRepliesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/MpimRepliesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/MultiSelect.md b/docs/content/reference/web-api/type-aliases/MultiSelect.md deleted file mode 100644 index 5b70c07b8..000000000 --- a/docs/content/reference/web-api/type-aliases/MultiSelect.md +++ /dev/null @@ -1,28 +0,0 @@ -# Type Alias: MultiSelect - -```ts -type MultiSelect: - | MultiUsersSelect - | MultiStaticSelect - | MultiConversationsSelect - | MultiChannelsSelect - | MultiExternalSelect; -``` - -## Description - -Allows users to select multiple items from a list of options. -Just like regular [Select](Select.md), multi-select menus also include type-ahead functionality, where a user can type a -part or all of an option string to filter the list. -There are different types of multi-select menu that depend on different data sources for their lists of options: -[MultiStaticSelect](../interfaces/MultiStaticSelect.md), [MultiExternalSelect](../interfaces/MultiExternalSelect.md), [MultiUsersSelect](../interfaces/MultiUsersSelect.md), [MultiConversationsSelect](../interfaces/MultiConversationsSelect.md), -[MultiChannelsSelect](../interfaces/MultiChannelsSelect.md). - -## See - - - [Multi-select menu element reference](https://api.slack.com/reference/block-kit/block-elements#multi_select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:173 diff --git a/docs/content/reference/web-api/type-aliases/OauthAccessResponse.md b/docs/content/reference/web-api/type-aliases/OauthAccessResponse.md deleted file mode 100644 index 16ac1841c..000000000 --- a/docs/content/reference/web-api/type-aliases/OauthAccessResponse.md +++ /dev/null @@ -1,113 +0,0 @@ -# Type Alias: OauthAccessResponse - -```ts -type OauthAccessResponse: WebAPICallResult & object; -``` - -## Type declaration - -### access\_token? - -```ts -optional access_token: string; -``` - -### authorizing\_user? - -```ts -optional authorizing_user: User; -``` - -### bot? - -```ts -optional bot: Bot; -``` - -### enterprise\_id? - -```ts -optional enterprise_id: string; -``` - -### error? - -```ts -optional error: string; -``` - -### incoming\_webhook? - -```ts -optional incoming_webhook: IncomingWebhook; -``` - -### installer\_user? - -```ts -optional installer_user: User; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### scope? - -```ts -optional scope: string; -``` - -### scopes? - -```ts -optional scopes: Scopes; -``` - -### team\_id? - -```ts -optional team_id: string; -``` - -### team\_name? - -```ts -optional team_name: string; -``` - -### token\_type? - -```ts -optional token_type: string; -``` - -### user\_id? - -```ts -optional user_id: string; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/OauthAccessResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OauthAccessResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/OauthTokenResponse.md b/docs/content/reference/web-api/type-aliases/OauthTokenResponse.md deleted file mode 100644 index b7b8b43e6..000000000 --- a/docs/content/reference/web-api/type-aliases/OauthTokenResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: OauthTokenResponse - -```ts -type OauthTokenResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### req\_method? - -```ts -optional req_method: string; -``` - -## Defined in - -[packages/web-api/src/types/response/OauthTokenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OauthTokenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/OauthV2AccessResponse.md b/docs/content/reference/web-api/type-aliases/OauthV2AccessResponse.md deleted file mode 100644 index 3b59ab10b..000000000 --- a/docs/content/reference/web-api/type-aliases/OauthV2AccessResponse.md +++ /dev/null @@ -1,113 +0,0 @@ -# Type Alias: OauthV2AccessResponse - -```ts -type OauthV2AccessResponse: WebAPICallResult & object; -``` - -## Type declaration - -### access\_token? - -```ts -optional access_token: string; -``` - -### app\_id? - -```ts -optional app_id: string; -``` - -### authed\_user? - -```ts -optional authed_user: AuthedUser; -``` - -### bot\_user\_id? - -```ts -optional bot_user_id: string; -``` - -### enterprise? - -```ts -optional enterprise: Enterprise; -``` - -### error? - -```ts -optional error: string; -``` - -### expires\_in? - -```ts -optional expires_in: number; -``` - -### incoming\_webhook? - -```ts -optional incoming_webhook: IncomingWebhook; -``` - -### is\_enterprise\_install? - -```ts -optional is_enterprise_install: boolean; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### refresh\_token? - -```ts -optional refresh_token: string; -``` - -### scope? - -```ts -optional scope: string; -``` - -### team? - -```ts -optional team: Enterprise; -``` - -### token\_type? - -```ts -optional token_type: string; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/OauthV2AccessResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OauthV2AccessResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/OauthV2ExchangeResponse.md b/docs/content/reference/web-api/type-aliases/OauthV2ExchangeResponse.md deleted file mode 100644 index 53ca9d1be..000000000 --- a/docs/content/reference/web-api/type-aliases/OauthV2ExchangeResponse.md +++ /dev/null @@ -1,119 +0,0 @@ -# Type Alias: OauthV2ExchangeResponse - -```ts -type OauthV2ExchangeResponse: WebAPICallResult & object; -``` - -## Type declaration - -### access\_token? - -```ts -optional access_token: string; -``` - -### app\_id? - -```ts -optional app_id: string; -``` - -### authed\_user? - -```ts -optional authed_user: AuthedUser; -``` - -### bot\_user\_id? - -```ts -optional bot_user_id: string; -``` - -### enterprise? - -```ts -optional enterprise: Enterprise; -``` - -### error? - -```ts -optional error: string; -``` - -### expires\_in? - -```ts -optional expires_in: number; -``` - -### incoming\_webhook? - -```ts -optional incoming_webhook: IncomingWebhook; -``` - -### is\_enterprise\_install? - -```ts -optional is_enterprise_install: boolean; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### refresh\_token? - -```ts -optional refresh_token: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### scope? - -```ts -optional scope: string; -``` - -### team? - -```ts -optional team: Enterprise; -``` - -### token\_type? - -```ts -optional token_type: string; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/OauthV2ExchangeResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OauthV2ExchangeResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/OpenIDConnectTokenResponse.md b/docs/content/reference/web-api/type-aliases/OpenIDConnectTokenResponse.md deleted file mode 100644 index 77f57f102..000000000 --- a/docs/content/reference/web-api/type-aliases/OpenIDConnectTokenResponse.md +++ /dev/null @@ -1,71 +0,0 @@ -# Type Alias: OpenIDConnectTokenResponse - -```ts -type OpenIDConnectTokenResponse: WebAPICallResult & object; -``` - -## Type declaration - -### access\_token? - -```ts -optional access_token: string; -``` - -### error? - -```ts -optional error: string; -``` - -### expires\_in? - -```ts -optional expires_in: number; -``` - -### id\_token? - -```ts -optional id_token: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### refresh\_token? - -```ts -optional refresh_token: string; -``` - -### token\_type? - -```ts -optional token_type: string; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/OpenIDConnectTokenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OpenIDConnectTokenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoArguments.md b/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoArguments.md deleted file mode 100644 index 25723df6e..000000000 --- a/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: OpenIDConnectUserInfoArguments - -```ts -type OpenIDConnectUserInfoArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/openid.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/openid.ts#L8) diff --git a/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoResponse.md b/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoResponse.md deleted file mode 100644 index 44b1589ba..000000000 --- a/docs/content/reference/web-api/type-aliases/OpenIDConnectUserInfoResponse.md +++ /dev/null @@ -1,221 +0,0 @@ -# Type Alias: OpenIDConnectUserInfoResponse - -```ts -type OpenIDConnectUserInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### date\_email\_verified? - -```ts -optional date_email_verified: number; -``` - -### email? - -```ts -optional email: string; -``` - -### email\_verified? - -```ts -optional email_verified: boolean; -``` - -### error? - -```ts -optional error: string; -``` - -### family\_name? - -```ts -optional family_name: string; -``` - -### given\_name? - -```ts -optional given_name: string; -``` - -### https://slack.com/enterprise\_domain? - -```ts -optional com/enterprise_domain: string; -``` - -### https://slack.com/enterprise\_id? - -```ts -optional com/enterprise_id: string; -``` - -### https://slack.com/enterprise\_name? - -```ts -optional com/enterprise_name: string; -``` - -### https://slack.com/team\_domain? - -```ts -optional com/team_domain: string; -``` - -### https://slack.com/team\_id? - -```ts -optional com/team_id: string; -``` - -### https://slack.com/team\_image\_102? - -```ts -optional com/team_image_102: string; -``` - -### https://slack.com/team\_image\_132? - -```ts -optional com/team_image_132: string; -``` - -### https://slack.com/team\_image\_230? - -```ts -optional com/team_image_230: string; -``` - -### https://slack.com/team\_image\_34? - -```ts -optional com/team_image_34: string; -``` - -### https://slack.com/team\_image\_44? - -```ts -optional com/team_image_44: string; -``` - -### https://slack.com/team\_image\_68? - -```ts -optional com/team_image_68: string; -``` - -### https://slack.com/team\_image\_88? - -```ts -optional com/team_image_88: string; -``` - -### https://slack.com/team\_name? - -```ts -optional com/team_name: string; -``` - -### https://slack.com/user\_id? - -```ts -optional com/user_id: string; -``` - -### https://slack.com/user\_image\_1024? - -```ts -optional com/user_image_1024: string; -``` - -### https://slack.com/user\_image\_192? - -```ts -optional com/user_image_192: string; -``` - -### https://slack.com/user\_image\_24? - -```ts -optional com/user_image_24: string; -``` - -### https://slack.com/user\_image\_32? - -```ts -optional com/user_image_32: string; -``` - -### https://slack.com/user\_image\_48? - -```ts -optional com/user_image_48: string; -``` - -### https://slack.com/user\_image\_512? - -```ts -optional com/user_image_512: string; -``` - -### https://slack.com/user\_image\_72? - -```ts -optional com/user_image_72: string; -``` - -### locale? - -```ts -optional locale: string; -``` - -### name? - -```ts -optional name: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### picture? - -```ts -optional picture: string; -``` - -### provided? - -```ts -optional provided: string; -``` - -### sub? - -```ts -optional sub: string; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/OpenIDConnectUserInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/OpenIDConnectUserInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/Option.md b/docs/content/reference/web-api/type-aliases/Option.md deleted file mode 100644 index ef8cc3f5a..000000000 --- a/docs/content/reference/web-api/type-aliases/Option.md +++ /dev/null @@ -1,18 +0,0 @@ -# Type Alias: Option - -```ts -type Option: MrkdwnOption | PlainTextOption; -``` - -## Description - -Defines a single item in a number of item selection elements. An object that represents a single -selectable item in a select menu, multi-select menu, checkbox group, radio button group, or overflow menu. - -## See - -[Option object reference](https://api.slack.com/reference/block-kit/composition-objects#option). - -## Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:92 diff --git a/docs/content/reference/web-api/type-aliases/PageAccumulator.md b/docs/content/reference/web-api/type-aliases/PageAccumulator.md deleted file mode 100644 index b48e73399..000000000 --- a/docs/content/reference/web-api/type-aliases/PageAccumulator.md +++ /dev/null @@ -1,13 +0,0 @@ -# Type Alias: PageAccumulator\ - -```ts -type PageAccumulator: R extends (accumulator, page, index) => infer A ? A : never; -``` - -## Type Parameters - -• **R** *extends* [`PageReducer`](../interfaces/PageReducer.md) - -## Defined in - -[packages/web-api/src/WebClient.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L117) diff --git a/docs/content/reference/web-api/type-aliases/PinsAddResponse.md b/docs/content/reference/web-api/type-aliases/PinsAddResponse.md deleted file mode 100644 index 12c1a47ec..000000000 --- a/docs/content/reference/web-api/type-aliases/PinsAddResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: PinsAddResponse - -```ts -type PinsAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/PinsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/PinsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/PinsListResponse.md b/docs/content/reference/web-api/type-aliases/PinsListResponse.md deleted file mode 100644 index f05129962..000000000 --- a/docs/content/reference/web-api/type-aliases/PinsListResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: PinsListResponse - -```ts -type PinsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### items? - -```ts -optional items: Item[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/PinsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/PinsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/PinsRemoveResponse.md b/docs/content/reference/web-api/type-aliases/PinsRemoveResponse.md deleted file mode 100644 index b3ea6f8e9..000000000 --- a/docs/content/reference/web-api/type-aliases/PinsRemoveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: PinsRemoveResponse - -```ts -type PinsRemoveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/PinsRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/PinsRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RTMConnectArguments.md b/docs/content/reference/web-api/type-aliases/RTMConnectArguments.md deleted file mode 100644 index 3f4f222ad..000000000 --- a/docs/content/reference/web-api/type-aliases/RTMConnectArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: RTMConnectArguments - -```ts -type RTMConnectArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/rtm.ts:5](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/rtm.ts#L5) diff --git a/docs/content/reference/web-api/type-aliases/RTMStartArguments.md b/docs/content/reference/web-api/type-aliases/RTMStartArguments.md deleted file mode 100644 index 9e7307d78..000000000 --- a/docs/content/reference/web-api/type-aliases/RTMStartArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: RTMStartArguments - -```ts -type RTMStartArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/rtm.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/rtm.ts#L18) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsAddResponse.md b/docs/content/reference/web-api/type-aliases/ReactionsAddResponse.md deleted file mode 100644 index 4dd78996e..000000000 --- a/docs/content/reference/web-api/type-aliases/ReactionsAddResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ReactionsAddResponse - -```ts -type ReactionsAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ReactionsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ReactionsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsGetArguments.md b/docs/content/reference/web-api/type-aliases/ReactionsGetArguments.md deleted file mode 100644 index 8f5bfc015..000000000 --- a/docs/content/reference/web-api/type-aliases/ReactionsGetArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: ReactionsGetArguments - -```ts -type ReactionsGetArguments: ReactionsFull & TokenOverridable & MessageArgument | FileArgument | FileCommentArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/reactions.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reactions.ts#L23) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsGetResponse.md b/docs/content/reference/web-api/type-aliases/ReactionsGetResponse.md deleted file mode 100644 index 00f6bf24d..000000000 --- a/docs/content/reference/web-api/type-aliases/ReactionsGetResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ReactionsGetResponse - -```ts -type ReactionsGetResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channel? - -```ts -optional channel: string; -``` - -### error? - -```ts -optional error: string; -``` - -### message? - -```ts -optional message: Message; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### type? - -```ts -optional type: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ReactionsGetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ReactionsGetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsListArguments.md b/docs/content/reference/web-api/type-aliases/ReactionsListArguments.md deleted file mode 100644 index f5d9d2866..000000000 --- a/docs/content/reference/web-api/type-aliases/ReactionsListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: ReactionsListArguments - -```ts -type ReactionsListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/reactions.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reactions.ts#L27) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsListResponse.md b/docs/content/reference/web-api/type-aliases/ReactionsListResponse.md deleted file mode 100644 index 6c9a2cd2d..000000000 --- a/docs/content/reference/web-api/type-aliases/ReactionsListResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ReactionsListResponse - -```ts -type ReactionsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### items? - -```ts -optional items: Item[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### paging? - -```ts -optional paging: Paging; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/ReactionsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ReactionsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsRemoveArguments.md b/docs/content/reference/web-api/type-aliases/ReactionsRemoveArguments.md deleted file mode 100644 index a315d2850..000000000 --- a/docs/content/reference/web-api/type-aliases/ReactionsRemoveArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: ReactionsRemoveArguments - -```ts -type ReactionsRemoveArguments: TokenOverridable & ReactionName & MessageArgument | FileArgument | FileCommentArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/reactions.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reactions.ts#L33) diff --git a/docs/content/reference/web-api/type-aliases/ReactionsRemoveResponse.md b/docs/content/reference/web-api/type-aliases/ReactionsRemoveResponse.md deleted file mode 100644 index 88b0b734c..000000000 --- a/docs/content/reference/web-api/type-aliases/ReactionsRemoveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: ReactionsRemoveResponse - -```ts -type ReactionsRemoveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ReactionsRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ReactionsRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RemindersAddResponse.md b/docs/content/reference/web-api/type-aliases/RemindersAddResponse.md deleted file mode 100644 index e881c055a..000000000 --- a/docs/content/reference/web-api/type-aliases/RemindersAddResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: RemindersAddResponse - -```ts -type RemindersAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### reminder? - -```ts -optional reminder: Reminder; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/RemindersAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RemindersAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RemindersCompleteResponse.md b/docs/content/reference/web-api/type-aliases/RemindersCompleteResponse.md deleted file mode 100644 index e5a82ecd1..000000000 --- a/docs/content/reference/web-api/type-aliases/RemindersCompleteResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: RemindersCompleteResponse - -```ts -type RemindersCompleteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/RemindersCompleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RemindersCompleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RemindersDeleteResponse.md b/docs/content/reference/web-api/type-aliases/RemindersDeleteResponse.md deleted file mode 100644 index a55fae960..000000000 --- a/docs/content/reference/web-api/type-aliases/RemindersDeleteResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: RemindersDeleteResponse - -```ts -type RemindersDeleteResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/RemindersDeleteResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RemindersDeleteResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RemindersInfoResponse.md b/docs/content/reference/web-api/type-aliases/RemindersInfoResponse.md deleted file mode 100644 index e86f231ef..000000000 --- a/docs/content/reference/web-api/type-aliases/RemindersInfoResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: RemindersInfoResponse - -```ts -type RemindersInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### reminder? - -```ts -optional reminder: Reminder; -``` - -## Defined in - -[packages/web-api/src/types/response/RemindersInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RemindersInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RemindersListArguments.md b/docs/content/reference/web-api/type-aliases/RemindersListArguments.md deleted file mode 100644 index 1b7437229..000000000 --- a/docs/content/reference/web-api/type-aliases/RemindersListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: RemindersListArguments - -```ts -type RemindersListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/reminders.ts:55](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/reminders.ts#L55) diff --git a/docs/content/reference/web-api/type-aliases/RemindersListResponse.md b/docs/content/reference/web-api/type-aliases/RemindersListResponse.md deleted file mode 100644 index 125c0f936..000000000 --- a/docs/content/reference/web-api/type-aliases/RemindersListResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: RemindersListResponse - -```ts -type RemindersListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### reminders? - -```ts -optional reminders: Reminder[]; -``` - -## Defined in - -[packages/web-api/src/types/response/RemindersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RemindersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RichTextElement.md b/docs/content/reference/web-api/type-aliases/RichTextElement.md deleted file mode 100644 index 16594c8f9..000000000 --- a/docs/content/reference/web-api/type-aliases/RichTextElement.md +++ /dev/null @@ -1,23 +0,0 @@ -# Type Alias: RichTextElement - -```ts -type RichTextElement: - | RichTextBroadcastMention - | RichTextColor - | RichTextChannelMention - | RichTextDate - | RichTextEmoji - | RichTextLink - | RichTextTeamMention - | RichTextText - | RichTextUserMention - | RichTextUsergroupMention; -``` - -## Description - -Union of rich text sub-elements for use within rich text blocks. - -## Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:813 diff --git a/docs/content/reference/web-api/type-aliases/RtmConnectResponse.md b/docs/content/reference/web-api/type-aliases/RtmConnectResponse.md deleted file mode 100644 index b66c64f81..000000000 --- a/docs/content/reference/web-api/type-aliases/RtmConnectResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: RtmConnectResponse - -```ts -type RtmConnectResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### self? - -```ts -optional self: Self; -``` - -### team? - -```ts -optional team: Team; -``` - -### url? - -```ts -optional url: string; -``` - -## Defined in - -[packages/web-api/src/types/response/RtmConnectResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RtmConnectResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/RtmStartResponse.md b/docs/content/reference/web-api/type-aliases/RtmStartResponse.md deleted file mode 100644 index 1ab82f965..000000000 --- a/docs/content/reference/web-api/type-aliases/RtmStartResponse.md +++ /dev/null @@ -1,173 +0,0 @@ -# Type Alias: RtmStartResponse - -```ts -type RtmStartResponse: WebAPICallResult & object; -``` - -## Type declaration - -### accept\_tos\_url? - -```ts -optional accept_tos_url: string; -``` - -### bots? - -```ts -optional bots: Bot[]; -``` - -### cache\_ts? - -```ts -optional cache_ts: number; -``` - -### cache\_ts\_version? - -```ts -optional cache_ts_version: string; -``` - -### cache\_version? - -```ts -optional cache_version: string; -``` - -### can\_manage\_shared\_channels? - -```ts -optional can_manage_shared_channels: boolean; -``` - -### channels? - -```ts -optional channels: Channel[]; -``` - -### dnd? - -```ts -optional dnd: Dnd; -``` - -### error? - -```ts -optional error: string; -``` - -### groups? - -```ts -optional groups: Group[]; -``` - -### ims? - -```ts -optional ims: Im[]; -``` - -### is\_europe? - -```ts -optional is_europe: boolean; -``` - -### latest\_event\_ts? - -```ts -optional latest_event_ts: string; -``` - -### links? - -```ts -optional links: Links; -``` - -### mobile\_app\_requires\_upgrade? - -```ts -optional mobile_app_requires_upgrade: boolean; -``` - -### needed? - -```ts -optional needed: string; -``` - -### non\_threadable\_channels? - -```ts -optional non_threadable_channels: string[]; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### read\_only\_channels? - -```ts -optional read_only_channels: string[]; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### self? - -```ts -optional self: Self; -``` - -### subteams? - -```ts -optional subteams: Subteams; -``` - -### team? - -```ts -optional team: Team; -``` - -### thread\_only\_channels? - -```ts -optional thread_only_channels: string[]; -``` - -### url? - -```ts -optional url: string; -``` - -### users? - -```ts -optional users: User[]; -``` - -## Defined in - -[packages/web-api/src/types/response/RtmStartResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/RtmStartResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/SearchAllResponse.md b/docs/content/reference/web-api/type-aliases/SearchAllResponse.md deleted file mode 100644 index 309d99ab3..000000000 --- a/docs/content/reference/web-api/type-aliases/SearchAllResponse.md +++ /dev/null @@ -1,59 +0,0 @@ -# Type Alias: SearchAllResponse - -```ts -type SearchAllResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### files? - -```ts -optional files: Files; -``` - -### messages? - -```ts -optional messages: Messages; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### posts? - -```ts -optional posts: Posts; -``` - -### provided? - -```ts -optional provided: string; -``` - -### query? - -```ts -optional query: string; -``` - -## Defined in - -[packages/web-api/src/types/response/SearchAllResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SearchAllResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/SearchFilesResponse.md b/docs/content/reference/web-api/type-aliases/SearchFilesResponse.md deleted file mode 100644 index e6b895fb1..000000000 --- a/docs/content/reference/web-api/type-aliases/SearchFilesResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: SearchFilesResponse - -```ts -type SearchFilesResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### files? - -```ts -optional files: Files; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### query? - -```ts -optional query: string; -``` - -## Defined in - -[packages/web-api/src/types/response/SearchFilesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SearchFilesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/SearchMessagesResponse.md b/docs/content/reference/web-api/type-aliases/SearchMessagesResponse.md deleted file mode 100644 index fc42e4624..000000000 --- a/docs/content/reference/web-api/type-aliases/SearchMessagesResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: SearchMessagesResponse - -```ts -type SearchMessagesResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### messages? - -```ts -optional messages: Messages; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### query? - -```ts -optional query: string; -``` - -## Defined in - -[packages/web-api/src/types/response/SearchMessagesResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SearchMessagesResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/Select.md b/docs/content/reference/web-api/type-aliases/Select.md deleted file mode 100644 index 9fa9f82d8..000000000 --- a/docs/content/reference/web-api/type-aliases/Select.md +++ /dev/null @@ -1,27 +0,0 @@ -# Type Alias: Select - -```ts -type Select: - | UsersSelect - | StaticSelect - | ConversationsSelect - | ChannelsSelect - | ExternalSelect; -``` - -## Description - -Allows users to choose an option from a drop down menu. -The select menu also includes type-ahead functionality, where a user can type a part or all of an option string to -filter the list. There are different types of select menu elements that depend on different data sources for their -lists of options: [StaticSelect](../interfaces/StaticSelect.md), [ExternalSelect](../interfaces/ExternalSelect.md), [UsersSelect](../interfaces/UsersSelect.md), [ConversationsSelect](../interfaces/ConversationsSelect.md), -[ChannelsSelect](../interfaces/ChannelsSelect.md). - -## See - - - [Select menu element reference](https://api.slack.com/reference/block-kit/block-elements#select). - - [This is an interactive component - see our guide to enabling interactivity](https://api.slack.com/interactivity/handling). - -## Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:162 diff --git a/docs/content/reference/web-api/type-aliases/SlackFile.md b/docs/content/reference/web-api/type-aliases/SlackFile.md deleted file mode 100644 index 4fa63759e..000000000 --- a/docs/content/reference/web-api/type-aliases/SlackFile.md +++ /dev/null @@ -1,20 +0,0 @@ -# Type Alias: SlackFile - -```ts -type SlackFile: SlackFileViaUrl | SlackFileViaId; -``` - -## Description - -Defines an object containing Slack file information to be used in an image block or image element. -This file https://api.slack.com/types/file must be an image and you must provide either the URL or ID. In addition, -the user posting these blocks must have access to this file. If both are provided then the payload will be rejected. -Currently only `png`, `jpg`, `jpeg`, and `gif` Slack image files are supported. - -## See - -[Slack File object reference](https://api.slack.com/reference/block-kit/composition-objects#slack_file). - -## Defined in - -packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:209 diff --git a/docs/content/reference/web-api/type-aliases/StarsAddRemoveArguments.md b/docs/content/reference/web-api/type-aliases/StarsAddRemoveArguments.md deleted file mode 100644 index df1f859aa..000000000 --- a/docs/content/reference/web-api/type-aliases/StarsAddRemoveArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: StarsAddRemoveArguments - -```ts -type StarsAddRemoveArguments: TokenOverridable & StarsChannelDestination | MessageArgument | FileArgument | FileCommentArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/stars.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/stars.ts#L17) diff --git a/docs/content/reference/web-api/type-aliases/StarsAddResponse.md b/docs/content/reference/web-api/type-aliases/StarsAddResponse.md deleted file mode 100644 index 4a5f9a591..000000000 --- a/docs/content/reference/web-api/type-aliases/StarsAddResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: StarsAddResponse - -```ts -type StarsAddResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/StarsAddResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/StarsAddResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/StarsListResponse.md b/docs/content/reference/web-api/type-aliases/StarsListResponse.md deleted file mode 100644 index 029e8d0c2..000000000 --- a/docs/content/reference/web-api/type-aliases/StarsListResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: StarsListResponse - -```ts -type StarsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### items? - -```ts -optional items: Item[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### paging? - -```ts -optional paging: Paging; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/StarsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/StarsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/StarsRemoveResponse.md b/docs/content/reference/web-api/type-aliases/StarsRemoveResponse.md deleted file mode 100644 index 6d2e595a8..000000000 --- a/docs/content/reference/web-api/type-aliases/StarsRemoveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: StarsRemoveResponse - -```ts -type StarsRemoveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/StarsRemoveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/StarsRemoveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TLSOptions.md b/docs/content/reference/web-api/type-aliases/TLSOptions.md deleted file mode 100644 index 06e8d8a80..000000000 --- a/docs/content/reference/web-api/type-aliases/TLSOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -# Type Alias: TLSOptions - -```ts -type TLSOptions: Pick; -``` - -## Defined in - -[packages/web-api/src/WebClient.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L83) diff --git a/docs/content/reference/web-api/type-aliases/TeamAccessLogsArguments.md b/docs/content/reference/web-api/type-aliases/TeamAccessLogsArguments.md deleted file mode 100644 index 116c8674d..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamAccessLogsArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: TeamAccessLogsArguments - -```ts -type TeamAccessLogsArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/team.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L13) diff --git a/docs/content/reference/web-api/type-aliases/TeamAccessLogsResponse.md b/docs/content/reference/web-api/type-aliases/TeamAccessLogsResponse.md deleted file mode 100644 index 7e6209419..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamAccessLogsResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: TeamAccessLogsResponse - -```ts -type TeamAccessLogsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### logins? - -```ts -optional logins: Login[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### paging? - -```ts -optional paging: Paging; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/TeamAccessLogsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamAccessLogsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamBillableInfoArguments.md b/docs/content/reference/web-api/type-aliases/TeamBillableInfoArguments.md deleted file mode 100644 index 18bdf3a2e..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamBillableInfoArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: TeamBillableInfoArguments - -```ts -type TeamBillableInfoArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/team.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L22) diff --git a/docs/content/reference/web-api/type-aliases/TeamBillableInfoResponse.md b/docs/content/reference/web-api/type-aliases/TeamBillableInfoResponse.md deleted file mode 100644 index 96a88d673..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamBillableInfoResponse.md +++ /dev/null @@ -1,51 +0,0 @@ -# Type Alias: TeamBillableInfoResponse - -```ts -type TeamBillableInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### billable\_info? - -```ts -optional billable_info: object; -``` - -#### Index Signature - - \[`key`: `string`\]: `BillableInfo` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/TeamBillableInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamBillableInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamBillingInfoArguments.md b/docs/content/reference/web-api/type-aliases/TeamBillingInfoArguments.md deleted file mode 100644 index 6904e695b..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamBillingInfoArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: TeamBillingInfoArguments - -```ts -type TeamBillingInfoArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/team.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L28) diff --git a/docs/content/reference/web-api/type-aliases/TeamBillingInfoResponse.md b/docs/content/reference/web-api/type-aliases/TeamBillingInfoResponse.md deleted file mode 100644 index cffda0fbb..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamBillingInfoResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: TeamBillingInfoResponse - -```ts -type TeamBillingInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### plan? - -```ts -optional plan: string; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/TeamBillingInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamBillingInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectArguments.md b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectArguments.md deleted file mode 100644 index ff39a3994..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: TeamExternalTeamsDisconnectArguments - -```ts -type TeamExternalTeamsDisconnectArguments: TokenOverridable & Required; -``` - -## Defined in - -[packages/web-api/src/types/request/team.ts:30](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L30) diff --git a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectResponse.md b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectResponse.md deleted file mode 100644 index 7e8ec3124..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsDisconnectResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: TeamExternalTeamsDisconnectResponse - -```ts -type TeamExternalTeamsDisconnectResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/TeamExternalTeamsDisconnectResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamExternalTeamsDisconnectResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListArguments.md b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListArguments.md deleted file mode 100644 index 802747345..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: TeamExternalTeamsListArguments - -```ts -type TeamExternalTeamsListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/team.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L32) diff --git a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListResponse.md b/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListResponse.md deleted file mode 100644 index 3f414a5f3..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamExternalTeamsListResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: TeamExternalTeamsListResponse - -```ts -type TeamExternalTeamsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### organizations? - -```ts -optional organizations: Organization[]; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### total\_count? - -```ts -optional total_count: number; -``` - -## Defined in - -[packages/web-api/src/types/response/TeamExternalTeamsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamExternalTeamsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamInfoArguments.md b/docs/content/reference/web-api/type-aliases/TeamInfoArguments.md deleted file mode 100644 index 5016a0b8e..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamInfoArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: TeamInfoArguments - -```ts -type TeamInfoArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/team.ts:45](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L45) diff --git a/docs/content/reference/web-api/type-aliases/TeamInfoResponse.md b/docs/content/reference/web-api/type-aliases/TeamInfoResponse.md deleted file mode 100644 index c9ce95785..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamInfoResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: TeamInfoResponse - -```ts -type TeamInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### team? - -```ts -optional team: Team; -``` - -## Defined in - -[packages/web-api/src/types/response/TeamInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsArguments.md b/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsArguments.md deleted file mode 100644 index 7e234f4ad..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: TeamIntegrationLogsArguments - -```ts -type TeamIntegrationLogsArguments: OptionalArgument & TokenOverridable & OptionalTeamAssignable & TraditionalPagingEnabled & object>; -``` - -## Defined in - -[packages/web-api/src/types/request/team.ts:56](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L56) diff --git a/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsResponse.md b/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsResponse.md deleted file mode 100644 index 3cbacaf42..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamIntegrationLogsResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: TeamIntegrationLogsResponse - -```ts -type TeamIntegrationLogsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### logs? - -```ts -optional logs: Log[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### paging? - -```ts -optional paging: Paging; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/TeamIntegrationLogsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamIntegrationLogsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamPreferencesListArguments.md b/docs/content/reference/web-api/type-aliases/TeamPreferencesListArguments.md deleted file mode 100644 index 173cda76e..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamPreferencesListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: TeamPreferencesListArguments - -```ts -type TeamPreferencesListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/team.ts:71](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L71) diff --git a/docs/content/reference/web-api/type-aliases/TeamPreferencesListResponse.md b/docs/content/reference/web-api/type-aliases/TeamPreferencesListResponse.md deleted file mode 100644 index 2fe618a9f..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamPreferencesListResponse.md +++ /dev/null @@ -1,65 +0,0 @@ -# Type Alias: TeamPreferencesListResponse - -```ts -type TeamPreferencesListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### allow\_message\_deletion? - -```ts -optional allow_message_deletion: boolean; -``` - -### disable\_file\_uploads? - -```ts -optional disable_file_uploads: string; -``` - -### display\_real\_names? - -```ts -optional display_real_names: boolean; -``` - -### error? - -```ts -optional error: string; -``` - -### msg\_edit\_window\_mins? - -```ts -optional msg_edit_window_mins: number; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### who\_can\_post\_general? - -```ts -optional who_can_post_general: string; -``` - -## Defined in - -[packages/web-api/src/types/response/TeamPreferencesListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamPreferencesListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/TeamProfileGetArguments.md b/docs/content/reference/web-api/type-aliases/TeamProfileGetArguments.md deleted file mode 100644 index 80cee1be9..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamProfileGetArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: TeamProfileGetArguments - -```ts -type TeamProfileGetArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/team.ts:66](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L66) diff --git a/docs/content/reference/web-api/type-aliases/TeamProfileGetResponse.md b/docs/content/reference/web-api/type-aliases/TeamProfileGetResponse.md deleted file mode 100644 index 0dd55405d..000000000 --- a/docs/content/reference/web-api/type-aliases/TeamProfileGetResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: TeamProfileGetResponse - -```ts -type TeamProfileGetResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### profile? - -```ts -optional profile: Profile; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/TeamProfileGetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/TeamProfileGetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ToolingTokensRotateResponse.md b/docs/content/reference/web-api/type-aliases/ToolingTokensRotateResponse.md deleted file mode 100644 index 936601008..000000000 --- a/docs/content/reference/web-api/type-aliases/ToolingTokensRotateResponse.md +++ /dev/null @@ -1,77 +0,0 @@ -# Type Alias: ToolingTokensRotateResponse - -```ts -type ToolingTokensRotateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### exp? - -```ts -optional exp: number; -``` - -### iat? - -```ts -optional iat: number; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### refresh\_token? - -```ts -optional refresh_token: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### team\_id? - -```ts -optional team_id: string; -``` - -### token? - -```ts -optional token: string; -``` - -### user\_id? - -```ts -optional user_id: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ToolingTokensRotateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ToolingTokensRotateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsCreateResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsCreateResponse.md deleted file mode 100644 index 9ba8e02b6..000000000 --- a/docs/content/reference/web-api/type-aliases/UsergroupsCreateResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: UsergroupsCreateResponse - -```ts -type UsergroupsCreateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### usergroup? - -```ts -optional usergroup: Usergroup; -``` - -## Defined in - -[packages/web-api/src/types/response/UsergroupsCreateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsCreateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsDisableResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsDisableResponse.md deleted file mode 100644 index 827a6ef86..000000000 --- a/docs/content/reference/web-api/type-aliases/UsergroupsDisableResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: UsergroupsDisableResponse - -```ts -type UsergroupsDisableResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### usergroup? - -```ts -optional usergroup: Usergroup; -``` - -## Defined in - -[packages/web-api/src/types/response/UsergroupsDisableResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsDisableResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsEnableResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsEnableResponse.md deleted file mode 100644 index c162e829b..000000000 --- a/docs/content/reference/web-api/type-aliases/UsergroupsEnableResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: UsergroupsEnableResponse - -```ts -type UsergroupsEnableResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### usergroup? - -```ts -optional usergroup: Usergroup; -``` - -## Defined in - -[packages/web-api/src/types/response/UsergroupsEnableResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsEnableResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsListArguments.md b/docs/content/reference/web-api/type-aliases/UsergroupsListArguments.md deleted file mode 100644 index ea51d8d2e..000000000 --- a/docs/content/reference/web-api/type-aliases/UsergroupsListArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: UsergroupsListArguments - -```ts -type UsergroupsListArguments: OptionalArgument; -``` - -## Defined in - -[packages/web-api/src/types/request/usergroups.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/usergroups.ts#L31) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsListResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsListResponse.md deleted file mode 100644 index e9169e66d..000000000 --- a/docs/content/reference/web-api/type-aliases/UsergroupsListResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: UsergroupsListResponse - -```ts -type UsergroupsListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### usergroups? - -```ts -optional usergroups: Usergroup[]; -``` - -## Defined in - -[packages/web-api/src/types/response/UsergroupsListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsUpdateResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsUpdateResponse.md deleted file mode 100644 index e3129a769..000000000 --- a/docs/content/reference/web-api/type-aliases/UsergroupsUpdateResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: UsergroupsUpdateResponse - -```ts -type UsergroupsUpdateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### usergroup? - -```ts -optional usergroup: Usergroup; -``` - -## Defined in - -[packages/web-api/src/types/response/UsergroupsUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsUsersListResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsUsersListResponse.md deleted file mode 100644 index e943d8dc3..000000000 --- a/docs/content/reference/web-api/type-aliases/UsergroupsUsersListResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: UsergroupsUsersListResponse - -```ts -type UsergroupsUsersListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### users? - -```ts -optional users: string[]; -``` - -## Defined in - -[packages/web-api/src/types/response/UsergroupsUsersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsUsersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsergroupsUsersUpdateResponse.md b/docs/content/reference/web-api/type-aliases/UsergroupsUsersUpdateResponse.md deleted file mode 100644 index 6d89e191b..000000000 --- a/docs/content/reference/web-api/type-aliases/UsergroupsUsersUpdateResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: UsergroupsUsersUpdateResponse - -```ts -type UsergroupsUsersUpdateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### usergroup? - -```ts -optional usergroup: Usergroup; -``` - -## Defined in - -[packages/web-api/src/types/response/UsergroupsUsersUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsergroupsUsersUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersConversationsResponse.md b/docs/content/reference/web-api/type-aliases/UsersConversationsResponse.md deleted file mode 100644 index c4b464179..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersConversationsResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: UsersConversationsResponse - -```ts -type UsersConversationsResponse: WebAPICallResult & object; -``` - -## Type declaration - -### channels? - -```ts -optional channels: Channel[]; -``` - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersConversationsResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersConversationsResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersDeletePhotoResponse.md b/docs/content/reference/web-api/type-aliases/UsersDeletePhotoResponse.md deleted file mode 100644 index d0cab923d..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersDeletePhotoResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: UsersDeletePhotoResponse - -```ts -type UsersDeletePhotoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersDeletePhotoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersDeletePhotoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersDiscoverableContactsLookupResponse.md b/docs/content/reference/web-api/type-aliases/UsersDiscoverableContactsLookupResponse.md deleted file mode 100644 index 61351f8a3..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersDiscoverableContactsLookupResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: UsersDiscoverableContactsLookupResponse - -```ts -type UsersDiscoverableContactsLookupResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### is\_discoverable? - -```ts -optional is_discoverable: boolean; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersDiscoverableContactsLookupResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersDiscoverableContactsLookupResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersGetPresenceResponse.md b/docs/content/reference/web-api/type-aliases/UsersGetPresenceResponse.md deleted file mode 100644 index e79841a28..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersGetPresenceResponse.md +++ /dev/null @@ -1,77 +0,0 @@ -# Type Alias: UsersGetPresenceResponse - -```ts -type UsersGetPresenceResponse: WebAPICallResult & object; -``` - -## Type declaration - -### auto\_away? - -```ts -optional auto_away: boolean; -``` - -### connection\_count? - -```ts -optional connection_count: number; -``` - -### error? - -```ts -optional error: string; -``` - -### last\_activity? - -```ts -optional last_activity: number; -``` - -### manual\_away? - -```ts -optional manual_away: boolean; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### online? - -```ts -optional online: boolean; -``` - -### presence? - -```ts -optional presence: string; -``` - -### provided? - -```ts -optional provided: string; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersGetPresenceResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersGetPresenceResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersIdentityResponse.md b/docs/content/reference/web-api/type-aliases/UsersIdentityResponse.md deleted file mode 100644 index 0190fb410..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersIdentityResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: UsersIdentityResponse - -```ts -type UsersIdentityResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### team? - -```ts -optional team: Team; -``` - -### user? - -```ts -optional user: User; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersIdentityResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersIdentityResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersInfoResponse.md b/docs/content/reference/web-api/type-aliases/UsersInfoResponse.md deleted file mode 100644 index 3eeb947bc..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersInfoResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: UsersInfoResponse - -```ts -type UsersInfoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### user? - -```ts -optional user: User; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersInfoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersInfoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersListResponse.md b/docs/content/reference/web-api/type-aliases/UsersListResponse.md deleted file mode 100644 index 41b20f956..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersListResponse.md +++ /dev/null @@ -1,65 +0,0 @@ -# Type Alias: UsersListResponse - -```ts -type UsersListResponse: WebAPICallResult & object; -``` - -## Type declaration - -### arg? - -```ts -optional arg: string; -``` - -### cache\_ts? - -```ts -optional cache_ts: number; -``` - -### error? - -```ts -optional error: string; -``` - -### members? - -```ts -optional members: Member[]; -``` - -### needed? - -```ts -optional needed: string; -``` - -### offset? - -```ts -optional offset: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersListResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersListResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersLookupByEmailResponse.md b/docs/content/reference/web-api/type-aliases/UsersLookupByEmailResponse.md deleted file mode 100644 index 7e479f675..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersLookupByEmailResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: UsersLookupByEmailResponse - -```ts -type UsersLookupByEmailResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### user? - -```ts -optional user: User; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersLookupByEmailResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersLookupByEmailResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersProfileGetResponse.md b/docs/content/reference/web-api/type-aliases/UsersProfileGetResponse.md deleted file mode 100644 index 21621c850..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersProfileGetResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: UsersProfileGetResponse - -```ts -type UsersProfileGetResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### profile? - -```ts -optional profile: Profile; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersProfileGetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersProfileGetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersProfileSetResponse.md b/docs/content/reference/web-api/type-aliases/UsersProfileSetResponse.md deleted file mode 100644 index d75f43448..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersProfileSetResponse.md +++ /dev/null @@ -1,47 +0,0 @@ -# Type Alias: UsersProfileSetResponse - -```ts -type UsersProfileSetResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### profile? - -```ts -optional profile: Profile; -``` - -### provided? - -```ts -optional provided: string; -``` - -### username? - -```ts -optional username: string; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersProfileSetResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersProfileSetResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersSetActiveResponse.md b/docs/content/reference/web-api/type-aliases/UsersSetActiveResponse.md deleted file mode 100644 index eb554592b..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersSetActiveResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: UsersSetActiveResponse - -```ts -type UsersSetActiveResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersSetActiveResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersSetActiveResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersSetPhotoResponse.md b/docs/content/reference/web-api/type-aliases/UsersSetPhotoResponse.md deleted file mode 100644 index a91c37429..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersSetPhotoResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# Type Alias: UsersSetPhotoResponse - -```ts -type UsersSetPhotoResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### profile? - -```ts -optional profile: Profile; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersSetPhotoResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersSetPhotoResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/UsersSetPresenceResponse.md b/docs/content/reference/web-api/type-aliases/UsersSetPresenceResponse.md deleted file mode 100644 index 610af9661..000000000 --- a/docs/content/reference/web-api/type-aliases/UsersSetPresenceResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: UsersSetPresenceResponse - -```ts -type UsersSetPresenceResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/UsersSetPresenceResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/UsersSetPresenceResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/View.md b/docs/content/reference/web-api/type-aliases/View.md deleted file mode 100644 index c0dcc9f80..000000000 --- a/docs/content/reference/web-api/type-aliases/View.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: View - -```ts -type View: HomeView | ModalView | WorkflowStepView; -``` - -## Defined in - -packages/web-api/node\_modules/@slack/types/dist/views.d.ts:34 diff --git a/docs/content/reference/web-api/type-aliases/ViewsOpenArguments.md b/docs/content/reference/web-api/type-aliases/ViewsOpenArguments.md deleted file mode 100644 index 969de1cfa..000000000 --- a/docs/content/reference/web-api/type-aliases/ViewsOpenArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: ViewsOpenArguments - -```ts -type ViewsOpenArguments: BaseViewsArguments & TokenOverridable & ViewTriggerId | ViewInteractivityPointer; -``` - -## Defined in - -[packages/web-api/src/types/request/views.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L26) diff --git a/docs/content/reference/web-api/type-aliases/ViewsOpenResponse.md b/docs/content/reference/web-api/type-aliases/ViewsOpenResponse.md deleted file mode 100644 index 006101f74..000000000 --- a/docs/content/reference/web-api/type-aliases/ViewsOpenResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ViewsOpenResponse - -```ts -type ViewsOpenResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### view? - -```ts -optional view: View; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ViewsOpenResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ViewsOpenResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ViewsPublishResponse.md b/docs/content/reference/web-api/type-aliases/ViewsPublishResponse.md deleted file mode 100644 index 1c5860fa4..000000000 --- a/docs/content/reference/web-api/type-aliases/ViewsPublishResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ViewsPublishResponse - -```ts -type ViewsPublishResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### view? - -```ts -optional view: View; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ViewsPublishResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ViewsPublishResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ViewsPushArguments.md b/docs/content/reference/web-api/type-aliases/ViewsPushArguments.md deleted file mode 100644 index 910ee694e..000000000 --- a/docs/content/reference/web-api/type-aliases/ViewsPushArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: ViewsPushArguments - -```ts -type ViewsPushArguments: BaseViewsArguments & TokenOverridable & ViewTriggerId | ViewInteractivityPointer; -``` - -## Defined in - -[packages/web-api/src/types/request/views.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L29) diff --git a/docs/content/reference/web-api/type-aliases/ViewsPushResponse.md b/docs/content/reference/web-api/type-aliases/ViewsPushResponse.md deleted file mode 100644 index a61941d52..000000000 --- a/docs/content/reference/web-api/type-aliases/ViewsPushResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ViewsPushResponse - -```ts -type ViewsPushResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### view? - -```ts -optional view: View; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ViewsPushResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ViewsPushResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/ViewsUpdateArguments.md b/docs/content/reference/web-api/type-aliases/ViewsUpdateArguments.md deleted file mode 100644 index bc6ab96f4..000000000 --- a/docs/content/reference/web-api/type-aliases/ViewsUpdateArguments.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: ViewsUpdateArguments - -```ts -type ViewsUpdateArguments: BaseViewsArguments & TokenOverridable & ViewExternalId | ViewViewId & ViewHash; -``` - -## Defined in - -[packages/web-api/src/types/request/views.ts:60](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/views.ts#L60) diff --git a/docs/content/reference/web-api/type-aliases/ViewsUpdateResponse.md b/docs/content/reference/web-api/type-aliases/ViewsUpdateResponse.md deleted file mode 100644 index ee0b16dda..000000000 --- a/docs/content/reference/web-api/type-aliases/ViewsUpdateResponse.md +++ /dev/null @@ -1,53 +0,0 @@ -# Type Alias: ViewsUpdateResponse - -```ts -type ViewsUpdateResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -### response\_metadata? - -```ts -optional response_metadata: ResponseMetadata; -``` - -### view? - -```ts -optional view: View; -``` - -### warning? - -```ts -optional warning: string; -``` - -## Defined in - -[packages/web-api/src/types/response/ViewsUpdateResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/ViewsUpdateResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/WebAPICallError.md b/docs/content/reference/web-api/type-aliases/WebAPICallError.md deleted file mode 100644 index cf7e1bbeb..000000000 --- a/docs/content/reference/web-api/type-aliases/WebAPICallError.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: WebAPICallError - -```ts -type WebAPICallError: WebAPIPlatformError | WebAPIRequestError | WebAPIHTTPError | WebAPIRateLimitedError; -``` - -## Defined in - -[packages/web-api/src/errors.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L29) diff --git a/docs/content/reference/web-api/type-aliases/WorkflowsStepCompletedResponse.md b/docs/content/reference/web-api/type-aliases/WorkflowsStepCompletedResponse.md deleted file mode 100644 index 0cfafbb22..000000000 --- a/docs/content/reference/web-api/type-aliases/WorkflowsStepCompletedResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: WorkflowsStepCompletedResponse - -```ts -type WorkflowsStepCompletedResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/WorkflowsStepCompletedResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/WorkflowsStepCompletedResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/WorkflowsStepFailedResponse.md b/docs/content/reference/web-api/type-aliases/WorkflowsStepFailedResponse.md deleted file mode 100644 index eddde48a1..000000000 --- a/docs/content/reference/web-api/type-aliases/WorkflowsStepFailedResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: WorkflowsStepFailedResponse - -```ts -type WorkflowsStepFailedResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/WorkflowsStepFailedResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/WorkflowsStepFailedResponse.ts#L12) diff --git a/docs/content/reference/web-api/type-aliases/WorkflowsUpdateStepResponse.md b/docs/content/reference/web-api/type-aliases/WorkflowsUpdateStepResponse.md deleted file mode 100644 index 486d3c3e0..000000000 --- a/docs/content/reference/web-api/type-aliases/WorkflowsUpdateStepResponse.md +++ /dev/null @@ -1,35 +0,0 @@ -# Type Alias: WorkflowsUpdateStepResponse - -```ts -type WorkflowsUpdateStepResponse: WebAPICallResult & object; -``` - -## Type declaration - -### error? - -```ts -optional error: string; -``` - -### needed? - -```ts -optional needed: string; -``` - -### ok? - -```ts -optional ok: boolean; -``` - -### provided? - -```ts -optional provided: string; -``` - -## Defined in - -[packages/web-api/src/types/response/WorkflowsUpdateStepResponse.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/WorkflowsUpdateStepResponse.ts#L12) diff --git a/docs/content/reference/web-api/typedoc-sidebar.cjs b/docs/content/reference/web-api/typedoc-sidebar.cjs deleted file mode 100644 index 951c07f12..000000000 --- a/docs/content/reference/web-api/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/web-api/enumerations/ErrorCode","label":"ErrorCode"},{"type":"doc","id":"reference/web-api/enumerations/LogLevel","label":"LogLevel"},{"type":"doc","id":"reference/web-api/enumerations/WebClientEvent","label":"WebClientEvent"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/web-api/classes/Methods","label":"Methods"},{"type":"doc","id":"reference/web-api/classes/WebClient","label":"WebClient"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/web-api/interfaces/Action","label":"Action"},{"type":"doc","id":"reference/web-api/interfaces/Actionable","label":"Actionable"},{"type":"doc","id":"reference/web-api/interfaces/ActionsBlock","label":"ActionsBlock"},{"type":"doc","id":"reference/web-api/interfaces/AdminAnalyticsMemberDetails","label":"AdminAnalyticsMemberDetails"},{"type":"doc","id":"reference/web-api/interfaces/AdminAnalyticsPublicChannelDetails","label":"AdminAnalyticsPublicChannelDetails"},{"type":"doc","id":"reference/web-api/interfaces/AdminAnalyticsPublicChannelMetadataDetails","label":"AdminAnalyticsPublicChannelMetadataDetails"},{"type":"doc","id":"reference/web-api/interfaces/AdminAppsConfigLookupArguments","label":"AdminAppsConfigLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminAppsConfigSetArguments","label":"AdminAppsConfigSetArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminAuthPolicyAssignEntitiesArguments","label":"AdminAuthPolicyAssignEntitiesArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminAuthPolicyGetEntitiesArguments","label":"AdminAuthPolicyGetEntitiesArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminAuthPolicyRemoveEntitiesArguments","label":"AdminAuthPolicyRemoveEntitiesArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminBarriersCreateArguments","label":"AdminBarriersCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminBarriersDeleteArguments","label":"AdminBarriersDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminBarriersUpdateArguments","label":"AdminBarriersUpdateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsArchiveArguments","label":"AdminConversationsArchiveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsBulkArchiveArguments","label":"AdminConversationsBulkArchiveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsBulkDeleteArguments","label":"AdminConversationsBulkDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsBulkMoveArguments","label":"AdminConversationsBulkMoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsConvertToPrivateArguments","label":"AdminConversationsConvertToPrivateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsConvertToPublicArguments","label":"AdminConversationsConvertToPublicArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsDeleteArguments","label":"AdminConversationsDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsDisconnectSharedArguments","label":"AdminConversationsDisconnectSharedArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsGetConversationPrefsArguments","label":"AdminConversationsGetConversationPrefsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsGetCustomRetentionArguments","label":"AdminConversationsGetCustomRetentionArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsGetTeamsArguments","label":"AdminConversationsGetTeamsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsInviteArguments","label":"AdminConversationsInviteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsLookupArguments","label":"AdminConversationsLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsRemoveCustomRetentionArguments","label":"AdminConversationsRemoveCustomRetentionArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsRenameArguments","label":"AdminConversationsRenameArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsRestrictAccessAddGroupArguments","label":"AdminConversationsRestrictAccessAddGroupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsRestrictAccessListGroupsArguments","label":"AdminConversationsRestrictAccessListGroupsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsRestrictAccessRemoveGroupArguments","label":"AdminConversationsRestrictAccessRemoveGroupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsSetConversationPrefsArguments","label":"AdminConversationsSetConversationPrefsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsSetCustomRetentionArguments","label":"AdminConversationsSetCustomRetentionArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsSetTeamsArguments","label":"AdminConversationsSetTeamsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminConversationsUnarchiveArguments","label":"AdminConversationsUnarchiveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminEmojiAddAliasArguments","label":"AdminEmojiAddAliasArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminEmojiAddArguments","label":"AdminEmojiAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminEmojiRemoveArguments","label":"AdminEmojiRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminEmojiRenameArguments","label":"AdminEmojiRenameArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminFunctionsListArguments","label":"AdminFunctionsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminFunctionsPermissionsLookupArguments","label":"AdminFunctionsPermissionsLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminFunctionsPermissionsSetArguments","label":"AdminFunctionsPermissionsSetArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminInviteRequestsApproveArguments","label":"AdminInviteRequestsApproveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminInviteRequestsApprovedListArguments","label":"AdminInviteRequestsApprovedListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminInviteRequestsDeniedListArguments","label":"AdminInviteRequestsDeniedListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminInviteRequestsDenyArguments","label":"AdminInviteRequestsDenyArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminInviteRequestsListArguments","label":"AdminInviteRequestsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminRolesAddAssignmentsArguments","label":"AdminRolesAddAssignmentsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminRolesRemoveAssignmentsArguments","label":"AdminRolesRemoveAssignmentsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsAdminsListArguments","label":"AdminTeamsAdminsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsCreateArguments","label":"AdminTeamsCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsOwnersListArguments","label":"AdminTeamsOwnersListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsInfoArguments","label":"AdminTeamsSettingsInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsSetDefaultChannelsArguments","label":"AdminTeamsSettingsSetDefaultChannelsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsSetDescriptionArguments","label":"AdminTeamsSettingsSetDescriptionArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsSetDiscoverabilityArguments","label":"AdminTeamsSettingsSetDiscoverabilityArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsSetIconArguments","label":"AdminTeamsSettingsSetIconArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminTeamsSettingsSetNameArguments","label":"AdminTeamsSettingsSetNameArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsergroupsAddChannelsArguments","label":"AdminUsergroupsAddChannelsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsergroupsAddTeamsArguments","label":"AdminUsergroupsAddTeamsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsergroupsListChannelsArguments","label":"AdminUsergroupsListChannelsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsergroupsRemoveChannelsArguments","label":"AdminUsergroupsRemoveChannelsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersAssignArguments","label":"AdminUsersAssignArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersInviteArguments","label":"AdminUsersInviteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersRemoveArguments","label":"AdminUsersRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionClearSettingsArguments","label":"AdminUsersSessionClearSettingsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionGetSettingsArguments","label":"AdminUsersSessionGetSettingsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionInvalidateArguments","label":"AdminUsersSessionInvalidateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionResetArguments","label":"AdminUsersSessionResetArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionResetBulkArguments","label":"AdminUsersSessionResetBulkArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSessionSetSettingsArguments","label":"AdminUsersSessionSetSettingsArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSetAdminArguments","label":"AdminUsersSetAdminArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSetExpirationArguments","label":"AdminUsersSetExpirationArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSetOwnerArguments","label":"AdminUsersSetOwnerArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersSetRegularArguments","label":"AdminUsersSetRegularArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminUsersUnsupportedVersionsExportArguments","label":"AdminUsersUnsupportedVersionsExportArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminWorkflowsCollaboratorsAddArguments","label":"AdminWorkflowsCollaboratorsAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminWorkflowsCollaboratorsRemoveArguments","label":"AdminWorkflowsCollaboratorsRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminWorkflowsPermissionsLookupArguments","label":"AdminWorkflowsPermissionsLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/AdminWorkflowsUnpublishArguments","label":"AdminWorkflowsUnpublishArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsEventAuthorizationsListArguments","label":"AppsEventAuthorizationsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsManifestCreateArguments","label":"AppsManifestCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsManifestDeleteArguments","label":"AppsManifestDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsManifestExportArguments","label":"AppsManifestExportArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsManifestUpdateArguments","label":"AppsManifestUpdateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsManifestValidateArguments","label":"AppsManifestValidateArguments"},{"type":"doc","id":"reference/web-api/interfaces/AppsUninstallArguments","label":"AppsUninstallArguments"},{"type":"doc","id":"reference/web-api/interfaces/AttachmentAction","label":"AttachmentAction"},{"type":"doc","id":"reference/web-api/interfaces/Block","label":"Block"},{"type":"doc","id":"reference/web-api/interfaces/BookmarksAddArguments","label":"BookmarksAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/BookmarksEditArguments","label":"BookmarksEditArguments"},{"type":"doc","id":"reference/web-api/interfaces/BookmarksListArguments","label":"BookmarksListArguments"},{"type":"doc","id":"reference/web-api/interfaces/BookmarksRemoveArguments","label":"BookmarksRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/Button","label":"Button"},{"type":"doc","id":"reference/web-api/interfaces/CallUserExternal","label":"CallUserExternal"},{"type":"doc","id":"reference/web-api/interfaces/CallUserSlack","label":"CallUserSlack"},{"type":"doc","id":"reference/web-api/interfaces/CallsAddArguments","label":"CallsAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/CallsEndArguments","label":"CallsEndArguments"},{"type":"doc","id":"reference/web-api/interfaces/CallsInfoArguments","label":"CallsInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/CallsParticipantsAddArguments","label":"CallsParticipantsAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/CallsParticipantsRemoveArguments","label":"CallsParticipantsRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/CallsUpdateArguments","label":"CallsUpdateArguments"},{"type":"doc","id":"reference/web-api/interfaces/CanvasesAccessDeleteArguments","label":"CanvasesAccessDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/CanvasesAccessSetArguments","label":"CanvasesAccessSetArguments"},{"type":"doc","id":"reference/web-api/interfaces/CanvasesDeleteArguments","label":"CanvasesDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/CanvasesEditArguments","label":"CanvasesEditArguments"},{"type":"doc","id":"reference/web-api/interfaces/CanvasesSectionsLookupArguments","label":"CanvasesSectionsLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/ChannelsSelect","label":"ChannelsSelect"},{"type":"doc","id":"reference/web-api/interfaces/ChatDeleteArguments","label":"ChatDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/ChatDeleteScheduledMessageArguments","label":"ChatDeleteScheduledMessageArguments"},{"type":"doc","id":"reference/web-api/interfaces/ChatGetPermalinkArguments","label":"ChatGetPermalinkArguments"},{"type":"doc","id":"reference/web-api/interfaces/ChatMeMessageArguments","label":"ChatMeMessageArguments"},{"type":"doc","id":"reference/web-api/interfaces/Checkboxes","label":"Checkboxes"},{"type":"doc","id":"reference/web-api/interfaces/CodedError","label":"CodedError"},{"type":"doc","id":"reference/web-api/interfaces/Confirm","label":"Confirm"},{"type":"doc","id":"reference/web-api/interfaces/Confirmable","label":"Confirmable"},{"type":"doc","id":"reference/web-api/interfaces/Confirmation","label":"Confirmation"},{"type":"doc","id":"reference/web-api/interfaces/ConfirmationDialog","label":"ConfirmationDialog"},{"type":"doc","id":"reference/web-api/interfaces/ContextBlock","label":"ContextBlock"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsApproveSharedInviteArguments","label":"ConversationsApproveSharedInviteArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsArchiveArguments","label":"ConversationsArchiveArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsCanvasesCreateArguments","label":"ConversationsCanvasesCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsCloseArguments","label":"ConversationsCloseArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsCreateArguments","label":"ConversationsCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsDeclineSharedInviteArguments","label":"ConversationsDeclineSharedInviteArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsExternalInvitePermissionsSetArguments","label":"ConversationsExternalInvitePermissionsSetArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsHistoryArguments","label":"ConversationsHistoryArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsInfoArguments","label":"ConversationsInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsInviteArguments","label":"ConversationsInviteArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsJoinArguments","label":"ConversationsJoinArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsKickArguments","label":"ConversationsKickArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsLeaveArguments","label":"ConversationsLeaveArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsMarkArguments","label":"ConversationsMarkArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsMembersArguments","label":"ConversationsMembersArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsRenameArguments","label":"ConversationsRenameArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsRepliesArguments","label":"ConversationsRepliesArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsSelect","label":"ConversationsSelect"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsSetPurposeArguments","label":"ConversationsSetPurposeArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsSetTopicArguments","label":"ConversationsSetTopicArguments"},{"type":"doc","id":"reference/web-api/interfaces/ConversationsUnarchiveArguments","label":"ConversationsUnarchiveArguments"},{"type":"doc","id":"reference/web-api/interfaces/DateTimepicker","label":"DateTimepicker"},{"type":"doc","id":"reference/web-api/interfaces/Datepicker","label":"Datepicker"},{"type":"doc","id":"reference/web-api/interfaces/Dialog","label":"Dialog"},{"type":"doc","id":"reference/web-api/interfaces/DialogOpenArguments","label":"DialogOpenArguments"},{"type":"doc","id":"reference/web-api/interfaces/DispatchActionConfig","label":"DispatchActionConfig"},{"type":"doc","id":"reference/web-api/interfaces/Dispatchable","label":"Dispatchable"},{"type":"doc","id":"reference/web-api/interfaces/DividerBlock","label":"DividerBlock"},{"type":"doc","id":"reference/web-api/interfaces/DndSetSnoozeArguments","label":"DndSetSnoozeArguments"},{"type":"doc","id":"reference/web-api/interfaces/DndTeamInfoArguments","label":"DndTeamInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/EmailInput","label":"EmailInput"},{"type":"doc","id":"reference/web-api/interfaces/ExternalSelect","label":"ExternalSelect"},{"type":"doc","id":"reference/web-api/interfaces/FileBlock","label":"FileBlock"},{"type":"doc","id":"reference/web-api/interfaces/FileInput","label":"FileInput"},{"type":"doc","id":"reference/web-api/interfaces/FilesCommentsDeleteArguments","label":"FilesCommentsDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesDeleteArguments","label":"FilesDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesGetUploadURLExternalArguments","label":"FilesGetUploadURLExternalArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesInfoArguments","label":"FilesInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesListArguments","label":"FilesListArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesRemoteAddArguments","label":"FilesRemoteAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesRemoteListArguments","label":"FilesRemoteListArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesRevokePublicURLArguments","label":"FilesRevokePublicURLArguments"},{"type":"doc","id":"reference/web-api/interfaces/FilesSharedPublicURLArguments","label":"FilesSharedPublicURLArguments"},{"type":"doc","id":"reference/web-api/interfaces/Focusable","label":"Focusable"},{"type":"doc","id":"reference/web-api/interfaces/FunctionsCompleteErrorArguments","label":"FunctionsCompleteErrorArguments"},{"type":"doc","id":"reference/web-api/interfaces/FunctionsCompleteSuccessArguments","label":"FunctionsCompleteSuccessArguments"},{"type":"doc","id":"reference/web-api/interfaces/HeaderBlock","label":"HeaderBlock"},{"type":"doc","id":"reference/web-api/interfaces/HomeView","label":"HomeView"},{"type":"doc","id":"reference/web-api/interfaces/InputBlock","label":"InputBlock"},{"type":"doc","id":"reference/web-api/interfaces/LinkUnfurls","label":"LinkUnfurls"},{"type":"doc","id":"reference/web-api/interfaces/Logger","label":"Logger"},{"type":"doc","id":"reference/web-api/interfaces/MessageAttachment","label":"MessageAttachment"},{"type":"doc","id":"reference/web-api/interfaces/MessageAttachmentField","label":"MessageAttachmentField"},{"type":"doc","id":"reference/web-api/interfaces/MessageAttachmentPreview","label":"MessageAttachmentPreview"},{"type":"doc","id":"reference/web-api/interfaces/MessageMetadata","label":"MessageMetadata"},{"type":"doc","id":"reference/web-api/interfaces/MessageMetadataEventPayloadObject","label":"MessageMetadataEventPayloadObject"},{"type":"doc","id":"reference/web-api/interfaces/Method","label":"Method"},{"type":"doc","id":"reference/web-api/interfaces/MigrationExchangeArguments","label":"MigrationExchangeArguments"},{"type":"doc","id":"reference/web-api/interfaces/ModalView","label":"ModalView"},{"type":"doc","id":"reference/web-api/interfaces/MrkdwnElement","label":"MrkdwnElement"},{"type":"doc","id":"reference/web-api/interfaces/MrkdwnOption","label":"MrkdwnOption"},{"type":"doc","id":"reference/web-api/interfaces/MultiChannelsSelect","label":"MultiChannelsSelect"},{"type":"doc","id":"reference/web-api/interfaces/MultiConversationsSelect","label":"MultiConversationsSelect"},{"type":"doc","id":"reference/web-api/interfaces/MultiExternalSelect","label":"MultiExternalSelect"},{"type":"doc","id":"reference/web-api/interfaces/MultiStaticSelect","label":"MultiStaticSelect"},{"type":"doc","id":"reference/web-api/interfaces/MultiUsersSelect","label":"MultiUsersSelect"},{"type":"doc","id":"reference/web-api/interfaces/NumberInput","label":"NumberInput"},{"type":"doc","id":"reference/web-api/interfaces/OAuthAccessArguments","label":"OAuthAccessArguments"},{"type":"doc","id":"reference/web-api/interfaces/OAuthV2AccessArguments","label":"OAuthV2AccessArguments"},{"type":"doc","id":"reference/web-api/interfaces/OAuthV2ExchangeArguments","label":"OAuthV2ExchangeArguments"},{"type":"doc","id":"reference/web-api/interfaces/OpenIDConnectTokenArguments","label":"OpenIDConnectTokenArguments"},{"type":"doc","id":"reference/web-api/interfaces/OptionField","label":"OptionField"},{"type":"doc","id":"reference/web-api/interfaces/OptionGroup","label":"OptionGroup"},{"type":"doc","id":"reference/web-api/interfaces/Overflow","label":"Overflow"},{"type":"doc","id":"reference/web-api/interfaces/PageReducer","label":"PageReducer"},{"type":"doc","id":"reference/web-api/interfaces/PaginatePredicate","label":"PaginatePredicate"},{"type":"doc","id":"reference/web-api/interfaces/PinsAddArguments","label":"PinsAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/PinsListArguments","label":"PinsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/PinsRemoveArguments","label":"PinsRemoveArguments"},{"type":"doc","id":"reference/web-api/interfaces/Placeholdable","label":"Placeholdable"},{"type":"doc","id":"reference/web-api/interfaces/PlainTextElement","label":"PlainTextElement"},{"type":"doc","id":"reference/web-api/interfaces/PlainTextInput","label":"PlainTextInput"},{"type":"doc","id":"reference/web-api/interfaces/PlainTextOption","label":"PlainTextOption"},{"type":"doc","id":"reference/web-api/interfaces/RadioButtons","label":"RadioButtons"},{"type":"doc","id":"reference/web-api/interfaces/ReactionsAddArguments","label":"ReactionsAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/RemindersAddArguments","label":"RemindersAddArguments"},{"type":"doc","id":"reference/web-api/interfaces/RemindersCompleteArguments","label":"RemindersCompleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/RemindersDeleteArguments","label":"RemindersDeleteArguments"},{"type":"doc","id":"reference/web-api/interfaces/RemindersInfoArguments","label":"RemindersInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/RetryOptions","label":"RetryOptions"},{"type":"doc","id":"reference/web-api/interfaces/RichTextBlock","label":"RichTextBlock"},{"type":"doc","id":"reference/web-api/interfaces/RichTextBroadcastMention","label":"RichTextBroadcastMention"},{"type":"doc","id":"reference/web-api/interfaces/RichTextChannelMention","label":"RichTextChannelMention"},{"type":"doc","id":"reference/web-api/interfaces/RichTextColor","label":"RichTextColor"},{"type":"doc","id":"reference/web-api/interfaces/RichTextDate","label":"RichTextDate"},{"type":"doc","id":"reference/web-api/interfaces/RichTextEmoji","label":"RichTextEmoji"},{"type":"doc","id":"reference/web-api/interfaces/RichTextInput","label":"RichTextInput"},{"type":"doc","id":"reference/web-api/interfaces/RichTextLink","label":"RichTextLink"},{"type":"doc","id":"reference/web-api/interfaces/RichTextList","label":"RichTextList"},{"type":"doc","id":"reference/web-api/interfaces/RichTextPreformatted","label":"RichTextPreformatted"},{"type":"doc","id":"reference/web-api/interfaces/RichTextQuote","label":"RichTextQuote"},{"type":"doc","id":"reference/web-api/interfaces/RichTextSection","label":"RichTextSection"},{"type":"doc","id":"reference/web-api/interfaces/RichTextStyleable","label":"RichTextStyleable"},{"type":"doc","id":"reference/web-api/interfaces/RichTextTeamMention","label":"RichTextTeamMention"},{"type":"doc","id":"reference/web-api/interfaces/RichTextText","label":"RichTextText"},{"type":"doc","id":"reference/web-api/interfaces/RichTextUserMention","label":"RichTextUserMention"},{"type":"doc","id":"reference/web-api/interfaces/RichTextUsergroupMention","label":"RichTextUsergroupMention"},{"type":"doc","id":"reference/web-api/interfaces/SearchAllArguments","label":"SearchAllArguments"},{"type":"doc","id":"reference/web-api/interfaces/SearchFilesArguments","label":"SearchFilesArguments"},{"type":"doc","id":"reference/web-api/interfaces/SearchMessagesArguments","label":"SearchMessagesArguments"},{"type":"doc","id":"reference/web-api/interfaces/SectionBlock","label":"SectionBlock"},{"type":"doc","id":"reference/web-api/interfaces/SelectOption","label":"SelectOption"},{"type":"doc","id":"reference/web-api/interfaces/SlackFileImageObject","label":"SlackFileImageObject"},{"type":"doc","id":"reference/web-api/interfaces/StarsListArguments","label":"StarsListArguments"},{"type":"doc","id":"reference/web-api/interfaces/StaticSelect","label":"StaticSelect"},{"type":"doc","id":"reference/web-api/interfaces/Timepicker","label":"Timepicker"},{"type":"doc","id":"reference/web-api/interfaces/ToolingTokensRotateArguments","label":"ToolingTokensRotateArguments"},{"type":"doc","id":"reference/web-api/interfaces/URLInput","label":"URLInput"},{"type":"doc","id":"reference/web-api/interfaces/UrlImageObject","label":"UrlImageObject"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsCreateArguments","label":"UsergroupsCreateArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsDisableArguments","label":"UsergroupsDisableArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsEnableArguments","label":"UsergroupsEnableArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsUpdateArguments","label":"UsergroupsUpdateArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsUsersListArguments","label":"UsergroupsUsersListArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsergroupsUsersUpdateArguments","label":"UsergroupsUsersUpdateArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersConversationsArguments","label":"UsersConversationsArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersDeletePhotoArguments","label":"UsersDeletePhotoArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersDiscoverableContactsLookupArguments","label":"UsersDiscoverableContactsLookupArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersGetPresenceArguments","label":"UsersGetPresenceArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersIdentityArguments","label":"UsersIdentityArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersInfoArguments","label":"UsersInfoArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersListArguments","label":"UsersListArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersLookupByEmailArguments","label":"UsersLookupByEmailArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersProfileGetArguments","label":"UsersProfileGetArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersProfileSetArguments","label":"UsersProfileSetArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersSelect","label":"UsersSelect"},{"type":"doc","id":"reference/web-api/interfaces/UsersSetPhotoArguments","label":"UsersSetPhotoArguments"},{"type":"doc","id":"reference/web-api/interfaces/UsersSetPresenceArguments","label":"UsersSetPresenceArguments"},{"type":"doc","id":"reference/web-api/interfaces/VideoBlock","label":"VideoBlock"},{"type":"doc","id":"reference/web-api/interfaces/ViewsPublishArguments","label":"ViewsPublishArguments"},{"type":"doc","id":"reference/web-api/interfaces/WebAPICallResult","label":"WebAPICallResult"},{"type":"doc","id":"reference/web-api/interfaces/WebAPIHTTPError","label":"WebAPIHTTPError"},{"type":"doc","id":"reference/web-api/interfaces/WebAPIPlatformError","label":"WebAPIPlatformError"},{"type":"doc","id":"reference/web-api/interfaces/WebAPIRateLimitedError","label":"WebAPIRateLimitedError"},{"type":"doc","id":"reference/web-api/interfaces/WebAPIRequestError","label":"WebAPIRequestError"},{"type":"doc","id":"reference/web-api/interfaces/WebClientOptions","label":"WebClientOptions"},{"type":"doc","id":"reference/web-api/interfaces/WorkflowButton","label":"WorkflowButton"},{"type":"doc","id":"reference/web-api/interfaces/WorkflowStepView","label":"WorkflowStepView"},{"type":"doc","id":"reference/web-api/interfaces/WorkflowsStepCompletedArguments","label":"WorkflowsStepCompletedArguments"},{"type":"doc","id":"reference/web-api/interfaces/WorkflowsStepFailedArguments","label":"WorkflowsStepFailedArguments"},{"type":"doc","id":"reference/web-api/interfaces/WorkflowsUpdateStepArguments","label":"WorkflowsUpdateStepArguments"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/web-api/type-aliases/APITestArguments","label":"APITestArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAnalyticsGetFileArguments","label":"AdminAnalyticsGetFileArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAnalyticsGetFileResponse","label":"AdminAnalyticsGetFileResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsActivitiesListArguments","label":"AdminAppsActivitiesListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsActivitiesListResponse","label":"AdminAppsActivitiesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsApproveArguments","label":"AdminAppsApproveArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsApproveResponse","label":"AdminAppsApproveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsApprovedListArguments","label":"AdminAppsApprovedListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsApprovedListResponse","label":"AdminAppsApprovedListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsClearResolutionArguments","label":"AdminAppsClearResolutionArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsClearResolutionResponse","label":"AdminAppsClearResolutionResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsConfigLookupResponse","label":"AdminAppsConfigLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsConfigSetResponse","label":"AdminAppsConfigSetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRequestsCancelArguments","label":"AdminAppsRequestsCancelArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRequestsCancelResponse","label":"AdminAppsRequestsCancelResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRequestsListArguments","label":"AdminAppsRequestsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRequestsListResponse","label":"AdminAppsRequestsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRestrictArguments","label":"AdminAppsRestrictArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRestrictResponse","label":"AdminAppsRestrictResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRestrictedListArguments","label":"AdminAppsRestrictedListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsRestrictedListResponse","label":"AdminAppsRestrictedListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsUninstallArguments","label":"AdminAppsUninstallArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAppsUninstallResponse","label":"AdminAppsUninstallResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAuthPolicyAssignEntitiesResponse","label":"AdminAuthPolicyAssignEntitiesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAuthPolicyGetEntitiesResponse","label":"AdminAuthPolicyGetEntitiesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminAuthPolicyRemoveEntitiesResponse","label":"AdminAuthPolicyRemoveEntitiesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminBarriersCreateResponse","label":"AdminBarriersCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminBarriersDeleteResponse","label":"AdminBarriersDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminBarriersListArguments","label":"AdminBarriersListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminBarriersListResponse","label":"AdminBarriersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminBarriersUpdateResponse","label":"AdminBarriersUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsArchiveResponse","label":"AdminConversationsArchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsBulkArchiveResponse","label":"AdminConversationsBulkArchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsBulkDeleteResponse","label":"AdminConversationsBulkDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsBulkMoveResponse","label":"AdminConversationsBulkMoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsConvertToPrivateResponse","label":"AdminConversationsConvertToPrivateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsConvertToPublicResponse","label":"AdminConversationsConvertToPublicResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsCreateArguments","label":"AdminConversationsCreateArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsCreateResponse","label":"AdminConversationsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsDeleteResponse","label":"AdminConversationsDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsDisconnectSharedResponse","label":"AdminConversationsDisconnectSharedResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsEKMListOriginalConnectedChannelInfoArguments","label":"AdminConversationsEKMListOriginalConnectedChannelInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsEkmListOriginalConnectedChannelInfoResponse","label":"AdminConversationsEkmListOriginalConnectedChannelInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsGetConversationPrefsResponse","label":"AdminConversationsGetConversationPrefsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsGetCustomRetentionResponse","label":"AdminConversationsGetCustomRetentionResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsGetTeamsResponse","label":"AdminConversationsGetTeamsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsInviteResponse","label":"AdminConversationsInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsLookupResponse","label":"AdminConversationsLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsRemoveCustomRetentionResponse","label":"AdminConversationsRemoveCustomRetentionResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsRenameResponse","label":"AdminConversationsRenameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsRestrictAccessAddGroupResponse","label":"AdminConversationsRestrictAccessAddGroupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsRestrictAccessListGroupsResponse","label":"AdminConversationsRestrictAccessListGroupsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsRestrictAccessRemoveGroupResponse","label":"AdminConversationsRestrictAccessRemoveGroupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsSearchArguments","label":"AdminConversationsSearchArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsSearchResponse","label":"AdminConversationsSearchResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsSetConversationPrefsResponse","label":"AdminConversationsSetConversationPrefsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsSetCustomRetentionResponse","label":"AdminConversationsSetCustomRetentionResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsSetTeamsResponse","label":"AdminConversationsSetTeamsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsUnarchiveResponse","label":"AdminConversationsUnarchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsWhitelistAddResponse","label":"AdminConversationsWhitelistAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsWhitelistListGroupsLinkedToChannelResponse","label":"AdminConversationsWhitelistListGroupsLinkedToChannelResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminConversationsWhitelistRemoveResponse","label":"AdminConversationsWhitelistRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiAddAliasResponse","label":"AdminEmojiAddAliasResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiAddResponse","label":"AdminEmojiAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiListArguments","label":"AdminEmojiListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiListResponse","label":"AdminEmojiListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiRemoveResponse","label":"AdminEmojiRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminEmojiRenameResponse","label":"AdminEmojiRenameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminFunctionsListResponse","label":"AdminFunctionsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminFunctionsPermissionsLookupResponse","label":"AdminFunctionsPermissionsLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminFunctionsPermissionsSetResponse","label":"AdminFunctionsPermissionsSetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminInviteRequestsApproveResponse","label":"AdminInviteRequestsApproveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminInviteRequestsApprovedListResponse","label":"AdminInviteRequestsApprovedListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminInviteRequestsDeniedListResponse","label":"AdminInviteRequestsDeniedListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminInviteRequestsDenyResponse","label":"AdminInviteRequestsDenyResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminInviteRequestsListResponse","label":"AdminInviteRequestsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminRolesAddAssignmentsResponse","label":"AdminRolesAddAssignmentsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminRolesListAssignmentsArguments","label":"AdminRolesListAssignmentsArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminRolesListAssignmentsResponse","label":"AdminRolesListAssignmentsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminRolesRemoveAssignmentsResponse","label":"AdminRolesRemoveAssignmentsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsAdminsListResponse","label":"AdminTeamsAdminsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsCreateResponse","label":"AdminTeamsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsListArguments","label":"AdminTeamsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsListResponse","label":"AdminTeamsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsOwnersListResponse","label":"AdminTeamsOwnersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsInfoResponse","label":"AdminTeamsSettingsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsSetDefaultChannelsResponse","label":"AdminTeamsSettingsSetDefaultChannelsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsSetDescriptionResponse","label":"AdminTeamsSettingsSetDescriptionResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsSetDiscoverabilityResponse","label":"AdminTeamsSettingsSetDiscoverabilityResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsSetIconResponse","label":"AdminTeamsSettingsSetIconResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminTeamsSettingsSetNameResponse","label":"AdminTeamsSettingsSetNameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsergroupsAddChannelsResponse","label":"AdminUsergroupsAddChannelsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsergroupsAddTeamsResponse","label":"AdminUsergroupsAddTeamsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsergroupsListChannelsResponse","label":"AdminUsergroupsListChannelsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsergroupsRemoveChannelsResponse","label":"AdminUsergroupsRemoveChannelsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersAssignResponse","label":"AdminUsersAssignResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersInviteResponse","label":"AdminUsersInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersListArguments","label":"AdminUsersListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersListResponse","label":"AdminUsersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersRemoveResponse","label":"AdminUsersRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionClearSettingsResponse","label":"AdminUsersSessionClearSettingsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionGetSettingsResponse","label":"AdminUsersSessionGetSettingsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionInvalidateResponse","label":"AdminUsersSessionInvalidateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionListArguments","label":"AdminUsersSessionListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionListResponse","label":"AdminUsersSessionListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionResetBulkResponse","label":"AdminUsersSessionResetBulkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionResetResponse","label":"AdminUsersSessionResetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSessionSetSettingsResponse","label":"AdminUsersSessionSetSettingsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSetAdminResponse","label":"AdminUsersSetAdminResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSetExpirationResponse","label":"AdminUsersSetExpirationResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSetOwnerResponse","label":"AdminUsersSetOwnerResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersSetRegularResponse","label":"AdminUsersSetRegularResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminUsersUnsupportedVersionsExportResponse","label":"AdminUsersUnsupportedVersionsExportResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsCollaboratorsAddResponse","label":"AdminWorkflowsCollaboratorsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsCollaboratorsRemoveResponse","label":"AdminWorkflowsCollaboratorsRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsPermissionsLookupResponse","label":"AdminWorkflowsPermissionsLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsSearchArguments","label":"AdminWorkflowsSearchArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsSearchResponse","label":"AdminWorkflowsSearchResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AdminWorkflowsUnpublishResponse","label":"AdminWorkflowsUnpublishResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ApiTestResponse","label":"ApiTestResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsConnectionsOpenArguments","label":"AppsConnectionsOpenArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AppsConnectionsOpenResponse","label":"AppsConnectionsOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsEventAuthorizationsListResponse","label":"AppsEventAuthorizationsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsManifestCreateResponse","label":"AppsManifestCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsManifestDeleteResponse","label":"AppsManifestDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsManifestExportResponse","label":"AppsManifestExportResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsManifestUpdateResponse","label":"AppsManifestUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsManifestValidateResponse","label":"AppsManifestValidateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsInfoResponse","label":"AppsPermissionsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsRequestResponse","label":"AppsPermissionsRequestResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsResourcesListResponse","label":"AppsPermissionsResourcesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsScopesListResponse","label":"AppsPermissionsScopesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsUsersListResponse","label":"AppsPermissionsUsersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsPermissionsUsersRequestResponse","label":"AppsPermissionsUsersRequestResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AppsUninstallResponse","label":"AppsUninstallResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AuthRevokeArguments","label":"AuthRevokeArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AuthRevokeResponse","label":"AuthRevokeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AuthTeamsListArguments","label":"AuthTeamsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AuthTeamsListResponse","label":"AuthTeamsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/AuthTestArguments","label":"AuthTestArguments"},{"type":"doc","id":"reference/web-api/type-aliases/AuthTestResponse","label":"AuthTestResponse"},{"type":"doc","id":"reference/web-api/type-aliases/BookmarksAddResponse","label":"BookmarksAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/BookmarksEditResponse","label":"BookmarksEditResponse"},{"type":"doc","id":"reference/web-api/type-aliases/BookmarksListResponse","label":"BookmarksListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/BookmarksRemoveResponse","label":"BookmarksRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/BotsInfoArguments","label":"BotsInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/BotsInfoResponse","label":"BotsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallUser","label":"CallUser"},{"type":"doc","id":"reference/web-api/type-aliases/CallsAddResponse","label":"CallsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallsEndResponse","label":"CallsEndResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallsInfoResponse","label":"CallsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallsParticipantsAddResponse","label":"CallsParticipantsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallsParticipantsRemoveResponse","label":"CallsParticipantsRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CallsUpdateResponse","label":"CallsUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesAccessDeleteResponse","label":"CanvasesAccessDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesAccessSetResponse","label":"CanvasesAccessSetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesCreateArguments","label":"CanvasesCreateArguments"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesCreateResponse","label":"CanvasesCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesDeleteResponse","label":"CanvasesDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesEditResponse","label":"CanvasesEditResponse"},{"type":"doc","id":"reference/web-api/type-aliases/CanvasesSectionsLookupResponse","label":"CanvasesSectionsLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsArchiveResponse","label":"ChannelsArchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsCreateResponse","label":"ChannelsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsHistoryResponse","label":"ChannelsHistoryResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsInfoResponse","label":"ChannelsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsInviteResponse","label":"ChannelsInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsJoinResponse","label":"ChannelsJoinResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsKickResponse","label":"ChannelsKickResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsLeaveResponse","label":"ChannelsLeaveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsListResponse","label":"ChannelsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsMarkResponse","label":"ChannelsMarkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsRenameResponse","label":"ChannelsRenameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsRepliesResponse","label":"ChannelsRepliesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsSetPurposeResponse","label":"ChannelsSetPurposeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsSetTopicResponse","label":"ChannelsSetTopicResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChannelsUnarchiveResponse","label":"ChannelsUnarchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatDeleteResponse","label":"ChatDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatDeleteScheduledMessageResponse","label":"ChatDeleteScheduledMessageResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatGetPermalinkResponse","label":"ChatGetPermalinkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatMeMessageResponse","label":"ChatMeMessageResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatPostEphemeralArguments","label":"ChatPostEphemeralArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatPostEphemeralResponse","label":"ChatPostEphemeralResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatPostMessageArguments","label":"ChatPostMessageArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatPostMessageResponse","label":"ChatPostMessageResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatScheduleMessageArguments","label":"ChatScheduleMessageArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatScheduleMessageResponse","label":"ChatScheduleMessageResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatScheduledMessagesListArguments","label":"ChatScheduledMessagesListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatScheduledMessagesListResponse","label":"ChatScheduledMessagesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatUnfurlArguments","label":"ChatUnfurlArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatUnfurlResponse","label":"ChatUnfurlResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ChatUpdateArguments","label":"ChatUpdateArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ChatUpdateResponse","label":"ChatUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationFilter","label":"ConversationFilter"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsAcceptSharedInviteArguments","label":"ConversationsAcceptSharedInviteArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsAcceptSharedInviteResponse","label":"ConversationsAcceptSharedInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsApproveSharedInviteResponse","label":"ConversationsApproveSharedInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsArchiveResponse","label":"ConversationsArchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsCanvasesCreateResponse","label":"ConversationsCanvasesCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsCloseResponse","label":"ConversationsCloseResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsCreateResponse","label":"ConversationsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsDeclineSharedInviteResponse","label":"ConversationsDeclineSharedInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsExternalInvitePermissionsSetResponse","label":"ConversationsExternalInvitePermissionsSetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsHistoryResponse","label":"ConversationsHistoryResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsInfoResponse","label":"ConversationsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsInviteResponse","label":"ConversationsInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsInviteSharedArguments","label":"ConversationsInviteSharedArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsInviteSharedResponse","label":"ConversationsInviteSharedResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsJoinResponse","label":"ConversationsJoinResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsKickResponse","label":"ConversationsKickResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsLeaveResponse","label":"ConversationsLeaveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsListArguments","label":"ConversationsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsListConnectInvitesArguments","label":"ConversationsListConnectInvitesArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsListConnectInvitesResponse","label":"ConversationsListConnectInvitesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsListResponse","label":"ConversationsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsMarkResponse","label":"ConversationsMarkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsMembersResponse","label":"ConversationsMembersResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsOpenArguments","label":"ConversationsOpenArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsOpenResponse","label":"ConversationsOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsRenameResponse","label":"ConversationsRenameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsRepliesResponse","label":"ConversationsRepliesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsSetPurposeResponse","label":"ConversationsSetPurposeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsSetTopicResponse","label":"ConversationsSetTopicResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ConversationsUnarchiveResponse","label":"ConversationsUnarchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DialogOpenResponse","label":"DialogOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DndEndDndArguments","label":"DndEndDndArguments"},{"type":"doc","id":"reference/web-api/type-aliases/DndEndDndResponse","label":"DndEndDndResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DndEndSnoozeArguments","label":"DndEndSnoozeArguments"},{"type":"doc","id":"reference/web-api/type-aliases/DndEndSnoozeResponse","label":"DndEndSnoozeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DndInfoArguments","label":"DndInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/DndInfoResponse","label":"DndInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DndSetSnoozeResponse","label":"DndSetSnoozeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/DndTeamInfoResponse","label":"DndTeamInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/EmojiListArguments","label":"EmojiListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/EmojiListResponse","label":"EmojiListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesCommentsAddResponse","label":"FilesCommentsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesCommentsDeleteResponse","label":"FilesCommentsDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesCommentsEditResponse","label":"FilesCommentsEditResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesCompleteUploadExternalArguments","label":"FilesCompleteUploadExternalArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesCompleteUploadExternalResponse","label":"FilesCompleteUploadExternalResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesDeleteResponse","label":"FilesDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesGetUploadURLExternalResponse","label":"FilesGetUploadURLExternalResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesInfoResponse","label":"FilesInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesListResponse","label":"FilesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteAddResponse","label":"FilesRemoteAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteInfoArguments","label":"FilesRemoteInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteInfoResponse","label":"FilesRemoteInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteListResponse","label":"FilesRemoteListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteRemoveArguments","label":"FilesRemoteRemoveArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteRemoveResponse","label":"FilesRemoteRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteShareArguments","label":"FilesRemoteShareArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteShareResponse","label":"FilesRemoteShareResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteUpdateArguments","label":"FilesRemoteUpdateArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRemoteUpdateResponse","label":"FilesRemoteUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesRevokePublicURLResponse","label":"FilesRevokePublicURLResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesSharedPublicURLResponse","label":"FilesSharedPublicURLResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesUploadArguments","label":"FilesUploadArguments"},{"type":"doc","id":"reference/web-api/type-aliases/FilesUploadResponse","label":"FilesUploadResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FilesUploadV2Arguments","label":"FilesUploadV2Arguments"},{"type":"doc","id":"reference/web-api/type-aliases/FunctionsCompleteErrorResponse","label":"FunctionsCompleteErrorResponse"},{"type":"doc","id":"reference/web-api/type-aliases/FunctionsCompleteSuccessResponse","label":"FunctionsCompleteSuccessResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsArchiveResponse","label":"GroupsArchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsCloseResponse","label":"GroupsCloseResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsCreateChildResponse","label":"GroupsCreateChildResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsCreateResponse","label":"GroupsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsHistoryResponse","label":"GroupsHistoryResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsInfoResponse","label":"GroupsInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsInviteResponse","label":"GroupsInviteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsKickResponse","label":"GroupsKickResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsLeaveResponse","label":"GroupsLeaveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsListResponse","label":"GroupsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsMarkResponse","label":"GroupsMarkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsOpenResponse","label":"GroupsOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsRenameResponse","label":"GroupsRenameResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsRepliesResponse","label":"GroupsRepliesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsSetPurposeResponse","label":"GroupsSetPurposeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsSetTopicResponse","label":"GroupsSetTopicResponse"},{"type":"doc","id":"reference/web-api/type-aliases/GroupsUnarchiveResponse","label":"GroupsUnarchiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImCloseResponse","label":"ImCloseResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImHistoryResponse","label":"ImHistoryResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImListResponse","label":"ImListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImMarkResponse","label":"ImMarkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImOpenResponse","label":"ImOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImRepliesResponse","label":"ImRepliesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ImageBlock","label":"ImageBlock"},{"type":"doc","id":"reference/web-api/type-aliases/ImageElement","label":"ImageElement"},{"type":"doc","id":"reference/web-api/type-aliases/KnownBlock","label":"KnownBlock"},{"type":"doc","id":"reference/web-api/type-aliases/MigrationExchangeResponse","label":"MigrationExchangeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimCloseResponse","label":"MpimCloseResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimHistoryResponse","label":"MpimHistoryResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimListResponse","label":"MpimListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimMarkResponse","label":"MpimMarkResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimOpenResponse","label":"MpimOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MpimRepliesResponse","label":"MpimRepliesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/MultiSelect","label":"MultiSelect"},{"type":"doc","id":"reference/web-api/type-aliases/OauthAccessResponse","label":"OauthAccessResponse"},{"type":"doc","id":"reference/web-api/type-aliases/OauthTokenResponse","label":"OauthTokenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/OauthV2AccessResponse","label":"OauthV2AccessResponse"},{"type":"doc","id":"reference/web-api/type-aliases/OauthV2ExchangeResponse","label":"OauthV2ExchangeResponse"},{"type":"doc","id":"reference/web-api/type-aliases/OpenIDConnectTokenResponse","label":"OpenIDConnectTokenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/OpenIDConnectUserInfoArguments","label":"OpenIDConnectUserInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/OpenIDConnectUserInfoResponse","label":"OpenIDConnectUserInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/Option","label":"Option"},{"type":"doc","id":"reference/web-api/type-aliases/PageAccumulator","label":"PageAccumulator"},{"type":"doc","id":"reference/web-api/type-aliases/PinsAddResponse","label":"PinsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/PinsListResponse","label":"PinsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/PinsRemoveResponse","label":"PinsRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RTMConnectArguments","label":"RTMConnectArguments"},{"type":"doc","id":"reference/web-api/type-aliases/RTMStartArguments","label":"RTMStartArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsAddResponse","label":"ReactionsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsGetArguments","label":"ReactionsGetArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsGetResponse","label":"ReactionsGetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsListArguments","label":"ReactionsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsListResponse","label":"ReactionsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsRemoveArguments","label":"ReactionsRemoveArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ReactionsRemoveResponse","label":"ReactionsRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersAddResponse","label":"RemindersAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersCompleteResponse","label":"RemindersCompleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersDeleteResponse","label":"RemindersDeleteResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersInfoResponse","label":"RemindersInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersListArguments","label":"RemindersListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/RemindersListResponse","label":"RemindersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RichTextElement","label":"RichTextElement"},{"type":"doc","id":"reference/web-api/type-aliases/RtmConnectResponse","label":"RtmConnectResponse"},{"type":"doc","id":"reference/web-api/type-aliases/RtmStartResponse","label":"RtmStartResponse"},{"type":"doc","id":"reference/web-api/type-aliases/SearchAllResponse","label":"SearchAllResponse"},{"type":"doc","id":"reference/web-api/type-aliases/SearchFilesResponse","label":"SearchFilesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/SearchMessagesResponse","label":"SearchMessagesResponse"},{"type":"doc","id":"reference/web-api/type-aliases/Select","label":"Select"},{"type":"doc","id":"reference/web-api/type-aliases/SlackFile","label":"SlackFile"},{"type":"doc","id":"reference/web-api/type-aliases/StarsAddRemoveArguments","label":"StarsAddRemoveArguments"},{"type":"doc","id":"reference/web-api/type-aliases/StarsAddResponse","label":"StarsAddResponse"},{"type":"doc","id":"reference/web-api/type-aliases/StarsListResponse","label":"StarsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/StarsRemoveResponse","label":"StarsRemoveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TLSOptions","label":"TLSOptions"},{"type":"doc","id":"reference/web-api/type-aliases/TeamAccessLogsArguments","label":"TeamAccessLogsArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamAccessLogsResponse","label":"TeamAccessLogsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamBillableInfoArguments","label":"TeamBillableInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamBillableInfoResponse","label":"TeamBillableInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamBillingInfoArguments","label":"TeamBillingInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamBillingInfoResponse","label":"TeamBillingInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamExternalTeamsDisconnectArguments","label":"TeamExternalTeamsDisconnectArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamExternalTeamsDisconnectResponse","label":"TeamExternalTeamsDisconnectResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamExternalTeamsListArguments","label":"TeamExternalTeamsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamExternalTeamsListResponse","label":"TeamExternalTeamsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamInfoArguments","label":"TeamInfoArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamInfoResponse","label":"TeamInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamIntegrationLogsArguments","label":"TeamIntegrationLogsArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamIntegrationLogsResponse","label":"TeamIntegrationLogsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamPreferencesListArguments","label":"TeamPreferencesListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamPreferencesListResponse","label":"TeamPreferencesListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/TeamProfileGetArguments","label":"TeamProfileGetArguments"},{"type":"doc","id":"reference/web-api/type-aliases/TeamProfileGetResponse","label":"TeamProfileGetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ToolingTokensRotateResponse","label":"ToolingTokensRotateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsCreateResponse","label":"UsergroupsCreateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsDisableResponse","label":"UsergroupsDisableResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsEnableResponse","label":"UsergroupsEnableResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsListArguments","label":"UsergroupsListArguments"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsListResponse","label":"UsergroupsListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsUpdateResponse","label":"UsergroupsUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsUsersListResponse","label":"UsergroupsUsersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsergroupsUsersUpdateResponse","label":"UsergroupsUsersUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersConversationsResponse","label":"UsersConversationsResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersDeletePhotoResponse","label":"UsersDeletePhotoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersDiscoverableContactsLookupResponse","label":"UsersDiscoverableContactsLookupResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersGetPresenceResponse","label":"UsersGetPresenceResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersIdentityResponse","label":"UsersIdentityResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersInfoResponse","label":"UsersInfoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersListResponse","label":"UsersListResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersLookupByEmailResponse","label":"UsersLookupByEmailResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersProfileGetResponse","label":"UsersProfileGetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersProfileSetResponse","label":"UsersProfileSetResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersSetActiveResponse","label":"UsersSetActiveResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersSetPhotoResponse","label":"UsersSetPhotoResponse"},{"type":"doc","id":"reference/web-api/type-aliases/UsersSetPresenceResponse","label":"UsersSetPresenceResponse"},{"type":"doc","id":"reference/web-api/type-aliases/View","label":"View"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsOpenArguments","label":"ViewsOpenArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsOpenResponse","label":"ViewsOpenResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsPublishResponse","label":"ViewsPublishResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsPushArguments","label":"ViewsPushArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsPushResponse","label":"ViewsPushResponse"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsUpdateArguments","label":"ViewsUpdateArguments"},{"type":"doc","id":"reference/web-api/type-aliases/ViewsUpdateResponse","label":"ViewsUpdateResponse"},{"type":"doc","id":"reference/web-api/type-aliases/WebAPICallError","label":"WebAPICallError"},{"type":"doc","id":"reference/web-api/type-aliases/WorkflowsStepCompletedResponse","label":"WorkflowsStepCompletedResponse"},{"type":"doc","id":"reference/web-api/type-aliases/WorkflowsStepFailedResponse","label":"WorkflowsStepFailedResponse"},{"type":"doc","id":"reference/web-api/type-aliases/WorkflowsUpdateStepResponse","label":"WorkflowsUpdateStepResponse"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"reference/web-api/variables/retryPolicies","label":"retryPolicies"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"reference/web-api/functions/addAppMetadata","label":"addAppMetadata"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/content/reference/web-api/variables/retryPolicies.md b/docs/content/reference/web-api/variables/retryPolicies.md deleted file mode 100644 index f46e8dd23..000000000 --- a/docs/content/reference/web-api/variables/retryPolicies.md +++ /dev/null @@ -1,29 +0,0 @@ -# Variable: retryPolicies - -```ts -const retryPolicies: object; -``` - -## Type declaration - -### fiveRetriesInFiveMinutes - -```ts -fiveRetriesInFiveMinutes: RetryOptions; -``` - -### rapidRetryPolicy - -```ts -rapidRetryPolicy: RetryOptions; -``` - -### tenRetriesInAboutThirtyMinutes - -```ts -tenRetriesInAboutThirtyMinutes: RetryOptions; -``` - -## Defined in - -[packages/web-api/src/retry-policies.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/retry-policies.ts#L37) diff --git a/docs/content/reference/webhook/classes/IncomingWebhook.md b/docs/content/reference/webhook/classes/IncomingWebhook.md deleted file mode 100644 index 5a998380d..000000000 --- a/docs/content/reference/webhook/classes/IncomingWebhook.md +++ /dev/null @@ -1,49 +0,0 @@ -# Class: IncomingWebhook - -A client for Slack's Incoming Webhooks - -## Constructors - -### new IncomingWebhook() - -```ts -new IncomingWebhook(url, defaults): IncomingWebhook -``` - -#### Parameters - -• **url**: `string` - -• **defaults**: [`IncomingWebhookDefaultArguments`](../interfaces/IncomingWebhookDefaultArguments.md) = `...` - -#### Returns - -[`IncomingWebhook`](IncomingWebhook.md) - -#### Defined in - -[IncomingWebhook.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L28) - -## Methods - -### send() - -```ts -send(message): Promise -``` - -Send a notification to a conversation - -#### Parameters - -• **message**: `string` \| [`IncomingWebhookSendArguments`](../interfaces/IncomingWebhookSendArguments.md) - -the message (a simple string, or an object describing the message) - -#### Returns - -`Promise`\<[`IncomingWebhookResult`](../interfaces/IncomingWebhookResult.md)\> - -#### Defined in - -[IncomingWebhook.ts:61](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L61) diff --git a/docs/content/reference/webhook/enumerations/ErrorCode.md b/docs/content/reference/webhook/enumerations/ErrorCode.md deleted file mode 100644 index e359c655f..000000000 --- a/docs/content/reference/webhook/enumerations/ErrorCode.md +++ /dev/null @@ -1,27 +0,0 @@ -# Enumeration: ErrorCode - -A dictionary of codes for errors produced by this package - -## Enumeration Members - -### HTTPError - -```ts -HTTPError: "slack_webhook_http_error"; -``` - -#### Defined in - -[errors.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L15) - -*** - -### RequestError - -```ts -RequestError: "slack_webhook_request_error"; -``` - -#### Defined in - -[errors.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L14) diff --git a/docs/content/reference/webhook/index.md b/docs/content/reference/webhook/index.md deleted file mode 100644 index 6b1dc3b68..000000000 --- a/docs/content/reference/webhook/index.md +++ /dev/null @@ -1,22 +0,0 @@ -# @slack/webhook - -## Enumerations - -- [ErrorCode](enumerations/ErrorCode.md) - -## Classes - -- [IncomingWebhook](classes/IncomingWebhook.md) - -## Interfaces - -- [CodedError](interfaces/CodedError.md) -- [IncomingWebhookDefaultArguments](interfaces/IncomingWebhookDefaultArguments.md) -- [IncomingWebhookHTTPError](interfaces/IncomingWebhookHTTPError.md) -- [IncomingWebhookRequestError](interfaces/IncomingWebhookRequestError.md) -- [IncomingWebhookResult](interfaces/IncomingWebhookResult.md) -- [IncomingWebhookSendArguments](interfaces/IncomingWebhookSendArguments.md) - -## Type Aliases - -- [IncomingWebhookSendError](type-aliases/IncomingWebhookSendError.md) diff --git a/docs/content/reference/webhook/interfaces/CodedError.md b/docs/content/reference/webhook/interfaces/CodedError.md deleted file mode 100644 index ae9917051..000000000 --- a/docs/content/reference/webhook/interfaces/CodedError.md +++ /dev/null @@ -1,24 +0,0 @@ -# Interface: CodedError - -All errors produced by this package adhere to this interface - -## Extends - -- `ErrnoException` - -## Extended by - -- [`IncomingWebhookRequestError`](IncomingWebhookRequestError.md) -- [`IncomingWebhookHTTPError`](IncomingWebhookHTTPError.md) - -## Properties - -### code - -```ts -code: ErrorCode; -``` - -#### Defined in - -[errors.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L7) diff --git a/docs/content/reference/webhook/interfaces/IncomingWebhookDefaultArguments.md b/docs/content/reference/webhook/interfaces/IncomingWebhookDefaultArguments.md deleted file mode 100644 index 687cd79c7..000000000 --- a/docs/content/reference/webhook/interfaces/IncomingWebhookDefaultArguments.md +++ /dev/null @@ -1,101 +0,0 @@ -# Interface: IncomingWebhookDefaultArguments - -## Extended by - -- [`IncomingWebhookSendArguments`](IncomingWebhookSendArguments.md) - -## Properties - -### agent? - -```ts -optional agent: any; -``` - -#### Defined in - -[IncomingWebhook.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L109) - -*** - -### channel? - -```ts -optional channel: string; -``` - -#### Defined in - -[IncomingWebhook.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L106) - -*** - -### icon\_emoji? - -```ts -optional icon_emoji: string; -``` - -#### Defined in - -[IncomingWebhook.ts:104](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L104) - -*** - -### icon\_url? - -```ts -optional icon_url: string; -``` - -#### Defined in - -[IncomingWebhook.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L105) - -*** - -### link\_names? - -```ts -optional link_names: boolean; -``` - -#### Defined in - -[IncomingWebhook.ts:108](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L108) - -*** - -### text? - -```ts -optional text: string; -``` - -#### Defined in - -[IncomingWebhook.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L107) - -*** - -### timeout? - -```ts -optional timeout: number; -``` - -#### Defined in - -[IncomingWebhook.ts:110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L110) - -*** - -### username? - -```ts -optional username: string; -``` - -#### Defined in - -[IncomingWebhook.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L103) diff --git a/docs/content/reference/webhook/interfaces/IncomingWebhookHTTPError.md b/docs/content/reference/webhook/interfaces/IncomingWebhookHTTPError.md deleted file mode 100644 index e90145106..000000000 --- a/docs/content/reference/webhook/interfaces/IncomingWebhookHTTPError.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: IncomingWebhookHTTPError - -All errors produced by this package adhere to this interface - -## Extends - -- [`CodedError`](CodedError.md) - -## Properties - -### code - -```ts -code: HTTPError; -``` - -#### Overrides - -[`CodedError`](CodedError.md).[`code`](CodedError.md#code) - -#### Defined in - -[errors.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L26) - -*** - -### original - -```ts -original: Error; -``` - -#### Defined in - -[errors.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L27) diff --git a/docs/content/reference/webhook/interfaces/IncomingWebhookRequestError.md b/docs/content/reference/webhook/interfaces/IncomingWebhookRequestError.md deleted file mode 100644 index 781efb2f0..000000000 --- a/docs/content/reference/webhook/interfaces/IncomingWebhookRequestError.md +++ /dev/null @@ -1,35 +0,0 @@ -# Interface: IncomingWebhookRequestError - -All errors produced by this package adhere to this interface - -## Extends - -- [`CodedError`](CodedError.md) - -## Properties - -### code - -```ts -code: RequestError; -``` - -#### Overrides - -[`CodedError`](CodedError.md).[`code`](CodedError.md#code) - -#### Defined in - -[errors.ts:21](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L21) - -*** - -### original - -```ts -original: Error; -``` - -#### Defined in - -[errors.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L22) diff --git a/docs/content/reference/webhook/interfaces/IncomingWebhookResult.md b/docs/content/reference/webhook/interfaces/IncomingWebhookResult.md deleted file mode 100644 index e1ef9cf0e..000000000 --- a/docs/content/reference/webhook/interfaces/IncomingWebhookResult.md +++ /dev/null @@ -1,13 +0,0 @@ -# Interface: IncomingWebhookResult - -## Properties - -### text - -```ts -text: string; -``` - -#### Defined in - -[IncomingWebhook.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L126) diff --git a/docs/content/reference/webhook/interfaces/IncomingWebhookSendArguments.md b/docs/content/reference/webhook/interfaces/IncomingWebhookSendArguments.md deleted file mode 100644 index 2f247bc3c..000000000 --- a/docs/content/reference/webhook/interfaces/IncomingWebhookSendArguments.md +++ /dev/null @@ -1,205 +0,0 @@ -# Interface: IncomingWebhookSendArguments - -## Extends - -- [`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md) - -## Properties - -### agent? - -```ts -optional agent: any; -``` - -#### Inherited from - -[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`agent`](IncomingWebhookDefaultArguments.md#agent) - -#### Defined in - -[IncomingWebhook.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L109) - -*** - -### attachments? - -```ts -optional attachments: MessageAttachment[]; -``` - -#### Defined in - -[IncomingWebhook.ts:114](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L114) - -*** - -### blocks? - -```ts -optional blocks: any[]; -``` - -#### Defined in - -[IncomingWebhook.ts:115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L115) - -*** - -### channel? - -```ts -optional channel: string; -``` - -#### Inherited from - -[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`channel`](IncomingWebhookDefaultArguments.md#channel) - -#### Defined in - -[IncomingWebhook.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L106) - -*** - -### icon\_emoji? - -```ts -optional icon_emoji: string; -``` - -#### Inherited from - -[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`icon_emoji`](IncomingWebhookDefaultArguments.md#icon_emoji) - -#### Defined in - -[IncomingWebhook.ts:104](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L104) - -*** - -### icon\_url? - -```ts -optional icon_url: string; -``` - -#### Inherited from - -[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`icon_url`](IncomingWebhookDefaultArguments.md#icon_url) - -#### Defined in - -[IncomingWebhook.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L105) - -*** - -### link\_names? - -```ts -optional link_names: boolean; -``` - -#### Inherited from - -[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`link_names`](IncomingWebhookDefaultArguments.md#link_names) - -#### Defined in - -[IncomingWebhook.ts:108](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L108) - -*** - -### metadata? - -```ts -optional metadata: object; -``` - -#### event\_payload - -```ts -event_payload: Record; -``` - -#### event\_type - -```ts -event_type: string; -``` - -#### Defined in - -[IncomingWebhook.ts:118](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L118) - -*** - -### text? - -```ts -optional text: string; -``` - -#### Inherited from - -[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`text`](IncomingWebhookDefaultArguments.md#text) - -#### Defined in - -[IncomingWebhook.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L107) - -*** - -### timeout? - -```ts -optional timeout: number; -``` - -#### Inherited from - -[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`timeout`](IncomingWebhookDefaultArguments.md#timeout) - -#### Defined in - -[IncomingWebhook.ts:110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L110) - -*** - -### unfurl\_links? - -```ts -optional unfurl_links: boolean; -``` - -#### Defined in - -[IncomingWebhook.ts:116](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L116) - -*** - -### unfurl\_media? - -```ts -optional unfurl_media: boolean; -``` - -#### Defined in - -[IncomingWebhook.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L117) - -*** - -### username? - -```ts -optional username: string; -``` - -#### Inherited from - -[`IncomingWebhookDefaultArguments`](IncomingWebhookDefaultArguments.md).[`username`](IncomingWebhookDefaultArguments.md#username) - -#### Defined in - -[IncomingWebhook.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L103) diff --git a/docs/content/reference/webhook/type-aliases/IncomingWebhookSendError.md b/docs/content/reference/webhook/type-aliases/IncomingWebhookSendError.md deleted file mode 100644 index 54ef5daf5..000000000 --- a/docs/content/reference/webhook/type-aliases/IncomingWebhookSendError.md +++ /dev/null @@ -1,9 +0,0 @@ -# Type Alias: IncomingWebhookSendError - -```ts -type IncomingWebhookSendError: IncomingWebhookRequestError | IncomingWebhookHTTPError; -``` - -## Defined in - -[errors.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L18) diff --git a/docs/content/reference/webhook/typedoc-sidebar.cjs b/docs/content/reference/webhook/typedoc-sidebar.cjs deleted file mode 100644 index 67b03d1b3..000000000 --- a/docs/content/reference/webhook/typedoc-sidebar.cjs +++ /dev/null @@ -1,4 +0,0 @@ -// @ts-check -/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"reference/webhook/enumerations/ErrorCode","label":"ErrorCode"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"reference/webhook/classes/IncomingWebhook","label":"IncomingWebhook"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"reference/webhook/interfaces/CodedError","label":"CodedError"},{"type":"doc","id":"reference/webhook/interfaces/IncomingWebhookDefaultArguments","label":"IncomingWebhookDefaultArguments"},{"type":"doc","id":"reference/webhook/interfaces/IncomingWebhookHTTPError","label":"IncomingWebhookHTTPError"},{"type":"doc","id":"reference/webhook/interfaces/IncomingWebhookRequestError","label":"IncomingWebhookRequestError"},{"type":"doc","id":"reference/webhook/interfaces/IncomingWebhookResult","label":"IncomingWebhookResult"},{"type":"doc","id":"reference/webhook/interfaces/IncomingWebhookSendArguments","label":"IncomingWebhookSendArguments"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"reference/webhook/type-aliases/IncomingWebhookSendError","label":"IncomingWebhookSendError"}]}]}; -module.exports = typedocSidebar.items; \ No newline at end of file