From f02df534d691b6c362f6727a451cb7e39acf6773 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 12 Mar 2026 23:48:44 +0000 Subject: [PATCH 1/4] chore: release --- .changeset/chatty-tires-invite.md | 5 ----- .changeset/grumpy-jobs-poke.md | 5 ----- .changeset/plenty-times-rhyme.md | 12 ------------ .changeset/vast-drinks-raise.md | 5 ----- packages/cli-hooks/CHANGELOG.md | 6 ++++++ packages/cli-hooks/package.json | 2 +- packages/cli-test/CHANGELOG.md | 6 ++++++ packages/cli-test/package.json | 2 +- packages/logger/CHANGELOG.md | 8 ++++++++ packages/logger/package.json | 2 +- packages/oauth/CHANGELOG.md | 13 +++++++++++++ packages/oauth/package.json | 6 +++--- packages/socket-mode/CHANGELOG.md | 12 ++++++++++++ packages/socket-mode/package.json | 6 +++--- packages/types/CHANGELOG.md | 6 ++++++ packages/types/package.json | 2 +- packages/web-api/CHANGELOG.md | 14 ++++++++++++++ packages/web-api/package.json | 6 +++--- packages/webhook/CHANGELOG.md | 8 ++++++++ packages/webhook/package.json | 4 ++-- 20 files changed, 88 insertions(+), 42 deletions(-) delete mode 100644 .changeset/chatty-tires-invite.md delete mode 100644 .changeset/grumpy-jobs-poke.md delete mode 100644 .changeset/plenty-times-rhyme.md delete mode 100644 .changeset/vast-drinks-raise.md create mode 100644 packages/logger/CHANGELOG.md create mode 100644 packages/oauth/CHANGELOG.md create mode 100644 packages/socket-mode/CHANGELOG.md diff --git a/.changeset/chatty-tires-invite.md b/.changeset/chatty-tires-invite.md deleted file mode 100644 index 50439e4ba..000000000 --- a/.changeset/chatty-tires-invite.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/oauth": patch ---- - -fix: write files to the file installation store using the path.join method diff --git a/.changeset/grumpy-jobs-poke.md b/.changeset/grumpy-jobs-poke.md deleted file mode 100644 index e1add0dd0..000000000 --- a/.changeset/grumpy-jobs-poke.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/web-api": minor ---- - -feat: add support for apps.user.connection.update diff --git a/.changeset/plenty-times-rhyme.md b/.changeset/plenty-times-rhyme.md deleted file mode 100644 index f9d871adc..000000000 --- a/.changeset/plenty-times-rhyme.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -"@slack/socket-mode": patch -"@slack/cli-hooks": patch -"@slack/cli-test": patch -"@slack/web-api": patch -"@slack/webhook": patch -"@slack/logger": patch -"@slack/oauth": patch -"@slack/types": patch ---- - -build: add support for node 24 diff --git a/.changeset/vast-drinks-raise.md b/.changeset/vast-drinks-raise.md deleted file mode 100644 index 8358f0b9a..000000000 --- a/.changeset/vast-drinks-raise.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/logger": patch ---- - -build: remove @types/node from required dependencies diff --git a/packages/cli-hooks/CHANGELOG.md b/packages/cli-hooks/CHANGELOG.md index 9bd825452..837dd1baf 100644 --- a/packages/cli-hooks/CHANGELOG.md +++ b/packages/cli-hooks/CHANGELOG.md @@ -1,5 +1,11 @@ # @slack/cli-hooks +## 1.3.1 + +### Patch Changes + +- b8d922f: build: add support for node 24 + ## 1.3.0 ### Minor Changes diff --git a/packages/cli-hooks/package.json b/packages/cli-hooks/package.json index 4800cbb5b..7e8117065 100644 --- a/packages/cli-hooks/package.json +++ b/packages/cli-hooks/package.json @@ -1,6 +1,6 @@ { "name": "@slack/cli-hooks", - "version": "1.3.0", + "version": "1.3.1", "description": "Node implementation of the contract between the Slack CLI and Bolt for JavaScript", "author": "Slack Technologies, LLC", "license": "MIT", diff --git a/packages/cli-test/CHANGELOG.md b/packages/cli-test/CHANGELOG.md index 7d10243b3..0cea9535b 100644 --- a/packages/cli-test/CHANGELOG.md +++ b/packages/cli-test/CHANGELOG.md @@ -1,5 +1,11 @@ # @slack/cli-test +## 2.2.2 + +### Patch Changes + +- b8d922f: build: add support for node 24 + ## 2.2.1 ### Patch Changes diff --git a/packages/cli-test/package.json b/packages/cli-test/package.json index 5d155518c..1caaa9473 100644 --- a/packages/cli-test/package.json +++ b/packages/cli-test/package.json @@ -1,6 +1,6 @@ { "name": "@slack/cli-test", - "version": "2.2.1", + "version": "2.2.2", "description": "Node.js bindings for the Slack CLI for use in automated testing", "author": "Salesforce, Inc.", "license": "MIT", diff --git a/packages/logger/CHANGELOG.md b/packages/logger/CHANGELOG.md new file mode 100644 index 000000000..33d05a62c --- /dev/null +++ b/packages/logger/CHANGELOG.md @@ -0,0 +1,8 @@ +# @slack/logger + +## 4.0.1 + +### Patch Changes + +- b8d922f: build: add support for node 24 +- b8d922f: build: remove @types/node from required dependencies diff --git a/packages/logger/package.json b/packages/logger/package.json index 55537a023..d23e85875 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -1,6 +1,6 @@ { "name": "@slack/logger", - "version": "4.0.0", + "version": "4.0.1", "description": "Logging utility used by Node Slack SDK", "author": "Slack Technologies, LLC", "license": "MIT", diff --git a/packages/oauth/CHANGELOG.md b/packages/oauth/CHANGELOG.md new file mode 100644 index 000000000..dc56d73eb --- /dev/null +++ b/packages/oauth/CHANGELOG.md @@ -0,0 +1,13 @@ +# @slack/oauth + +## 3.0.5 + +### Patch Changes + +- dbd38e2: fix: write files to the file installation store using the path.join method +- b8d922f: build: add support for node 24 +- Updated dependencies [75649f4] +- Updated dependencies [b8d922f] +- Updated dependencies [b8d922f] + - @slack/web-api@7.15.0 + - @slack/logger@4.0.1 diff --git a/packages/oauth/package.json b/packages/oauth/package.json index ca7a5ae26..a19d0a90a 100644 --- a/packages/oauth/package.json +++ b/packages/oauth/package.json @@ -1,6 +1,6 @@ { "name": "@slack/oauth", - "version": "3.0.4", + "version": "3.0.5", "description": "Official library for interacting with Slack's Oauth endpoints", "author": "Slack Technologies, LLC", "license": "MIT", @@ -41,8 +41,8 @@ "watch": "npx nodemon --watch 'src' --ext 'ts' --exec npm run build" }, "dependencies": { - "@slack/logger": "^4", - "@slack/web-api": "^7.10.0", + "@slack/logger": "^4.0.1", + "@slack/web-api": "^7.15.0", "@types/jsonwebtoken": "^9", "@types/node": ">=18", "jsonwebtoken": "^9" diff --git a/packages/socket-mode/CHANGELOG.md b/packages/socket-mode/CHANGELOG.md new file mode 100644 index 000000000..b64f41779 --- /dev/null +++ b/packages/socket-mode/CHANGELOG.md @@ -0,0 +1,12 @@ +# @slack/socket-mode + +## 2.0.6 + +### Patch Changes + +- b8d922f: build: add support for node 24 +- Updated dependencies [75649f4] +- Updated dependencies [b8d922f] +- Updated dependencies [b8d922f] + - @slack/web-api@7.15.0 + - @slack/logger@4.0.1 diff --git a/packages/socket-mode/package.json b/packages/socket-mode/package.json index cb4d3827e..9f3f7b300 100644 --- a/packages/socket-mode/package.json +++ b/packages/socket-mode/package.json @@ -1,6 +1,6 @@ { "name": "@slack/socket-mode", - "version": "2.0.5", + "version": "2.0.6", "description": "Official library for using the Slack Platform's Socket Mode API", "author": "Slack Technologies, LLC", "license": "MIT", @@ -50,8 +50,8 @@ "watch": "npx nodemon --watch 'src' --ext 'ts' --exec npm test" }, "dependencies": { - "@slack/logger": "^4", - "@slack/web-api": "^7.10.0", + "@slack/logger": "^4.0.1", + "@slack/web-api": "^7.15.0", "@types/node": ">=18", "@types/ws": "^8", "eventemitter3": "^5", diff --git a/packages/types/CHANGELOG.md b/packages/types/CHANGELOG.md index ee2fab490..b0cc62be2 100644 --- a/packages/types/CHANGELOG.md +++ b/packages/types/CHANGELOG.md @@ -1,5 +1,11 @@ # @slack/types +## 2.20.1 + +### Patch Changes + +- b8d922f: build: add support for node 24 + ## 2.20.0 ### Minor Changes diff --git a/packages/types/package.json b/packages/types/package.json index b8ba5b5c2..9fa386fec 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@slack/types", - "version": "2.20.0", + "version": "2.20.1", "description": "Shared type definitions for the Node Slack SDK", "author": "Slack Technologies, LLC", "license": "MIT", diff --git a/packages/web-api/CHANGELOG.md b/packages/web-api/CHANGELOG.md index e51831cf5..73dbecbdf 100644 --- a/packages/web-api/CHANGELOG.md +++ b/packages/web-api/CHANGELOG.md @@ -1,5 +1,19 @@ # @slack/web-api +## 7.15.0 + +### Minor Changes + +- 75649f4: feat: add support for apps.user.connection.update + +### Patch Changes + +- b8d922f: build: add support for node 24 +- Updated dependencies [b8d922f] +- Updated dependencies [b8d922f] + - @slack/logger@4.0.1 + - @slack/types@2.20.1 + ## 7.14.1 ### Patch Changes diff --git a/packages/web-api/package.json b/packages/web-api/package.json index b66789b0c..011cf9492 100644 --- a/packages/web-api/package.json +++ b/packages/web-api/package.json @@ -1,6 +1,6 @@ { "name": "@slack/web-api", - "version": "7.14.1", + "version": "7.15.0", "description": "Official library for using the Slack Platform's Web API", "author": "Slack Technologies, LLC", "license": "MIT", @@ -49,8 +49,8 @@ "watch": "npx nodemon --watch 'src' --ext 'ts' --exec npm run build" }, "dependencies": { - "@slack/logger": "^4.0.0", - "@slack/types": "^2.20.0", + "@slack/logger": "^4.0.1", + "@slack/types": "^2.20.1", "@types/node": ">=18", "@types/retry": "0.12.0", "axios": "^1.13.5", diff --git a/packages/webhook/CHANGELOG.md b/packages/webhook/CHANGELOG.md index 2e7353bc1..7441af68c 100644 --- a/packages/webhook/CHANGELOG.md +++ b/packages/webhook/CHANGELOG.md @@ -1,5 +1,13 @@ # @slack/webhook +## 7.0.8 + +### Patch Changes + +- b8d922f: build: add support for node 24 +- Updated dependencies [b8d922f] + - @slack/types@2.20.1 + ## 7.0.7 ### Patch Changes diff --git a/packages/webhook/package.json b/packages/webhook/package.json index b2644500e..0d61c37c0 100644 --- a/packages/webhook/package.json +++ b/packages/webhook/package.json @@ -1,6 +1,6 @@ { "name": "@slack/webhook", - "version": "7.0.7", + "version": "7.0.8", "description": "Official library for using the Slack Platform's Incoming Webhooks", "author": "Slack Technologies, LLC", "license": "MIT", @@ -42,7 +42,7 @@ "test:unit": "npm run build && node --experimental-test-coverage --test-reporter=spec --test-reporter-destination=stdout --test-reporter=lcov --test-reporter-destination=lcov.info --test-reporter=junit --test-reporter-destination=test-results.xml --import tsx --test src/IncomingWebhook.test.ts" }, "dependencies": { - "@slack/types": "^2.9.0", + "@slack/types": "^2.20.1", "@types/node": ">=18", "axios": "^1.13.5" }, From 9ea7240713aa8368a0b1e783ee7a3552d5dd0b7d Mon Sep 17 00:00:00 2001 From: Eden Zimbelman Date: Thu, 12 Mar 2026 17:06:49 -0700 Subject: [PATCH 2/4] docs: remove reverted change to logger package --- packages/logger/CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/logger/CHANGELOG.md b/packages/logger/CHANGELOG.md index 33d05a62c..a6511835b 100644 --- a/packages/logger/CHANGELOG.md +++ b/packages/logger/CHANGELOG.md @@ -5,4 +5,3 @@ ### Patch Changes - b8d922f: build: add support for node 24 -- b8d922f: build: remove @types/node from required dependencies From a1af7a1a01ad4496e1f783bcf6094df6587f0542 Mon Sep 17 00:00:00 2001 From: Eden Zimbelman Date: Thu, 12 Mar 2026 17:11:35 -0700 Subject: [PATCH 3/4] chore: docs autogen --- .../cli-test/classes/SlackCLIProcess.md | 4 +- docs/english/reference/cli-test/index.md | 2 +- .../reference/cli-test/variables/SlackCLI.md | 2 +- .../cli-test/variables/SlackProduct.md | 2 +- .../cli-test/variables/SlackTracerId.md | 2 +- .../reference/cli-test/variables/shell.md | 4 +- docs/english/reference/logger/index.md | 2 +- .../oauth/classes/AuthorizationError.md | 6 +- .../oauth/classes/ClearStateStore.md | 4 +- .../oauth/classes/FileInstallationStore.md | 4 +- .../oauth/classes/GenerateInstallUrlError.md | 6 +- .../oauth/classes/InstallProvider.md | 4 +- .../classes/InstallerInitializationError.md | 6 +- .../oauth/classes/InvalidStateError.md | 6 +- .../oauth/classes/MissingCodeError.md | 6 +- .../oauth/classes/MissingStateError.md | 6 +- .../reference/oauth/classes/UnknownError.md | 6 +- .../reference/oauth/enumerations/LogLevel.md | 10 +- docs/english/reference/oauth/index.md | 2 +- .../reference/oauth/interfaces/Logger.md | 16 +- .../oauth/interfaces/OAuthV2Response.md | 6 +- .../interfaces/OAuthV2TokenRefreshResponse.md | 6 +- .../reference/rtm-api/classes/RTMClient.md | 30 +- .../rtm-api/enumerations/LogLevel.md | 10 +- .../rtm-api/interfaces/CodedError.md | 6 +- .../reference/rtm-api/interfaces/Logger.md | 16 +- .../interfaces/RTMNoReplyReceivedError.md | 6 +- .../rtm-api/interfaces/RTMPlatformError.md | 6 +- .../RTMSendWhileDisconnectedError.md | 6 +- .../interfaces/RTMSendWhileNotReadyError.md | 6 +- .../rtm-api/interfaces/RTMWebsocketError.md | 6 +- .../socket-mode/classes/SocketModeClient.md | 26 +- .../socket-mode/enumerations/LogLevel.md | 10 +- docs/english/reference/socket-mode/index.md | 2 +- .../socket-mode/interfaces/Logger.md | 16 +- docs/english/reference/types/index.md | 2 +- .../reference/web-api/classes/Methods.md | 120 +++--- .../reference/web-api/classes/WebClient.md | 118 +++--- .../web-api/enumerations/CustomFieldType.md | 125 ++++++ .../web-api/enumerations/EntityType.md | 55 +++ .../web-api/enumerations/LogLevel.md | 10 +- docs/english/reference/web-api/index.md | 39 +- .../reference/web-api/interfaces/Action.md | 6 +- .../web-api/interfaces/Actionable.md | 6 +- .../web-api/interfaces/ActionsBlock.md | 8 +- .../web-api/interfaces/AppDeletedEvent.md | 16 +- .../web-api/interfaces/AppHomeOpenedEvent.md | 14 +- .../web-api/interfaces/AppInstalledEvent.md | 18 +- .../web-api/interfaces/AppMentionEvent.md | 364 ++++++++++++++++-- .../web-api/interfaces/AppRateLimitedEvent.md | 12 +- .../web-api/interfaces/AppRequestedEvent.md | 20 +- .../web-api/interfaces/AppUninstalledEvent.md | 4 +- .../interfaces/AppUninstalledTeamEvent.md | 18 +- .../interfaces/AppsUninstallArguments.md | 2 +- .../AppsUserConnectionUpdateArguments.md | 57 +++ .../AssistantThreadContextChangedEvent.md | 8 +- .../interfaces/AssistantThreadStartedEvent.md | 8 +- .../reference/web-api/interfaces/Block.md | 9 +- .../web-api/interfaces/BotMessageEvent.md | 34 +- .../reference/web-api/interfaces/Button.md | 18 +- .../web-api/interfaces/CallRejectedEvent.md | 12 +- .../web-api/interfaces/CallUserExternal.md | 8 +- .../web-api/interfaces/CallUserSlack.md | 4 +- .../interfaces/CanvasesDeleteArguments.md | 2 +- .../interfaces/CanvasesEditArguments.md | 4 +- .../CanvasesSectionsLookupArguments.md | 4 +- .../web-api/interfaces/ChannelArchiveEvent.md | 12 +- .../interfaces/ChannelArchiveMessageEvent.md | 20 +- .../web-api/interfaces/ChannelCreatedEvent.md | 8 +- .../web-api/interfaces/ChannelDeletedEvent.md | 6 +- .../interfaces/ChannelHistoryChangedEvent.md | 10 +- .../interfaces/ChannelIDChangedEvent.md | 10 +- .../interfaces/ChannelJoinMessageEvent.md | 22 +- .../interfaces/ChannelLeaveMessageEvent.md | 20 +- .../web-api/interfaces/ChannelLeftEvent.md | 10 +- .../interfaces/ChannelNameMessageEvent.md | 24 +- .../ChannelPostingPermissionsMessageEvent.md | 18 +- .../interfaces/ChannelPurposeMessageEvent.md | 20 +- .../web-api/interfaces/ChannelRenameEvent.md | 8 +- .../web-api/interfaces/ChannelSharedEvent.md | 10 +- .../interfaces/ChannelTopicMessageEvent.md | 20 +- .../interfaces/ChannelUnarchiveEvent.md | 10 +- .../ChannelUnarchiveMessageEvent.md | 20 +- .../interfaces/ChannelUnsharedEvent.md | 12 +- .../web-api/interfaces/ChannelsSelect.md | 16 +- .../web-api/interfaces/Checkboxes.md | 14 +- .../reference/web-api/interfaces/Chunk.md | 24 ++ .../web-api/interfaces/CodedError.md | 6 +- .../reference/web-api/interfaces/Confirm.md | 12 +- .../web-api/interfaces/Confirmable.md | 4 +- .../web-api/interfaces/Confirmation.md | 10 +- .../web-api/interfaces/ConfirmationDialog.md | 12 +- .../interfaces/ContentItemEntityFields.md | 65 ++++ .../web-api/interfaces/ContextActionsBlock.md | 12 +- .../web-api/interfaces/ContextBlock.md | 8 +- .../ConversationsCanvasesCreateArguments.md | 6 +- .../web-api/interfaces/ConversationsSelect.md | 20 +- .../web-api/interfaces/DNDUpdatedEvent.md | 10 +- .../web-api/interfaces/DNDUpdatedUserEvent.md | 10 +- .../web-api/interfaces/DateTimepicker.md | 12 +- .../web-api/interfaces/Datepicker.md | 14 +- .../reference/web-api/interfaces/Dialog.md | 16 +- .../interfaces/DispatchActionConfig.md | 4 +- .../web-api/interfaces/Dispatchable.md | 4 +- .../web-api/interfaces/DividerBlock.md | 6 +- .../interfaces/EKMAccessDeniedMessageEvent.md | 18 +- .../interfaces/EmailDomainChangedEvent.md | 8 +- .../web-api/interfaces/EmailInput.md | 14 +- .../web-api/interfaces/EmojiChangedEvent.md | 18 +- .../web-api/interfaces/EntityActionButton.md | 87 +++++ .../interfaces/EntityArrayItemField.md | 203 ++++++++++ .../web-api/interfaces/EntityAttributes.md | 97 +++++ .../interfaces/EntityBooleanCheckboxField.md | 35 ++ .../interfaces/EntityBooleanTextField.md | 55 +++ .../web-api/interfaces/EntityCustomField.md | 179 +++++++++ .../web-api/interfaces/EntityEditSupport.md | 135 +++++++ .../interfaces/EntityFullSizePreview.md | 57 +++ .../web-api/interfaces/EntityIconField.md | 47 +++ .../web-api/interfaces/EntityImageField.md | 65 ++++ .../web-api/interfaces/EntityMetadata.md | 131 +++++++ .../web-api/interfaces/EntityRefField.md | 55 +++ .../web-api/interfaces/EntityStringField.md | 95 +++++ .../interfaces/EntityTimestampField.md | 45 +++ .../web-api/interfaces/EntityTypedField.md | 147 +++++++ .../web-api/interfaces/EntityUserField.md | 45 +++ .../web-api/interfaces/EntityUserIDField.md | 15 + .../web-api/interfaces/ExternalRef.md | 25 ++ .../web-api/interfaces/ExternalSelect.md | 16 +- .../web-api/interfaces/FeedbackButtons.md | 22 +- .../reference/web-api/interfaces/FileBlock.md | 10 +- .../web-api/interfaces/FileChangeEvent.md | 8 +- .../interfaces/FileCommentDeletedEvent.md | 10 +- .../web-api/interfaces/FileCreatedEvent.md | 12 +- .../web-api/interfaces/FileDeletedEvent.md | 10 +- .../web-api/interfaces/FileEntityFields.md | 85 ++++ .../web-api/interfaces/FileEntitySlackFile.md | 25 ++ .../reference/web-api/interfaces/FileInput.md | 10 +- .../web-api/interfaces/FilePublicEvent.md | 12 +- .../interfaces/FileShareMessageEvent.md | 34 +- .../web-api/interfaces/FileSharedEvent.md | 14 +- .../web-api/interfaces/FileUnsharedEvent.md | 14 +- .../reference/web-api/interfaces/Focusable.md | 4 +- .../interfaces/FunctionExecutedEvent.md | 16 +- .../web-api/interfaces/GenericMessageEvent.md | 46 +-- .../interfaces/GridMigrationFinishedEvent.md | 6 +- .../interfaces/GridMigrationStartedEvent.md | 6 +- .../web-api/interfaces/GroupArchiveEvent.md | 12 +- .../web-api/interfaces/GroupCloseEvent.md | 8 +- .../web-api/interfaces/GroupDeletedEvent.md | 12 +- .../interfaces/GroupHistoryChangedEvent.md | 10 +- .../web-api/interfaces/GroupLeftEvent.md | 10 +- .../web-api/interfaces/GroupOpenEvent.md | 8 +- .../web-api/interfaces/GroupRenameEvent.md | 8 +- .../web-api/interfaces/GroupUnarchiveEvent.md | 10 +- .../web-api/interfaces/HeaderBlock.md | 8 +- .../reference/web-api/interfaces/HomeView.md | 12 +- .../web-api/interfaces/IMCloseEvent.md | 10 +- .../web-api/interfaces/IMCreatedEvent.md | 8 +- .../interfaces/IMHistoryChangedEvent.md | 10 +- .../web-api/interfaces/IMOpenEvent.md | 10 +- .../web-api/interfaces/IconButton.md | 22 +- .../interfaces/IncidentEntityFields.md | 95 +++++ .../web-api/interfaces/InputBlock.md | 16 +- .../interfaces/InviteRequestedEvent.md | 6 +- .../web-api/interfaces/LinkSharedEvent.md | 22 +- .../web-api/interfaces/LinkUnfurls.md | 2 +- .../reference/web-api/interfaces/Logger.md | 16 +- .../web-api/interfaces/MarkdownBlock.md | 8 +- .../web-api/interfaces/MarkdownTextChunk.md | 36 ++ .../web-api/interfaces/MaxItemsSelectable.md | 4 +- .../web-api/interfaces/MeMessageEvent.md | 18 +- .../interfaces/MemberJoinedChannelEvent.md | 26 +- .../interfaces/MemberLeftChannelEvent.md | 14 +- .../web-api/interfaces/MessageAttachment.md | 52 +-- .../interfaces/MessageAttachmentField.md | 8 +- .../web-api/interfaces/MessageChangedEvent.md | 20 +- .../web-api/interfaces/MessageDeletedEvent.md | 20 +- .../web-api/interfaces/MessageMetadata.md | 8 +- .../interfaces/MessageMetadataDeletedEvent.md | 22 +- .../MessageMetadataEventPayloadObject.md | 2 +- .../interfaces/MessageMetadataPostedEvent.md | 20 +- .../interfaces/MessageMetadataUpdatedEvent.md | 22 +- .../web-api/interfaces/MessageRepliedEvent.md | 18 +- .../reference/web-api/interfaces/ModalView.md | 22 +- .../web-api/interfaces/MrkdwnElement.md | 8 +- .../web-api/interfaces/MrkdwnOption.md | 10 +- .../web-api/interfaces/MultiChannelsSelect.md | 16 +- .../interfaces/MultiConversationsSelect.md | 20 +- .../web-api/interfaces/MultiExternalSelect.md | 18 +- .../web-api/interfaces/MultiStaticSelect.md | 20 +- .../web-api/interfaces/MultiUsersSelect.md | 16 +- .../web-api/interfaces/NumberInput.md | 20 +- .../web-api/interfaces/OptionGroup.md | 6 +- .../reference/web-api/interfaces/Overflow.md | 10 +- .../web-api/interfaces/PinAddedEvent.md | 18 +- .../web-api/interfaces/PinRemovedEvent.md | 20 +- .../web-api/interfaces/Placeholdable.md | 4 +- .../web-api/interfaces/PlainTextElement.md | 8 +- .../web-api/interfaces/PlainTextInput.md | 20 +- .../web-api/interfaces/PlainTextOption.md | 10 +- .../reference/web-api/interfaces/PlanBlock.md | 85 ++++ .../web-api/interfaces/PlanUpdateChunk.md | 36 ++ .../web-api/interfaces/RadioButtons.md | 14 +- .../web-api/interfaces/RawTextElement.md | 41 ++ .../web-api/interfaces/ReactionAddedEvent.md | 14 +- .../interfaces/ReactionRemovedEvent.md | 14 +- .../web-api/interfaces/RetryOptions.md | 16 +- .../web-api/interfaces/RichTextBlock.md | 8 +- .../web-api/interfaces/RichTextBorderable.md | 4 +- .../interfaces/RichTextBroadcastMention.md | 18 +- .../interfaces/RichTextChannelMention.md | 18 +- .../web-api/interfaces/RichTextColor.md | 18 +- .../web-api/interfaces/RichTextDate.md | 24 +- .../web-api/interfaces/RichTextEmoji.md | 22 +- .../web-api/interfaces/RichTextInput.md | 14 +- .../web-api/interfaces/RichTextLink.md | 22 +- .../web-api/interfaces/RichTextList.md | 12 +- .../interfaces/RichTextPreformatted.md | 8 +- .../web-api/interfaces/RichTextQuote.md | 8 +- .../web-api/interfaces/RichTextSection.md | 6 +- .../web-api/interfaces/RichTextStyleable.md | 14 +- .../web-api/interfaces/RichTextTeamMention.md | 18 +- .../web-api/interfaces/RichTextText.md | 18 +- .../web-api/interfaces/RichTextUserMention.md | 18 +- .../interfaces/RichTextUsergroupMention.md | 18 +- .../web-api/interfaces/SectionBlock.md | 14 +- .../web-api/interfaces/SelectOption.md | 6 +- .../SharedChannelInviteAcceptedEvent.md | 16 +- .../SharedChannelInviteApprovedEvent.md | 16 +- .../SharedChannelInviteDeclinedEvent.md | 16 +- .../SharedChannelInviteReceivedEvent.md | 10 +- .../SharedChannelInviteRequestedEvent.md | 26 +- .../interfaces/SlackFileImageObject.md | 4 +- .../web-api/interfaces/StarAddedEvent.md | 10 +- .../web-api/interfaces/StarRemovedEvent.md | 10 +- .../web-api/interfaces/StaticSelect.md | 18 +- .../web-api/interfaces/SubteamCreatedEvent.md | 8 +- .../interfaces/SubteamMembersChangedEvent.md | 22 +- .../interfaces/SubteamSelfAddedEvent.md | 8 +- .../interfaces/SubteamSelfRemovedEvent.md | 8 +- .../web-api/interfaces/SubteamUpdatedEvent.md | 8 +- .../web-api/interfaces/TableBlock.md | 87 +++++ .../web-api/interfaces/TaskCardBlock.md | 141 +++++++ .../web-api/interfaces/TaskEntityFields.md | 85 ++++ .../web-api/interfaces/TaskUpdateChunk.md | 86 +++++ .../interfaces/TeamAccessGrantedEvent.md | 8 +- .../interfaces/TeamAccessRevokedEvent.md | 8 +- .../interfaces/TeamDomainChangeEvent.md | 8 +- .../web-api/interfaces/TeamJoinEvent.md | 10 +- .../web-api/interfaces/TeamRenameEvent.md | 6 +- .../interfaces/ThreadBroadcastMessageEvent.md | 28 +- .../web-api/interfaces/Timepicker.md | 16 +- .../web-api/interfaces/TokensRevokedEvent.md | 6 +- .../reference/web-api/interfaces/URLInput.md | 14 +- .../web-api/interfaces/URLRespondable.md | 4 +- .../web-api/interfaces/URLSourceElement.md | 55 +++ .../web-api/interfaces/UrlImageObject.md | 4 +- .../web-api/interfaces/UserChangeEvent.md | 10 +- .../interfaces/UserHuddleChangedEvent.md | 16 +- .../interfaces/UserProfileChangedEvent.md | 10 +- .../interfaces/UserStatusChangedEvent.md | 10 +- .../web-api/interfaces/UsersSelect.md | 14 +- .../web-api/interfaces/VideoBlock.md | 24 +- .../web-api/interfaces/WebAPIHTTPError.md | 6 +- .../web-api/interfaces/WebAPIPlatformError.md | 6 +- .../interfaces/WebAPIRateLimitedError.md | 6 +- .../web-api/interfaces/WebAPIRequestError.md | 6 +- .../web-api/interfaces/WorkflowButton.md | 14 +- .../interfaces/WorkflowDeletedEvent.md | 10 +- .../interfaces/WorkflowPublishedEvent.md | 10 +- .../interfaces/WorkflowStepDeletedEvent.md | 12 +- .../interfaces/WorkflowStepExecuteEvent.md | 10 +- .../web-api/interfaces/WorkflowStepView.md | 14 +- .../interfaces/WorkflowUnpublishedEvent.md | 10 +- .../type-aliases/ActionsBlockElement.md | 2 +- .../web-api/type-aliases/AllMessageEvents.md | 2 +- .../type-aliases/AllMessageMetadataEvents.md | 2 +- .../web-api/type-aliases/AnyBlock.md | 2 +- .../web-api/type-aliases/AnyChunk.md | 14 + .../AppsUserConnectionUpdateResponse.md | 41 ++ .../web-api/type-aliases/CallUser.md | 2 +- .../type-aliases/CanvasesCreateArguments.md | 2 +- .../web-api/type-aliases/ColorScheme.md | 2 +- .../ContextActionsBlockElement.md | 2 +- .../type-aliases/ContextBlockElement.md | 2 +- .../type-aliases/ConversationFilter.md | 2 +- .../web-api/type-aliases/ConversationType.md | 2 +- .../web-api/type-aliases/ImageBlock.md | 2 +- .../web-api/type-aliases/ImageElement.md | 2 +- .../web-api/type-aliases/InputBlockElement.md | 2 +- .../web-api/type-aliases/KnownBlock.md | 5 +- .../web-api/type-aliases/MessageEvent.md | 2 +- .../reference/web-api/type-aliases/Method.md | 2 +- .../web-api/type-aliases/MultiSelect.md | 2 +- .../reference/web-api/type-aliases/Option.md | 2 +- .../type-aliases/RichTextBlockElement.md | 2 +- .../web-api/type-aliases/RichTextElement.md | 2 +- .../type-aliases/SectionBlockAccessory.md | 2 +- .../reference/web-api/type-aliases/Select.md | 2 +- .../SharedChannelInviteAccepted.md | 2 +- .../SharedChannelInviteApproved.md | 2 +- .../SharedChannelInviteDeclined.md | 2 +- .../SharedChannelInviteReceived.md | 2 +- .../web-api/type-aliases/SlackEvent.md | 3 +- .../web-api/type-aliases/SlackFile.md | 2 +- .../web-api/type-aliases/SubteamCreated.md | 2 +- .../type-aliases/SubteamMembersChanged.md | 2 +- .../web-api/type-aliases/TextObject.md | 2 +- .../reference/web-api/type-aliases/View.md | 2 +- .../webhook/classes/IncomingWebhook.md | 4 +- docs/english/reference/webhook/index.md | 2 +- .../webhook/interfaces/CodedError.md | 6 +- .../interfaces/IncomingWebhookHTTPError.md | 6 +- .../interfaces/IncomingWebhookRequestError.md | 6 +- 314 files changed, 4815 insertions(+), 1499 deletions(-) create mode 100644 docs/english/reference/web-api/enumerations/CustomFieldType.md create mode 100644 docs/english/reference/web-api/enumerations/EntityType.md create mode 100644 docs/english/reference/web-api/interfaces/AppsUserConnectionUpdateArguments.md create mode 100644 docs/english/reference/web-api/interfaces/Chunk.md create mode 100644 docs/english/reference/web-api/interfaces/ContentItemEntityFields.md create mode 100644 docs/english/reference/web-api/interfaces/EntityActionButton.md create mode 100644 docs/english/reference/web-api/interfaces/EntityArrayItemField.md create mode 100644 docs/english/reference/web-api/interfaces/EntityAttributes.md create mode 100644 docs/english/reference/web-api/interfaces/EntityBooleanCheckboxField.md create mode 100644 docs/english/reference/web-api/interfaces/EntityBooleanTextField.md create mode 100644 docs/english/reference/web-api/interfaces/EntityCustomField.md create mode 100644 docs/english/reference/web-api/interfaces/EntityEditSupport.md create mode 100644 docs/english/reference/web-api/interfaces/EntityFullSizePreview.md create mode 100644 docs/english/reference/web-api/interfaces/EntityIconField.md create mode 100644 docs/english/reference/web-api/interfaces/EntityImageField.md create mode 100644 docs/english/reference/web-api/interfaces/EntityMetadata.md create mode 100644 docs/english/reference/web-api/interfaces/EntityRefField.md create mode 100644 docs/english/reference/web-api/interfaces/EntityStringField.md create mode 100644 docs/english/reference/web-api/interfaces/EntityTimestampField.md create mode 100644 docs/english/reference/web-api/interfaces/EntityTypedField.md create mode 100644 docs/english/reference/web-api/interfaces/EntityUserField.md create mode 100644 docs/english/reference/web-api/interfaces/EntityUserIDField.md create mode 100644 docs/english/reference/web-api/interfaces/ExternalRef.md create mode 100644 docs/english/reference/web-api/interfaces/FileEntityFields.md create mode 100644 docs/english/reference/web-api/interfaces/FileEntitySlackFile.md create mode 100644 docs/english/reference/web-api/interfaces/IncidentEntityFields.md create mode 100644 docs/english/reference/web-api/interfaces/MarkdownTextChunk.md create mode 100644 docs/english/reference/web-api/interfaces/PlanBlock.md create mode 100644 docs/english/reference/web-api/interfaces/PlanUpdateChunk.md create mode 100644 docs/english/reference/web-api/interfaces/RawTextElement.md create mode 100644 docs/english/reference/web-api/interfaces/TableBlock.md create mode 100644 docs/english/reference/web-api/interfaces/TaskCardBlock.md create mode 100644 docs/english/reference/web-api/interfaces/TaskEntityFields.md create mode 100644 docs/english/reference/web-api/interfaces/TaskUpdateChunk.md create mode 100644 docs/english/reference/web-api/interfaces/URLSourceElement.md create mode 100644 docs/english/reference/web-api/type-aliases/AnyChunk.md create mode 100644 docs/english/reference/web-api/type-aliases/AppsUserConnectionUpdateResponse.md diff --git a/docs/english/reference/cli-test/classes/SlackCLIProcess.md b/docs/english/reference/cli-test/classes/SlackCLIProcess.md index 40b689fbb..efdf55a97 100644 --- a/docs/english/reference/cli-test/classes/SlackCLIProcess.md +++ b/docs/english/reference/cli-test/classes/SlackCLIProcess.md @@ -54,7 +54,7 @@ The CLI command to invoke ### commandOptions ```ts -commandOptions: undefined | SlackCLICommandOptions; +commandOptions: SlackCLICommandOptions | undefined; ``` Defined in: [cli/cli-process.ts:63](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L63) @@ -68,7 +68,7 @@ The CLI command-specific options to pass to the command ### globalOptions ```ts -globalOptions: undefined | SlackCLIGlobalOptions; +globalOptions: SlackCLIGlobalOptions | undefined; ``` Defined in: [cli/cli-process.ts:58](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L58) diff --git a/docs/english/reference/cli-test/index.md b/docs/english/reference/cli-test/index.md index 738886cc4..9c0ef5369 100644 --- a/docs/english/reference/cli-test/index.md +++ b/docs/english/reference/cli-test/index.md @@ -1,4 +1,4 @@ -# @slack/cli-test v2.2.0+cli.2.32.2 +# @slack/cli-test v2.2.2 ## Classes diff --git a/docs/english/reference/cli-test/variables/SlackCLI.md b/docs/english/reference/cli-test/variables/SlackCLI.md index 9f25aa9ec..3eeed5b77 100644 --- a/docs/english/reference/cli-test/variables/SlackCLI.md +++ b/docs/english/reference/cli-test/variables/SlackCLI.md @@ -10,7 +10,7 @@ Defined in: [cli/index.ts:22](https://github.com/slackapi/node-slack-sdk/blob/ma Set of functions to spawn and interact with Slack Platform CLI processes and commands -## Type declaration +## Type Declaration ### app diff --git a/docs/english/reference/cli-test/variables/SlackProduct.md b/docs/english/reference/cli-test/variables/SlackProduct.md index f721f73c7..37de7565d 100644 --- a/docs/english/reference/cli-test/variables/SlackProduct.md +++ b/docs/english/reference/cli-test/variables/SlackProduct.md @@ -8,7 +8,7 @@ const SlackProduct: object; Defined in: [utils/constants.ts:52](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/utils/constants.ts#L52) -## Type declaration +## Type Declaration ### BUSINESS\_PLUS diff --git a/docs/english/reference/cli-test/variables/SlackTracerId.md b/docs/english/reference/cli-test/variables/SlackTracerId.md index 723acbca7..f5eef452d 100644 --- a/docs/english/reference/cli-test/variables/SlackTracerId.md +++ b/docs/english/reference/cli-test/variables/SlackTracerId.md @@ -10,7 +10,7 @@ Defined in: [utils/constants.ts:5](https://github.com/slackapi/node-slack-sdk/bl This file should be kept up to date with the source of truth in the Slack CLI repo -## Type declaration +## Type Declaration ### SLACK\_TRACE\_ADMIN\_APPROVAL\_REQUEST\_PENDING diff --git a/docs/english/reference/cli-test/variables/shell.md b/docs/english/reference/cli-test/variables/shell.md index 065c015e3..3309cb71d 100644 --- a/docs/english/reference/cli-test/variables/shell.md +++ b/docs/english/reference/cli-test/variables/shell.md @@ -8,7 +8,7 @@ const shell: object; Defined in: [cli/shell.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/shell.ts#L9) -## Type declaration +## Type Declaration ### assembleShellEnv() @@ -122,7 +122,7 @@ Sleep function used to wait for cli to finish executing #### Parameters -##### timeout +##### timeout? `number` = `1000` diff --git a/docs/english/reference/logger/index.md b/docs/english/reference/logger/index.md index 621f91e54..774c6b107 100644 --- a/docs/english/reference/logger/index.md +++ b/docs/english/reference/logger/index.md @@ -1,4 +1,4 @@ -# @slack/logger v4.0.0 +# @slack/logger v4.0.1 ## Enumerations diff --git a/docs/english/reference/oauth/classes/AuthorizationError.md b/docs/english/reference/oauth/classes/AuthorizationError.md index dc4c22f93..cddb8d4ae 100644 --- a/docs/english/reference/oauth/classes/AuthorizationError.md +++ b/docs/english/reference/oauth/classes/AuthorizationError.md @@ -134,7 +134,7 @@ Error.stack static stackTraceLimit: number; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162 +Defined in: node\_modules/@types/node/globals.d.ts:68 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or @@ -160,7 +160,7 @@ Error.stackTraceLimit static captureStackTrace(targetObject, constructorOpt?): void; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146 +Defined in: node\_modules/@types/node/globals.d.ts:52 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which @@ -234,7 +234,7 @@ Error.captureStackTrace static prepareStackTrace(err, stackTraces): any; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150 +Defined in: node\_modules/@types/node/globals.d.ts:56 #### Parameters diff --git a/docs/english/reference/oauth/classes/ClearStateStore.md b/docs/english/reference/oauth/classes/ClearStateStore.md index cccbd63dc..0e4fe1b86 100644 --- a/docs/english/reference/oauth/classes/ClearStateStore.md +++ b/docs/english/reference/oauth/classes/ClearStateStore.md @@ -18,7 +18,7 @@ it can transfer the given InstallURLOptions value to the Redirect URL handler ### Constructor ```ts -new ClearStateStore(stateSecret, stateExpirationSeconds): ClearStateStore; +new ClearStateStore(stateSecret, stateExpirationSeconds?): ClearStateStore; ``` 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) @@ -29,7 +29,7 @@ Defined in: [packages/oauth/src/state-stores/clear-state-store.ts:13](https://gi `string` -##### stateExpirationSeconds +##### stateExpirationSeconds? `number` = `600` diff --git a/docs/english/reference/oauth/classes/FileInstallationStore.md b/docs/english/reference/oauth/classes/FileInstallationStore.md index 6b7ce6bf5..24990ca23 100644 --- a/docs/english/reference/oauth/classes/FileInstallationStore.md +++ b/docs/english/reference/oauth/classes/FileInstallationStore.md @@ -13,14 +13,14 @@ Defined in: [packages/oauth/src/installation-stores/file-store.ts:14](https://gi ### Constructor ```ts -new FileInstallationStore(__namedParameters): FileInstallationStore; +new FileInstallationStore(__namedParameters?): FileInstallationStore; ``` 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) #### Parameters -##### \_\_namedParameters +##### \_\_namedParameters? `FileInstallationOptions` = `{}` diff --git a/docs/english/reference/oauth/classes/GenerateInstallUrlError.md b/docs/english/reference/oauth/classes/GenerateInstallUrlError.md index 49be13e8f..84ac24a30 100644 --- a/docs/english/reference/oauth/classes/GenerateInstallUrlError.md +++ b/docs/english/reference/oauth/classes/GenerateInstallUrlError.md @@ -120,7 +120,7 @@ Error.stack static stackTraceLimit: number; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162 +Defined in: node\_modules/@types/node/globals.d.ts:68 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or @@ -146,7 +146,7 @@ Error.stackTraceLimit static captureStackTrace(targetObject, constructorOpt?): void; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146 +Defined in: node\_modules/@types/node/globals.d.ts:52 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which @@ -220,7 +220,7 @@ Error.captureStackTrace static prepareStackTrace(err, stackTraces): any; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150 +Defined in: node\_modules/@types/node/globals.d.ts:56 #### Parameters diff --git a/docs/english/reference/oauth/classes/InstallProvider.md b/docs/english/reference/oauth/classes/InstallProvider.md index ad8caa5e9..1013c0e56 100644 --- a/docs/english/reference/oauth/classes/InstallProvider.md +++ b/docs/english/reference/oauth/classes/InstallProvider.md @@ -75,7 +75,7 @@ Fetches data from the installationStore ```ts generateInstallUrl( options, - stateVerification, + stateVerification?, state?): Promise; ``` @@ -90,7 +90,7 @@ Uses stateStore to generate a value for the state query param. [`InstallURLOptions`](../interfaces/InstallURLOptions.md) -##### stateVerification +##### stateVerification? `boolean` = `true` diff --git a/docs/english/reference/oauth/classes/InstallerInitializationError.md b/docs/english/reference/oauth/classes/InstallerInitializationError.md index 52b5322a6..f04486324 100644 --- a/docs/english/reference/oauth/classes/InstallerInitializationError.md +++ b/docs/english/reference/oauth/classes/InstallerInitializationError.md @@ -120,7 +120,7 @@ Error.stack static stackTraceLimit: number; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162 +Defined in: node\_modules/@types/node/globals.d.ts:68 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or @@ -146,7 +146,7 @@ Error.stackTraceLimit static captureStackTrace(targetObject, constructorOpt?): void; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146 +Defined in: node\_modules/@types/node/globals.d.ts:52 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which @@ -220,7 +220,7 @@ Error.captureStackTrace static prepareStackTrace(err, stackTraces): any; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150 +Defined in: node\_modules/@types/node/globals.d.ts:56 #### Parameters diff --git a/docs/english/reference/oauth/classes/InvalidStateError.md b/docs/english/reference/oauth/classes/InvalidStateError.md index 21d9ee52d..9e1986014 100644 --- a/docs/english/reference/oauth/classes/InvalidStateError.md +++ b/docs/english/reference/oauth/classes/InvalidStateError.md @@ -120,7 +120,7 @@ Error.stack static stackTraceLimit: number; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162 +Defined in: node\_modules/@types/node/globals.d.ts:68 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or @@ -146,7 +146,7 @@ Error.stackTraceLimit static captureStackTrace(targetObject, constructorOpt?): void; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146 +Defined in: node\_modules/@types/node/globals.d.ts:52 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which @@ -220,7 +220,7 @@ Error.captureStackTrace static prepareStackTrace(err, stackTraces): any; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150 +Defined in: node\_modules/@types/node/globals.d.ts:56 #### Parameters diff --git a/docs/english/reference/oauth/classes/MissingCodeError.md b/docs/english/reference/oauth/classes/MissingCodeError.md index fd5d71de6..e0bb7a657 100644 --- a/docs/english/reference/oauth/classes/MissingCodeError.md +++ b/docs/english/reference/oauth/classes/MissingCodeError.md @@ -120,7 +120,7 @@ Error.stack static stackTraceLimit: number; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162 +Defined in: node\_modules/@types/node/globals.d.ts:68 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or @@ -146,7 +146,7 @@ Error.stackTraceLimit static captureStackTrace(targetObject, constructorOpt?): void; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146 +Defined in: node\_modules/@types/node/globals.d.ts:52 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which @@ -220,7 +220,7 @@ Error.captureStackTrace static prepareStackTrace(err, stackTraces): any; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150 +Defined in: node\_modules/@types/node/globals.d.ts:56 #### Parameters diff --git a/docs/english/reference/oauth/classes/MissingStateError.md b/docs/english/reference/oauth/classes/MissingStateError.md index 80aa22f25..2e2ed028f 100644 --- a/docs/english/reference/oauth/classes/MissingStateError.md +++ b/docs/english/reference/oauth/classes/MissingStateError.md @@ -120,7 +120,7 @@ Error.stack static stackTraceLimit: number; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162 +Defined in: node\_modules/@types/node/globals.d.ts:68 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or @@ -146,7 +146,7 @@ Error.stackTraceLimit static captureStackTrace(targetObject, constructorOpt?): void; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146 +Defined in: node\_modules/@types/node/globals.d.ts:52 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which @@ -220,7 +220,7 @@ Error.captureStackTrace static prepareStackTrace(err, stackTraces): any; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150 +Defined in: node\_modules/@types/node/globals.d.ts:56 #### Parameters diff --git a/docs/english/reference/oauth/classes/UnknownError.md b/docs/english/reference/oauth/classes/UnknownError.md index a22c31cef..bf9bb8162 100644 --- a/docs/english/reference/oauth/classes/UnknownError.md +++ b/docs/english/reference/oauth/classes/UnknownError.md @@ -120,7 +120,7 @@ Error.stack static stackTraceLimit: number; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:162 +Defined in: node\_modules/@types/node/globals.d.ts:68 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or @@ -146,7 +146,7 @@ Error.stackTraceLimit static captureStackTrace(targetObject, constructorOpt?): void; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:146 +Defined in: node\_modules/@types/node/globals.d.ts:52 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which @@ -220,7 +220,7 @@ Error.captureStackTrace static prepareStackTrace(err, stackTraces): any; ``` -Defined in: packages/oauth/node\_modules/@types/node/globals.d.ts:150 +Defined in: node\_modules/@types/node/globals.d.ts:56 #### Parameters diff --git a/docs/english/reference/oauth/enumerations/LogLevel.md b/docs/english/reference/oauth/enumerations/LogLevel.md index 9934bff11..35844a875 100644 --- a/docs/english/reference/oauth/enumerations/LogLevel.md +++ b/docs/english/reference/oauth/enumerations/LogLevel.md @@ -2,7 +2,7 @@ # Enumeration: LogLevel -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:4 +Defined in: packages/logger/dist/index.d.ts:4 Severity levels for log entries @@ -14,7 +14,7 @@ Severity levels for log entries DEBUG: "debug"; ``` -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:8 +Defined in: packages/logger/dist/index.d.ts:8 *** @@ -24,7 +24,7 @@ Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:8 ERROR: "error"; ``` -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:5 +Defined in: packages/logger/dist/index.d.ts:5 *** @@ -34,7 +34,7 @@ Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:5 INFO: "info"; ``` -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:7 +Defined in: packages/logger/dist/index.d.ts:7 *** @@ -44,4 +44,4 @@ Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:7 WARN: "warn"; ``` -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:6 +Defined in: packages/logger/dist/index.d.ts:6 diff --git a/docs/english/reference/oauth/index.md b/docs/english/reference/oauth/index.md index f369d2c30..adbe8c831 100644 --- a/docs/english/reference/oauth/index.md +++ b/docs/english/reference/oauth/index.md @@ -1,4 +1,4 @@ -# @slack/oauth v3.0.4 +# @slack/oauth v3.0.5 ## Enumerations diff --git a/docs/english/reference/oauth/interfaces/Logger.md b/docs/english/reference/oauth/interfaces/Logger.md index 2bca23d95..f1a8be7bf 100644 --- a/docs/english/reference/oauth/interfaces/Logger.md +++ b/docs/english/reference/oauth/interfaces/Logger.md @@ -2,7 +2,7 @@ # Interface: Logger -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:13 +Defined in: packages/logger/dist/index.d.ts:13 Interface for objects where objects in this package's logs can be sent (can be used as `logger` option). @@ -14,7 +14,7 @@ Interface for objects where objects in this package's logs can be sent (can be u debug(...msg): void; ``` -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:18 +Defined in: packages/logger/dist/index.d.ts:18 Output debug message @@ -38,7 +38,7 @@ any data to log error(...msg): void; ``` -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:33 +Defined in: packages/logger/dist/index.d.ts:33 Output error message @@ -62,7 +62,7 @@ any data to log getLevel(): LogLevel; ``` -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:43 +Defined in: packages/logger/dist/index.d.ts:43 Return the current LogLevel. @@ -78,7 +78,7 @@ Return the current LogLevel. info(...msg): void; ``` -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:23 +Defined in: packages/logger/dist/index.d.ts:23 Output info message @@ -102,7 +102,7 @@ any data to log setLevel(level): void; ``` -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:39 +Defined in: packages/logger/dist/index.d.ts:39 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. @@ -127,7 +127,7 @@ as a string, like 'error' (case-insensitive) setName(name): void; ``` -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:49 +Defined in: packages/logger/dist/index.d.ts:49 This allows the instance to be named so that they can easily be filtered when many loggers are sending output to the same destination. @@ -152,7 +152,7 @@ as a string, will be output with every log after the level warn(...msg): void; ``` -Defined in: packages/oauth/node\_modules/@slack/logger/dist/index.d.ts:28 +Defined in: packages/logger/dist/index.d.ts:28 Output warn message diff --git a/docs/english/reference/oauth/interfaces/OAuthV2Response.md b/docs/english/reference/oauth/interfaces/OAuthV2Response.md index c224f213e..9379a4a89 100644 --- a/docs/english/reference/oauth/interfaces/OAuthV2Response.md +++ b/docs/english/reference/oauth/interfaces/OAuthV2Response.md @@ -107,7 +107,7 @@ Defined in: [packages/oauth/src/install-provider.ts:781](https://github.com/slac optional error: string; ``` -Defined in: packages/oauth/node\_modules/@slack/web-api/dist/WebClient.d.ts:64 +Defined in: packages/web-api/dist/WebClient.d.ts:66 #### Inherited from @@ -177,7 +177,7 @@ Defined in: [packages/oauth/src/install-provider.ts:782](https://github.com/slac ok: boolean; ``` -Defined in: packages/oauth/node\_modules/@slack/web-api/dist/WebClient.d.ts:63 +Defined in: packages/web-api/dist/WebClient.d.ts:65 #### Inherited from @@ -203,7 +203,7 @@ Defined in: [packages/oauth/src/install-provider.ts:777](https://github.com/slac optional response_metadata: object; ``` -Defined in: packages/oauth/node\_modules/@slack/web-api/dist/WebClient.d.ts:65 +Defined in: packages/web-api/dist/WebClient.d.ts:67 #### acceptedScopes? diff --git a/docs/english/reference/oauth/interfaces/OAuthV2TokenRefreshResponse.md b/docs/english/reference/oauth/interfaces/OAuthV2TokenRefreshResponse.md index a5add38e5..e46dbb1ea 100644 --- a/docs/english/reference/oauth/interfaces/OAuthV2TokenRefreshResponse.md +++ b/docs/english/reference/oauth/interfaces/OAuthV2TokenRefreshResponse.md @@ -61,7 +61,7 @@ Defined in: [packages/oauth/src/install-provider.ts:800](https://github.com/slac optional error: string; ``` -Defined in: packages/oauth/node\_modules/@slack/web-api/dist/WebClient.d.ts:64 +Defined in: packages/web-api/dist/WebClient.d.ts:66 #### Inherited from @@ -97,7 +97,7 @@ Defined in: [packages/oauth/src/install-provider.ts:801](https://github.com/slac ok: boolean; ``` -Defined in: packages/oauth/node\_modules/@slack/web-api/dist/WebClient.d.ts:63 +Defined in: packages/web-api/dist/WebClient.d.ts:65 #### Inherited from @@ -123,7 +123,7 @@ Defined in: [packages/oauth/src/install-provider.ts:796](https://github.com/slac optional response_metadata: object; ``` -Defined in: packages/oauth/node\_modules/@slack/web-api/dist/WebClient.d.ts:65 +Defined in: packages/web-api/dist/WebClient.d.ts:67 #### acceptedScopes? diff --git a/docs/english/reference/rtm-api/classes/RTMClient.md b/docs/english/reference/rtm-api/classes/RTMClient.md index ccd04040c..e60fddca6 100644 --- a/docs/english/reference/rtm-api/classes/RTMClient.md +++ b/docs/english/reference/rtm-api/classes/RTMClient.md @@ -17,7 +17,7 @@ messages. ### Constructor ```ts -new RTMClient(token, __namedParameters): RTMClient; +new RTMClient(token, __namedParameters?): RTMClient; ``` Defined in: [packages/rtm-api/src/RTMClient.ts:367](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L367) @@ -28,7 +28,7 @@ Defined in: [packages/rtm-api/src/RTMClient.ts:367](https://github.com/slackapi/ `string` -##### \_\_namedParameters +##### \_\_namedParameters? [`RTMClientOptions`](../interfaces/RTMClientOptions.md) = `{}` @@ -99,7 +99,7 @@ Whether or not the client is currently connected to the RTM API static prefixed: string | boolean; ``` -Defined in: packages/rtm-api/node\_modules/eventemitter3/index.d.ts:9 +Defined in: node\_modules/eventemitter3/index.d.ts:9 #### Inherited from @@ -118,7 +118,7 @@ addListener( context?): this; ``` -Defined in: packages/rtm-api/node\_modules/eventemitter3/index.d.ts:45 +Defined in: node\_modules/eventemitter3/index.d.ts:45 #### Type Parameters @@ -275,7 +275,7 @@ start() again later. emit(event, ...args): boolean; ``` -Defined in: packages/rtm-api/node\_modules/eventemitter3/index.d.ts:32 +Defined in: node\_modules/eventemitter3/index.d.ts:32 Calls each of the listeners registered for a given event. @@ -313,7 +313,7 @@ EventEmitter.emit eventNames(): (string | symbol)[]; ``` -Defined in: packages/rtm-api/node\_modules/eventemitter3/index.d.ts:15 +Defined in: node\_modules/eventemitter3/index.d.ts:15 Return an array listing the events for which the emitter has registered listeners. @@ -336,7 +336,7 @@ EventEmitter.eventNames listenerCount(event): number; ``` -Defined in: packages/rtm-api/node\_modules/eventemitter3/index.d.ts:27 +Defined in: node\_modules/eventemitter3/index.d.ts:27 Return the number of listeners listening to a given event. @@ -364,7 +364,7 @@ EventEmitter.listenerCount listeners(event): (...args) => void[]; ``` -Defined in: packages/rtm-api/node\_modules/eventemitter3/index.d.ts:20 +Defined in: node\_modules/eventemitter3/index.d.ts:20 Return the listeners registered for a given event. @@ -402,7 +402,7 @@ off( once?): this; ``` -Defined in: packages/rtm-api/node\_modules/eventemitter3/index.d.ts:69 +Defined in: node\_modules/eventemitter3/index.d.ts:69 #### Type Parameters @@ -449,7 +449,7 @@ on( context?): this; ``` -Defined in: packages/rtm-api/node\_modules/eventemitter3/index.d.ts:40 +Defined in: node\_modules/eventemitter3/index.d.ts:40 Add a listener for a given event. @@ -494,7 +494,7 @@ once( context?): this; ``` -Defined in: packages/rtm-api/node\_modules/eventemitter3/index.d.ts:54 +Defined in: node\_modules/eventemitter3/index.d.ts:54 Add a one-time listener for a given event. @@ -536,7 +536,7 @@ EventEmitter.once removeAllListeners(event?): this; ``` -Defined in: packages/rtm-api/node\_modules/eventemitter3/index.d.ts:79 +Defined in: node\_modules/eventemitter3/index.d.ts:79 Remove all listeners, or those of the specified event. @@ -568,7 +568,7 @@ removeListener( once?): this; ``` -Defined in: packages/rtm-api/node\_modules/eventemitter3/index.d.ts:63 +Defined in: node\_modules/eventemitter3/index.d.ts:63 Remove the listeners of a given event. @@ -611,7 +611,7 @@ EventEmitter.removeListener ### send() ```ts -send(type, body): Promise; +send(type, body?): Promise; ``` Defined in: [packages/rtm-api/src/RTMClient.ts:578](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L578) @@ -630,7 +630,7 @@ there is `ts` on messages once the server acknowledges it). the message type -##### body +##### body? the message body diff --git a/docs/english/reference/rtm-api/enumerations/LogLevel.md b/docs/english/reference/rtm-api/enumerations/LogLevel.md index 307c0f374..3491257df 100644 --- a/docs/english/reference/rtm-api/enumerations/LogLevel.md +++ b/docs/english/reference/rtm-api/enumerations/LogLevel.md @@ -2,7 +2,7 @@ # Enumeration: LogLevel -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:4 +Defined in: packages/logger/dist/index.d.ts:4 Severity levels for log entries @@ -14,7 +14,7 @@ Severity levels for log entries DEBUG: "debug"; ``` -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:8 +Defined in: packages/logger/dist/index.d.ts:8 *** @@ -24,7 +24,7 @@ Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:8 ERROR: "error"; ``` -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:5 +Defined in: packages/logger/dist/index.d.ts:5 *** @@ -34,7 +34,7 @@ Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:5 INFO: "info"; ``` -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:7 +Defined in: packages/logger/dist/index.d.ts:7 *** @@ -44,4 +44,4 @@ Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:7 WARN: "warn"; ``` -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:6 +Defined in: packages/logger/dist/index.d.ts:6 diff --git a/docs/english/reference/rtm-api/interfaces/CodedError.md b/docs/english/reference/rtm-api/interfaces/CodedError.md index 3a0ccaf2e..ad48db83c 100644 --- a/docs/english/reference/rtm-api/interfaces/CodedError.md +++ b/docs/english/reference/rtm-api/interfaces/CodedError.md @@ -42,7 +42,7 @@ NodeJS.ErrnoException.code optional errno: number; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:196 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -90,7 +90,7 @@ NodeJS.ErrnoException.name optional path: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:198 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -122,7 +122,7 @@ NodeJS.ErrnoException.stack optional syscall: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:199 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/rtm-api/interfaces/Logger.md b/docs/english/reference/rtm-api/interfaces/Logger.md index 3995effb6..a03b40231 100644 --- a/docs/english/reference/rtm-api/interfaces/Logger.md +++ b/docs/english/reference/rtm-api/interfaces/Logger.md @@ -2,7 +2,7 @@ # Interface: Logger -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:13 +Defined in: packages/logger/dist/index.d.ts:13 Interface for objects where objects in this package's logs can be sent (can be used as `logger` option). @@ -14,7 +14,7 @@ Interface for objects where objects in this package's logs can be sent (can be u debug(...msg): void; ``` -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:18 +Defined in: packages/logger/dist/index.d.ts:18 Output debug message @@ -38,7 +38,7 @@ any data to log error(...msg): void; ``` -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:33 +Defined in: packages/logger/dist/index.d.ts:33 Output error message @@ -62,7 +62,7 @@ any data to log getLevel(): LogLevel; ``` -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:43 +Defined in: packages/logger/dist/index.d.ts:43 Return the current LogLevel. @@ -78,7 +78,7 @@ Return the current LogLevel. info(...msg): void; ``` -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:23 +Defined in: packages/logger/dist/index.d.ts:23 Output info message @@ -102,7 +102,7 @@ any data to log setLevel(level): void; ``` -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:39 +Defined in: packages/logger/dist/index.d.ts:39 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. @@ -127,7 +127,7 @@ as a string, like 'error' (case-insensitive) setName(name): void; ``` -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:49 +Defined in: packages/logger/dist/index.d.ts:49 This allows the instance to be named so that they can easily be filtered when many loggers are sending output to the same destination. @@ -152,7 +152,7 @@ as a string, will be output with every log after the level warn(...msg): void; ``` -Defined in: packages/rtm-api/node\_modules/@slack/logger/dist/index.d.ts:28 +Defined in: packages/logger/dist/index.d.ts:28 Output warn message diff --git a/docs/english/reference/rtm-api/interfaces/RTMNoReplyReceivedError.md b/docs/english/reference/rtm-api/interfaces/RTMNoReplyReceivedError.md index 3f01d7b83..6a20d589a 100644 --- a/docs/english/reference/rtm-api/interfaces/RTMNoReplyReceivedError.md +++ b/docs/english/reference/rtm-api/interfaces/RTMNoReplyReceivedError.md @@ -32,7 +32,7 @@ Defined in: [packages/rtm-api/src/errors.ts:44](https://github.com/slackapi/node optional errno: number; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:196 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -74,7 +74,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 optional path: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:198 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -102,7 +102,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 optional syscall: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:199 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/rtm-api/interfaces/RTMPlatformError.md b/docs/english/reference/rtm-api/interfaces/RTMPlatformError.md index 3fdb2edab..7453758d0 100644 --- a/docs/english/reference/rtm-api/interfaces/RTMPlatformError.md +++ b/docs/english/reference/rtm-api/interfaces/RTMPlatformError.md @@ -42,7 +42,7 @@ Defined in: [packages/rtm-api/src/errors.ts:35](https://github.com/slackapi/node optional errno: number; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:196 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -84,7 +84,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 optional path: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:198 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -112,7 +112,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 optional syscall: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:199 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/rtm-api/interfaces/RTMSendWhileDisconnectedError.md b/docs/english/reference/rtm-api/interfaces/RTMSendWhileDisconnectedError.md index d2e92b45a..44b414640 100644 --- a/docs/english/reference/rtm-api/interfaces/RTMSendWhileDisconnectedError.md +++ b/docs/english/reference/rtm-api/interfaces/RTMSendWhileDisconnectedError.md @@ -32,7 +32,7 @@ Defined in: [packages/rtm-api/src/errors.ts:48](https://github.com/slackapi/node optional errno: number; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:196 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -74,7 +74,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 optional path: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:198 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -102,7 +102,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 optional syscall: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:199 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/rtm-api/interfaces/RTMSendWhileNotReadyError.md b/docs/english/reference/rtm-api/interfaces/RTMSendWhileNotReadyError.md index 31c7733f1..372070a97 100644 --- a/docs/english/reference/rtm-api/interfaces/RTMSendWhileNotReadyError.md +++ b/docs/english/reference/rtm-api/interfaces/RTMSendWhileNotReadyError.md @@ -32,7 +32,7 @@ Defined in: [packages/rtm-api/src/errors.ts:52](https://github.com/slackapi/node optional errno: number; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:196 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -74,7 +74,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 optional path: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:198 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -102,7 +102,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 optional syscall: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:199 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/rtm-api/interfaces/RTMWebsocketError.md b/docs/english/reference/rtm-api/interfaces/RTMWebsocketError.md index d8570dc47..531408a64 100644 --- a/docs/english/reference/rtm-api/interfaces/RTMWebsocketError.md +++ b/docs/english/reference/rtm-api/interfaces/RTMWebsocketError.md @@ -32,7 +32,7 @@ Defined in: [packages/rtm-api/src/errors.ts:39](https://github.com/slackapi/node optional errno: number; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:196 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -84,7 +84,7 @@ Defined in: [packages/rtm-api/src/errors.ts:40](https://github.com/slackapi/node optional path: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:198 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -112,7 +112,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 optional syscall: string; ``` -Defined in: packages/rtm-api/node\_modules/@types/node/globals.d.ts:199 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/socket-mode/classes/SocketModeClient.md b/docs/english/reference/socket-mode/classes/SocketModeClient.md index b0933316d..ffc979f2d 100644 --- a/docs/english/reference/socket-mode/classes/SocketModeClient.md +++ b/docs/english/reference/socket-mode/classes/SocketModeClient.md @@ -18,14 +18,14 @@ and has a built in send method to acknowledge incoming events over the WebSocket ### Constructor ```ts -new SocketModeClient(__namedParameters): SocketModeClient; +new SocketModeClient(__namedParameters?): SocketModeClient; ``` Defined in: [packages/socket-mode/src/SocketModeClient.ts:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/socket-mode/src/SocketModeClient.ts#L96) #### Parameters -##### \_\_namedParameters +##### \_\_namedParameters? [`SocketModeOptions`](../interfaces/SocketModeOptions.md) = `...` @@ -59,7 +59,7 @@ The underlying WebSocket client instance static prefixed: string | boolean; ``` -Defined in: packages/socket-mode/node\_modules/eventemitter3/index.d.ts:9 +Defined in: node\_modules/eventemitter3/index.d.ts:9 #### Inherited from @@ -78,7 +78,7 @@ addListener( context?): this; ``` -Defined in: packages/socket-mode/node\_modules/eventemitter3/index.d.ts:45 +Defined in: node\_modules/eventemitter3/index.d.ts:45 #### Type Parameters @@ -135,7 +135,7 @@ unless you call start() again later. emit(event, ...args): boolean; ``` -Defined in: packages/socket-mode/node\_modules/eventemitter3/index.d.ts:32 +Defined in: node\_modules/eventemitter3/index.d.ts:32 Calls each of the listeners registered for a given event. @@ -173,7 +173,7 @@ EventEmitter.emit eventNames(): (string | symbol)[]; ``` -Defined in: packages/socket-mode/node\_modules/eventemitter3/index.d.ts:15 +Defined in: node\_modules/eventemitter3/index.d.ts:15 Return an array listing the events for which the emitter has registered listeners. @@ -196,7 +196,7 @@ EventEmitter.eventNames listenerCount(event): number; ``` -Defined in: packages/socket-mode/node\_modules/eventemitter3/index.d.ts:27 +Defined in: node\_modules/eventemitter3/index.d.ts:27 Return the number of listeners listening to a given event. @@ -224,7 +224,7 @@ EventEmitter.listenerCount listeners(event): (...args) => void[]; ``` -Defined in: packages/socket-mode/node\_modules/eventemitter3/index.d.ts:20 +Defined in: node\_modules/eventemitter3/index.d.ts:20 Return the listeners registered for a given event. @@ -262,7 +262,7 @@ off( once?): this; ``` -Defined in: packages/socket-mode/node\_modules/eventemitter3/index.d.ts:69 +Defined in: node\_modules/eventemitter3/index.d.ts:69 #### Type Parameters @@ -309,7 +309,7 @@ on( context?): this; ``` -Defined in: packages/socket-mode/node\_modules/eventemitter3/index.d.ts:40 +Defined in: node\_modules/eventemitter3/index.d.ts:40 Add a listener for a given event. @@ -354,7 +354,7 @@ once( context?): this; ``` -Defined in: packages/socket-mode/node\_modules/eventemitter3/index.d.ts:54 +Defined in: node\_modules/eventemitter3/index.d.ts:54 Add a one-time listener for a given event. @@ -396,7 +396,7 @@ EventEmitter.once removeAllListeners(event?): this; ``` -Defined in: packages/socket-mode/node\_modules/eventemitter3/index.d.ts:79 +Defined in: node\_modules/eventemitter3/index.d.ts:79 Remove all listeners, or those of the specified event. @@ -428,7 +428,7 @@ removeListener( once?): this; ``` -Defined in: packages/socket-mode/node\_modules/eventemitter3/index.d.ts:63 +Defined in: node\_modules/eventemitter3/index.d.ts:63 Remove the listeners of a given event. diff --git a/docs/english/reference/socket-mode/enumerations/LogLevel.md b/docs/english/reference/socket-mode/enumerations/LogLevel.md index bb2239a5e..a50f97cb0 100644 --- a/docs/english/reference/socket-mode/enumerations/LogLevel.md +++ b/docs/english/reference/socket-mode/enumerations/LogLevel.md @@ -2,7 +2,7 @@ # Enumeration: LogLevel -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:4 +Defined in: packages/logger/dist/index.d.ts:4 Severity levels for log entries @@ -14,7 +14,7 @@ Severity levels for log entries DEBUG: "debug"; ``` -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:8 +Defined in: packages/logger/dist/index.d.ts:8 *** @@ -24,7 +24,7 @@ Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:8 ERROR: "error"; ``` -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:5 +Defined in: packages/logger/dist/index.d.ts:5 *** @@ -34,7 +34,7 @@ Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:5 INFO: "info"; ``` -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:7 +Defined in: packages/logger/dist/index.d.ts:7 *** @@ -44,4 +44,4 @@ Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:7 WARN: "warn"; ``` -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:6 +Defined in: packages/logger/dist/index.d.ts:6 diff --git a/docs/english/reference/socket-mode/index.md b/docs/english/reference/socket-mode/index.md index 966793654..b96961d93 100644 --- a/docs/english/reference/socket-mode/index.md +++ b/docs/english/reference/socket-mode/index.md @@ -1,4 +1,4 @@ -# @slack/socket-mode v2.0.5 +# @slack/socket-mode v2.0.6 ## Enumerations diff --git a/docs/english/reference/socket-mode/interfaces/Logger.md b/docs/english/reference/socket-mode/interfaces/Logger.md index 219907aab..c0d30d9d0 100644 --- a/docs/english/reference/socket-mode/interfaces/Logger.md +++ b/docs/english/reference/socket-mode/interfaces/Logger.md @@ -2,7 +2,7 @@ # Interface: Logger -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:13 +Defined in: packages/logger/dist/index.d.ts:13 Interface for objects where objects in this package's logs can be sent (can be used as `logger` option). @@ -14,7 +14,7 @@ Interface for objects where objects in this package's logs can be sent (can be u debug(...msg): void; ``` -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:18 +Defined in: packages/logger/dist/index.d.ts:18 Output debug message @@ -38,7 +38,7 @@ any data to log error(...msg): void; ``` -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:33 +Defined in: packages/logger/dist/index.d.ts:33 Output error message @@ -62,7 +62,7 @@ any data to log getLevel(): LogLevel; ``` -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:43 +Defined in: packages/logger/dist/index.d.ts:43 Return the current LogLevel. @@ -78,7 +78,7 @@ Return the current LogLevel. info(...msg): void; ``` -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:23 +Defined in: packages/logger/dist/index.d.ts:23 Output info message @@ -102,7 +102,7 @@ any data to log setLevel(level): void; ``` -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:39 +Defined in: packages/logger/dist/index.d.ts:39 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. @@ -127,7 +127,7 @@ as a string, like 'error' (case-insensitive) setName(name): void; ``` -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:49 +Defined in: packages/logger/dist/index.d.ts:49 This allows the instance to be named so that they can easily be filtered when many loggers are sending output to the same destination. @@ -152,7 +152,7 @@ as a string, will be output with every log after the level warn(...msg): void; ``` -Defined in: packages/socket-mode/node\_modules/@slack/logger/dist/index.d.ts:28 +Defined in: packages/logger/dist/index.d.ts:28 Output warn message diff --git a/docs/english/reference/types/index.md b/docs/english/reference/types/index.md index d130ce084..ee97da827 100644 --- a/docs/english/reference/types/index.md +++ b/docs/english/reference/types/index.md @@ -1,4 +1,4 @@ -# @slack/types v2.19.0 +# @slack/types v2.20.1 ## Enumerations diff --git a/docs/english/reference/web-api/classes/Methods.md b/docs/english/reference/web-api/classes/Methods.md index b726d7b73..3906e5a67 100644 --- a/docs/english/reference/web-api/classes/Methods.md +++ b/docs/english/reference/web-api/classes/Methods.md @@ -2,7 +2,7 @@ # Abstract Class: Methods -Defined in: [packages/web-api/src/methods.ts:597](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L597) +Defined in: [packages/web-api/src/methods.ts:599](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L599) A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the `apiCall` class method. @@ -23,7 +23,7 @@ A class that defines all Web API methods, their arguments type, their response t readonly admin: object; ``` -Defined in: [packages/web-api/src/methods.ts:610](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L610) +Defined in: [packages/web-api/src/methods.ts:612](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L612) #### analytics @@ -1558,7 +1558,7 @@ Unpublish workflows within the team or enterprise. readonly api: object; ``` -Defined in: [packages/web-api/src/methods.ts:1375](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1375) +Defined in: [packages/web-api/src/methods.ts:1377](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1377) #### test @@ -1582,7 +1582,7 @@ Checks API calling code. readonly apps: object; ``` -Defined in: [packages/web-api/src/methods.ts:1412](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1412) +Defined in: [packages/web-api/src/methods.ts:1414](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1414) #### connections @@ -1722,6 +1722,32 @@ Uninstalls your app from a workspace. [\`apps.uninstall\` API reference](https://docs.slack.dev/reference/methods/apps.uninstall). +#### user + +```ts +user: object; +``` + +##### user.connection + +```ts +connection: object; +``` + +##### user.connection.update + +```ts +update: MethodWithRequiredArgument; +``` + +###### Description + +Updates the connection status between a user and an app. + +###### See + +[\`apps.user.connection.update\` API reference](https://docs.slack.dev/reference/methods/apps.user.connection.update). + *** ### assistant @@ -1730,7 +1756,7 @@ Uninstalls your app from a workspace. readonly assistant: object; ``` -Defined in: [packages/web-api/src/methods.ts:1383](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1383) +Defined in: [packages/web-api/src/methods.ts:1385](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1385) #### threads @@ -1788,7 +1814,7 @@ Set the title of the thread. This is shown when a user views the app's chat hist readonly auth: object; ``` -Defined in: [packages/web-api/src/methods.ts:1474](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1474) +Defined in: [packages/web-api/src/methods.ts:1488](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1488) #### revoke @@ -1838,7 +1864,7 @@ test: Method; readonly bookmarks: object; ``` -Defined in: [packages/web-api/src/methods.ts:1490](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1490) +Defined in: [packages/web-api/src/methods.ts:1504](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1504) #### add @@ -1904,7 +1930,7 @@ Remove bookmark from a channel. readonly bots: object; ``` -Defined in: [packages/web-api/src/methods.ts:1513](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1513) +Defined in: [packages/web-api/src/methods.ts:1527](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1527) #### info @@ -1928,7 +1954,7 @@ Gets information about a bot user. readonly calls: object; ``` -Defined in: [packages/web-api/src/methods.ts:1521](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1521) +Defined in: [packages/web-api/src/methods.ts:1535](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1535) #### add @@ -2020,7 +2046,7 @@ Updates information about a Call. readonly canvases: object; ``` -Defined in: [packages/web-api/src/methods.ts:1555](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1555) +Defined in: [packages/web-api/src/methods.ts:1569](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1569) #### access @@ -2126,7 +2152,7 @@ Find sections matching the provided criteria. readonly chat: object; ``` -Defined in: [packages/web-api/src/methods.ts:1595](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1595) +Defined in: [packages/web-api/src/methods.ts:1609](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1609) #### appendStream @@ -2324,7 +2350,7 @@ Updates a message. readonly conversations: object; ``` -Defined in: [packages/web-api/src/methods.ts:1674](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1674) +Defined in: [packages/web-api/src/methods.ts:1688](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1688) #### acceptSharedInvite @@ -2746,7 +2772,7 @@ Reverses conversation archival. readonly dialog: object; ``` -Defined in: [packages/web-api/src/methods.ts:1867](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1867) +Defined in: [packages/web-api/src/methods.ts:1881](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1881) #### open @@ -2770,7 +2796,7 @@ Open a dialog with a user. readonly dnd: object; ``` -Defined in: [packages/web-api/src/methods.ts:1875](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1875) +Defined in: [packages/web-api/src/methods.ts:1889](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1889) #### endDnd @@ -2850,7 +2876,7 @@ Retrieves the Do Not Disturb status for up to 50 users on a team. readonly emoji: object; ``` -Defined in: [packages/web-api/src/methods.ts:1903](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1903) +Defined in: [packages/web-api/src/methods.ts:1917](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1917) #### list @@ -2874,7 +2900,7 @@ Lists custom emoji for a team. readonly entity: object; ``` -Defined in: [packages/web-api/src/methods.ts:1911](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1911) +Defined in: [packages/web-api/src/methods.ts:1925](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1925) #### presentDetails @@ -2898,7 +2924,7 @@ Provide information about the entity to be displayed in the flexpane. readonly files: object; ``` -Defined in: [packages/web-api/src/methods.ts:1922](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1922) +Defined in: [packages/web-api/src/methods.ts:1936](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1936) #### comments @@ -3157,7 +3183,7 @@ as multiple file uploads property. readonly functions: object; ``` -Defined in: [packages/web-api/src/methods.ts:2031](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2031) +Defined in: [packages/web-api/src/methods.ts:2045](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2045) #### completeError @@ -3195,7 +3221,7 @@ Signal the successful completion of a Custom Function. readonly migration: object; ``` -Defined in: [packages/web-api/src/methods.ts:2050](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2050) +Defined in: [packages/web-api/src/methods.ts:2064](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2064) #### exchange @@ -3219,7 +3245,7 @@ For Enterprise Grid workspaces, map local user IDs to global user IDs. readonly oauth: object; ``` -Defined in: [packages/web-api/src/methods.ts:2058](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2058) +Defined in: [packages/web-api/src/methods.ts:2072](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2072) #### ~~access~~ @@ -3281,7 +3307,7 @@ Exchanges a legacy access token for a new expiring access token and refresh toke readonly openid: object; ``` -Defined in: [packages/web-api/src/methods.ts:2079](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2079) +Defined in: [packages/web-api/src/methods.ts:2093](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2093) #### connect @@ -3325,7 +3351,7 @@ Get the identity of a user who has authorized [Sign in with Slack](https://docs. readonly pins: object; ``` -Defined in: [packages/web-api/src/methods.ts:2097](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2097) +Defined in: [packages/web-api/src/methods.ts:2111](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2111) #### add @@ -3377,7 +3403,7 @@ Un-pins an item from a channel. readonly reactions: object; ``` -Defined in: [packages/web-api/src/methods.ts:2115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2115) +Defined in: [packages/web-api/src/methods.ts:2129](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2129) #### add @@ -3443,7 +3469,7 @@ Removes a reaction from an item. readonly reminders: object; ``` -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) +Defined in: [packages/web-api/src/methods.ts:2154](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2154) #### add @@ -3523,7 +3549,7 @@ Lists all reminders created by or for a given user. readonly rtm: object; ``` -Defined in: [packages/web-api/src/methods.ts:2168](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2168) +Defined in: [packages/web-api/src/methods.ts:2182](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2182) #### connect @@ -3565,7 +3591,7 @@ Use `rtm.connect` instead. See [our post on retiring \`rtm.start\`](https://docs readonly search: object; ``` -Defined in: [packages/web-api/src/methods.ts:2182](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2182) +Defined in: [packages/web-api/src/methods.ts:2196](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2196) #### all @@ -3617,7 +3643,7 @@ Searches for messages matching a query. readonly slackLists: object; ``` -Defined in: [packages/web-api/src/methods.ts:2200](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2200) +Defined in: [packages/web-api/src/methods.ts:2214](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2214) #### access @@ -3813,7 +3839,7 @@ Update a list. readonly stars: object; ``` -Defined in: [packages/web-api/src/methods.ts:2511](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2511) +Defined in: [packages/web-api/src/methods.ts:2525](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2525) #### ~~add~~ @@ -3880,7 +3906,7 @@ See [our post on stars and the Later list](https://docs.slack.dev/changelog/2023 readonly team: object; ``` -Defined in: [packages/web-api/src/methods.ts:2287](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2287) +Defined in: [packages/web-api/src/methods.ts:2301](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2301) #### accessLogs @@ -4040,7 +4066,7 @@ Retrieve a team's profile. readonly tooling: object; ``` -Defined in: [packages/web-api/src/methods.ts:2358](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2358) +Defined in: [packages/web-api/src/methods.ts:2372](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2372) #### tokens @@ -4070,7 +4096,7 @@ Exchanges a refresh token for a new app configuration token. readonly usergroups: object; ``` -Defined in: [packages/web-api/src/methods.ts:2368](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2368) +Defined in: [packages/web-api/src/methods.ts:2382](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2382) #### create @@ -4184,7 +4210,7 @@ Update the list of users in a User Group. readonly users: object; ``` -Defined in: [packages/web-api/src/methods.ts:2411](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2411) +Defined in: [packages/web-api/src/methods.ts:2425](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2425) #### conversations @@ -4374,7 +4400,7 @@ Manually sets user presence. readonly views: object; ``` -Defined in: [packages/web-api/src/methods.ts:2481](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2481) +Defined in: [packages/web-api/src/methods.ts:2495](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2495) #### open @@ -4440,7 +4466,7 @@ Update an existing view. readonly workflows: object; ``` -Defined in: [packages/web-api/src/methods.ts:2535](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2535) +Defined in: [packages/web-api/src/methods.ts:2549](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2549) #### featured @@ -4572,7 +4598,7 @@ See [our post on deprecating Steps from Apps](https://docs.slack.dev/changelog/2 static prefixed: string | boolean; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:9 +Defined in: node\_modules/eventemitter3/index.d.ts:9 #### Inherited from @@ -4591,7 +4617,7 @@ addListener( context?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:45 +Defined in: node\_modules/eventemitter3/index.d.ts:45 #### Type Parameters @@ -4631,7 +4657,7 @@ EventEmitter.addListener abstract apiCall(method, options?): Promise; ``` -Defined in: [packages/web-api/src/methods.ts:607](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L607) +Defined in: [packages/web-api/src/methods.ts:609](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L609) #### Parameters @@ -4655,7 +4681,7 @@ Defined in: [packages/web-api/src/methods.ts:607](https://github.com/slackapi/no emit(event, ...args): boolean; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:32 +Defined in: node\_modules/eventemitter3/index.d.ts:32 Calls each of the listeners registered for a given event. @@ -4693,7 +4719,7 @@ EventEmitter.emit eventNames(): RATE_LIMITED[]; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:15 +Defined in: node\_modules/eventemitter3/index.d.ts:15 Return an array listing the events for which the emitter has registered listeners. @@ -4716,7 +4742,7 @@ EventEmitter.eventNames abstract filesUploadV2(options): Promise; ``` -Defined in: [packages/web-api/src/methods.ts:608](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L608) +Defined in: [packages/web-api/src/methods.ts:610](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L610) #### Parameters @@ -4736,7 +4762,7 @@ Defined in: [packages/web-api/src/methods.ts:608](https://github.com/slackapi/no listenerCount(event): number; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:27 +Defined in: node\_modules/eventemitter3/index.d.ts:27 Return the number of listeners listening to a given event. @@ -4764,7 +4790,7 @@ EventEmitter.listenerCount listeners(event): (...args) => void[]; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:20 +Defined in: node\_modules/eventemitter3/index.d.ts:20 Return the listeners registered for a given event. @@ -4802,7 +4828,7 @@ off( once?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:69 +Defined in: node\_modules/eventemitter3/index.d.ts:69 #### Type Parameters @@ -4849,7 +4875,7 @@ on( context?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:40 +Defined in: node\_modules/eventemitter3/index.d.ts:40 Add a listener for a given event. @@ -4894,7 +4920,7 @@ once( context?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:54 +Defined in: node\_modules/eventemitter3/index.d.ts:54 Add a one-time listener for a given event. @@ -4936,7 +4962,7 @@ EventEmitter.once removeAllListeners(event?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:79 +Defined in: node\_modules/eventemitter3/index.d.ts:79 Remove all listeners, or those of the specified event. @@ -4968,7 +4994,7 @@ removeListener( once?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:63 +Defined in: node\_modules/eventemitter3/index.d.ts:63 Remove the listeners of a given event. diff --git a/docs/english/reference/web-api/classes/WebClient.md b/docs/english/reference/web-api/classes/WebClient.md index c3dc58f69..66a001057 100644 --- a/docs/english/reference/web-api/classes/WebClient.md +++ b/docs/english/reference/web-api/classes/WebClient.md @@ -55,7 +55,7 @@ Methods.constructor readonly admin: object; ``` -Defined in: [packages/web-api/src/methods.ts:610](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L610) +Defined in: [packages/web-api/src/methods.ts:612](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L612) #### analytics @@ -1594,7 +1594,7 @@ Unpublish workflows within the team or enterprise. readonly api: object; ``` -Defined in: [packages/web-api/src/methods.ts:1375](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1375) +Defined in: [packages/web-api/src/methods.ts:1377](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1377) #### test @@ -1622,7 +1622,7 @@ Checks API calling code. readonly apps: object; ``` -Defined in: [packages/web-api/src/methods.ts:1412](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1412) +Defined in: [packages/web-api/src/methods.ts:1414](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1414) #### connections @@ -1762,6 +1762,32 @@ Uninstalls your app from a workspace. [\`apps.uninstall\` API reference](https://docs.slack.dev/reference/methods/apps.uninstall). +#### user + +```ts +user: object; +``` + +##### user.connection + +```ts +connection: object; +``` + +##### user.connection.update + +```ts +update: MethodWithRequiredArgument; +``` + +###### Description + +Updates the connection status between a user and an app. + +###### See + +[\`apps.user.connection.update\` API reference](https://docs.slack.dev/reference/methods/apps.user.connection.update). + #### Inherited from [`Methods`](Methods.md).[`apps`](Methods.md#apps) @@ -1774,7 +1800,7 @@ Uninstalls your app from a workspace. readonly assistant: object; ``` -Defined in: [packages/web-api/src/methods.ts:1383](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1383) +Defined in: [packages/web-api/src/methods.ts:1385](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1385) #### threads @@ -1836,7 +1862,7 @@ Set the title of the thread. This is shown when a user views the app's chat hist readonly auth: object; ``` -Defined in: [packages/web-api/src/methods.ts:1474](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1474) +Defined in: [packages/web-api/src/methods.ts:1488](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1488) #### revoke @@ -1890,7 +1916,7 @@ test: Method; readonly bookmarks: object; ``` -Defined in: [packages/web-api/src/methods.ts:1490](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1490) +Defined in: [packages/web-api/src/methods.ts:1504](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1504) #### add @@ -1960,7 +1986,7 @@ Remove bookmark from a channel. readonly bots: object; ``` -Defined in: [packages/web-api/src/methods.ts:1513](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1513) +Defined in: [packages/web-api/src/methods.ts:1527](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1527) #### info @@ -1988,7 +2014,7 @@ Gets information about a bot user. readonly calls: object; ``` -Defined in: [packages/web-api/src/methods.ts:1521](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1521) +Defined in: [packages/web-api/src/methods.ts:1535](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1535) #### add @@ -2084,7 +2110,7 @@ Updates information about a Call. readonly canvases: object; ``` -Defined in: [packages/web-api/src/methods.ts:1555](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1555) +Defined in: [packages/web-api/src/methods.ts:1569](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1569) #### access @@ -2194,7 +2220,7 @@ Find sections matching the provided criteria. readonly chat: object; ``` -Defined in: [packages/web-api/src/methods.ts:1595](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1595) +Defined in: [packages/web-api/src/methods.ts:1609](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1609) #### appendStream @@ -2396,7 +2422,7 @@ Updates a message. readonly conversations: object; ``` -Defined in: [packages/web-api/src/methods.ts:1674](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1674) +Defined in: [packages/web-api/src/methods.ts:1688](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1688) #### acceptSharedInvite @@ -2822,7 +2848,7 @@ Reverses conversation archival. readonly dialog: object; ``` -Defined in: [packages/web-api/src/methods.ts:1867](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1867) +Defined in: [packages/web-api/src/methods.ts:1881](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1881) #### open @@ -2850,7 +2876,7 @@ Open a dialog with a user. readonly dnd: object; ``` -Defined in: [packages/web-api/src/methods.ts:1875](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1875) +Defined in: [packages/web-api/src/methods.ts:1889](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1889) #### endDnd @@ -2934,7 +2960,7 @@ Retrieves the Do Not Disturb status for up to 50 users on a team. readonly emoji: object; ``` -Defined in: [packages/web-api/src/methods.ts:1903](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1903) +Defined in: [packages/web-api/src/methods.ts:1917](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1917) #### list @@ -2962,7 +2988,7 @@ Lists custom emoji for a team. readonly entity: object; ``` -Defined in: [packages/web-api/src/methods.ts:1911](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1911) +Defined in: [packages/web-api/src/methods.ts:1925](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1925) #### presentDetails @@ -2990,7 +3016,7 @@ Provide information about the entity to be displayed in the flexpane. readonly files: object; ``` -Defined in: [packages/web-api/src/methods.ts:1922](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1922) +Defined in: [packages/web-api/src/methods.ts:1936](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1936) #### comments @@ -3253,7 +3279,7 @@ as multiple file uploads property. readonly functions: object; ``` -Defined in: [packages/web-api/src/methods.ts:2031](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2031) +Defined in: [packages/web-api/src/methods.ts:2045](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2045) #### completeError @@ -3295,7 +3321,7 @@ Signal the successful completion of a Custom Function. readonly migration: object; ``` -Defined in: [packages/web-api/src/methods.ts:2050](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2050) +Defined in: [packages/web-api/src/methods.ts:2064](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2064) #### exchange @@ -3323,7 +3349,7 @@ For Enterprise Grid workspaces, map local user IDs to global user IDs. readonly oauth: object; ``` -Defined in: [packages/web-api/src/methods.ts:2058](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2058) +Defined in: [packages/web-api/src/methods.ts:2072](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2072) #### ~~access~~ @@ -3389,7 +3415,7 @@ Exchanges a legacy access token for a new expiring access token and refresh toke readonly openid: object; ``` -Defined in: [packages/web-api/src/methods.ts:2079](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2079) +Defined in: [packages/web-api/src/methods.ts:2093](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2093) #### connect @@ -3437,7 +3463,7 @@ Get the identity of a user who has authorized [Sign in with Slack](https://docs. readonly pins: object; ``` -Defined in: [packages/web-api/src/methods.ts:2097](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2097) +Defined in: [packages/web-api/src/methods.ts:2111](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2111) #### add @@ -3493,7 +3519,7 @@ Un-pins an item from a channel. readonly reactions: object; ``` -Defined in: [packages/web-api/src/methods.ts:2115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2115) +Defined in: [packages/web-api/src/methods.ts:2129](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2129) #### add @@ -3563,7 +3589,7 @@ Removes a reaction from an item. readonly reminders: object; ``` -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) +Defined in: [packages/web-api/src/methods.ts:2154](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2154) #### add @@ -3647,7 +3673,7 @@ Lists all reminders created by or for a given user. readonly rtm: object; ``` -Defined in: [packages/web-api/src/methods.ts:2168](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2168) +Defined in: [packages/web-api/src/methods.ts:2182](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2182) #### connect @@ -3693,7 +3719,7 @@ Use `rtm.connect` instead. See [our post on retiring \`rtm.start\`](https://docs readonly search: object; ``` -Defined in: [packages/web-api/src/methods.ts:2182](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2182) +Defined in: [packages/web-api/src/methods.ts:2196](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2196) #### all @@ -3761,7 +3787,7 @@ The base URL for reaching Slack's Web API. Consider changing this value for test readonly slackLists: object; ``` -Defined in: [packages/web-api/src/methods.ts:2200](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2200) +Defined in: [packages/web-api/src/methods.ts:2214](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2214) #### access @@ -3961,7 +3987,7 @@ Update a list. readonly stars: object; ``` -Defined in: [packages/web-api/src/methods.ts:2511](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2511) +Defined in: [packages/web-api/src/methods.ts:2525](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2525) #### ~~add~~ @@ -4032,7 +4058,7 @@ See [our post on stars and the Later list](https://docs.slack.dev/changelog/2023 readonly team: object; ``` -Defined in: [packages/web-api/src/methods.ts:2287](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2287) +Defined in: [packages/web-api/src/methods.ts:2301](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2301) #### accessLogs @@ -4208,7 +4234,7 @@ Authentication and authorization token for accessing Slack Web API (usually begi readonly tooling: object; ``` -Defined in: [packages/web-api/src/methods.ts:2358](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2358) +Defined in: [packages/web-api/src/methods.ts:2372](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2372) #### tokens @@ -4242,7 +4268,7 @@ Exchanges a refresh token for a new app configuration token. readonly usergroups: object; ``` -Defined in: [packages/web-api/src/methods.ts:2368](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2368) +Defined in: [packages/web-api/src/methods.ts:2382](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2382) #### create @@ -4360,7 +4386,7 @@ Update the list of users in a User Group. readonly users: object; ``` -Defined in: [packages/web-api/src/methods.ts:2411](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2411) +Defined in: [packages/web-api/src/methods.ts:2425](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2425) #### conversations @@ -4554,7 +4580,7 @@ Manually sets user presence. readonly views: object; ``` -Defined in: [packages/web-api/src/methods.ts:2481](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2481) +Defined in: [packages/web-api/src/methods.ts:2495](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2495) #### open @@ -4624,7 +4650,7 @@ Update an existing view. readonly workflows: object; ``` -Defined in: [packages/web-api/src/methods.ts:2535](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2535) +Defined in: [packages/web-api/src/methods.ts:2549](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2549) #### featured @@ -4760,7 +4786,7 @@ See [our post on deprecating Steps from Apps](https://docs.slack.dev/changelog/2 static prefixed: string | boolean; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:9 +Defined in: node\_modules/eventemitter3/index.d.ts:9 #### Inherited from @@ -4777,7 +4803,7 @@ addListener( context?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:45 +Defined in: node\_modules/eventemitter3/index.d.ts:45 #### Type Parameters @@ -4812,7 +4838,7 @@ Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:45 ### apiCall() ```ts -apiCall(method, options): Promise; +apiCall(method, options?): Promise; ``` Defined in: [packages/web-api/src/WebClient.ts:346](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L346) @@ -4827,7 +4853,7 @@ Generic method for calling a Web API method the Web API method to call [https://docs.slack.dev/reference/methods](https://docs.slack.dev/reference/methods) -##### options +##### options? `Record`\<`string`, `unknown`\> = `{}` @@ -4901,7 +4927,7 @@ await streamer.stop(); emit(event, ...args): boolean; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:32 +Defined in: node\_modules/eventemitter3/index.d.ts:32 Calls each of the listeners registered for a given event. @@ -4937,7 +4963,7 @@ Calls each of the listeners registered for a given event. eventNames(): RATE_LIMITED[]; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:15 +Defined in: node\_modules/eventemitter3/index.d.ts:15 Return an array listing the events for which the emitter has registered listeners. @@ -4993,7 +5019,7 @@ URLs returned from step 1 (e.g. https://files.slack.com/upload/v1/...\") listenerCount(event): number; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:27 +Defined in: node\_modules/eventemitter3/index.d.ts:27 Return the number of listeners listening to a given event. @@ -5019,7 +5045,7 @@ Return the number of listeners listening to a given event. listeners(event): (...args) => void[]; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:20 +Defined in: node\_modules/eventemitter3/index.d.ts:20 Return the listeners registered for a given event. @@ -5055,7 +5081,7 @@ off( once?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:69 +Defined in: node\_modules/eventemitter3/index.d.ts:69 #### Type Parameters @@ -5100,7 +5126,7 @@ on( context?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:40 +Defined in: node\_modules/eventemitter3/index.d.ts:40 Add a listener for a given event. @@ -5143,7 +5169,7 @@ once( context?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:54 +Defined in: node\_modules/eventemitter3/index.d.ts:54 Add a one-time listener for a given event. @@ -5342,7 +5368,7 @@ a callback that can be used to accumulate a value that the return promise is res removeAllListeners(event?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:79 +Defined in: node\_modules/eventemitter3/index.d.ts:79 Remove all listeners, or those of the specified event. @@ -5372,7 +5398,7 @@ removeListener( once?): this; ``` -Defined in: packages/web-api/node\_modules/eventemitter3/index.d.ts:63 +Defined in: node\_modules/eventemitter3/index.d.ts:63 Remove the listeners of a given event. diff --git a/docs/english/reference/web-api/enumerations/CustomFieldType.md b/docs/english/reference/web-api/enumerations/CustomFieldType.md new file mode 100644 index 000000000..9670397b2 --- /dev/null +++ b/docs/english/reference/web-api/enumerations/CustomFieldType.md @@ -0,0 +1,125 @@ +[@slack/web-api](../index.md) / CustomFieldType + +# Enumeration: CustomFieldType + +Defined in: packages/types/dist/message-metadata.d.ts:255 + +## Enumeration Members + +### Array + +```ts +Array: "array"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:258 + +*** + +### Boolean + +```ts +Boolean: "boolean"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:265 + +*** + +### ChannelId + +```ts +ChannelId: "slack#/types/channel_id"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:262 + +*** + +### Date + +```ts +Date: "slack#/types/date"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:259 + +*** + +### Email + +```ts +Email: "slack#/types/email"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:267 + +*** + +### EntityRef + +```ts +EntityRef: "slack#/types/entity_ref"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:264 + +*** + +### Image + +```ts +Image: "slack#/types/image"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:261 + +*** + +### Integer + +```ts +Integer: "integer"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:256 + +*** + +### Link + +```ts +Link: "slack#/types/link"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:266 + +*** + +### String + +```ts +String: "string"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:257 + +*** + +### Timestamp + +```ts +Timestamp: "slack#/types/timestamp"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:260 + +*** + +### User + +```ts +User: "slack#/types/user"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:263 diff --git a/docs/english/reference/web-api/enumerations/EntityType.md b/docs/english/reference/web-api/enumerations/EntityType.md new file mode 100644 index 000000000..ded44b144 --- /dev/null +++ b/docs/english/reference/web-api/enumerations/EntityType.md @@ -0,0 +1,55 @@ +[@slack/web-api](../index.md) / EntityType + +# Enumeration: EntityType + +Defined in: packages/types/dist/message-metadata.d.ts:62 + +## Enumeration Members + +### ContentItem + +```ts +ContentItem: "slack#/entities/content_item"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:67 + +*** + +### File + +```ts +File: "slack#/entities/file"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:64 + +*** + +### Incident + +```ts +Incident: "slack#/entities/incident"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:66 + +*** + +### Item + +```ts +Item: "slack#/entities/item"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:65 + +*** + +### Task + +```ts +Task: "slack#/entities/task"; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:63 diff --git a/docs/english/reference/web-api/enumerations/LogLevel.md b/docs/english/reference/web-api/enumerations/LogLevel.md index 9dec5bd25..e6c91a0b5 100644 --- a/docs/english/reference/web-api/enumerations/LogLevel.md +++ b/docs/english/reference/web-api/enumerations/LogLevel.md @@ -2,7 +2,7 @@ # Enumeration: LogLevel -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:4 +Defined in: packages/logger/dist/index.d.ts:4 Severity levels for log entries @@ -14,7 +14,7 @@ Severity levels for log entries DEBUG: "debug"; ``` -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:8 +Defined in: packages/logger/dist/index.d.ts:8 *** @@ -24,7 +24,7 @@ Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:8 ERROR: "error"; ``` -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:5 +Defined in: packages/logger/dist/index.d.ts:5 *** @@ -34,7 +34,7 @@ Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:5 INFO: "info"; ``` -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:7 +Defined in: packages/logger/dist/index.d.ts:7 *** @@ -44,4 +44,4 @@ Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:7 WARN: "warn"; ``` -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:6 +Defined in: packages/logger/dist/index.d.ts:6 diff --git a/docs/english/reference/web-api/index.md b/docs/english/reference/web-api/index.md index a576ecabc..d75f6c48d 100644 --- a/docs/english/reference/web-api/index.md +++ b/docs/english/reference/web-api/index.md @@ -1,7 +1,9 @@ -# @slack/web-api v7.13.0 +# @slack/web-api v7.15.0 ## Enumerations +- [CustomFieldType](enumerations/CustomFieldType.md) +- [EntityType](enumerations/EntityType.md) - [ErrorCode](enumerations/ErrorCode.md) - [LogLevel](enumerations/LogLevel.md) - [WebClientEvent](enumerations/WebClientEvent.md) @@ -108,6 +110,7 @@ - [AppsManifestUpdateArguments](interfaces/AppsManifestUpdateArguments.md) - [AppsManifestValidateArguments](interfaces/AppsManifestValidateArguments.md) - [AppsUninstallArguments](interfaces/AppsUninstallArguments.md) +- [AppsUserConnectionUpdateArguments](interfaces/AppsUserConnectionUpdateArguments.md) - [AppUninstalledEvent](interfaces/AppUninstalledEvent.md) - [AppUninstalledTeamEvent](interfaces/AppUninstalledTeamEvent.md) - [AssistantThreadContextChangedEvent](interfaces/AssistantThreadContextChangedEvent.md) @@ -163,11 +166,13 @@ - [ChatStartStreamArguments](interfaces/ChatStartStreamArguments.md) - [ChatStreamerOptions](interfaces/ChatStreamerOptions.md) - [Checkboxes](interfaces/Checkboxes.md) +- [Chunk](interfaces/Chunk.md) - [CodedError](interfaces/CodedError.md) - [~~Confirm~~](interfaces/Confirm.md) - [Confirmable](interfaces/Confirmable.md) - [Confirmation](interfaces/Confirmation.md) - [ConfirmationDialog](interfaces/ConfirmationDialog.md) +- [ContentItemEntityFields](interfaces/ContentItemEntityFields.md) - [ContextActionsBlock](interfaces/ContextActionsBlock.md) - [ContextBlock](interfaces/ContextBlock.md) - [ConversationsApproveSharedInviteArguments](interfaces/ConversationsApproveSharedInviteArguments.md) @@ -208,6 +213,24 @@ - [EmailDomainChangedEvent](interfaces/EmailDomainChangedEvent.md) - [EmailInput](interfaces/EmailInput.md) - [EmojiChangedEvent](interfaces/EmojiChangedEvent.md) +- [EntityActionButton](interfaces/EntityActionButton.md) +- [EntityArrayItemField](interfaces/EntityArrayItemField.md) +- [EntityAttributes](interfaces/EntityAttributes.md) +- [EntityBooleanCheckboxField](interfaces/EntityBooleanCheckboxField.md) +- [EntityBooleanTextField](interfaces/EntityBooleanTextField.md) +- [EntityCustomField](interfaces/EntityCustomField.md) +- [EntityEditSupport](interfaces/EntityEditSupport.md) +- [EntityFullSizePreview](interfaces/EntityFullSizePreview.md) +- [EntityIconField](interfaces/EntityIconField.md) +- [EntityImageField](interfaces/EntityImageField.md) +- [EntityMetadata](interfaces/EntityMetadata.md) +- [EntityRefField](interfaces/EntityRefField.md) +- [EntityStringField](interfaces/EntityStringField.md) +- [EntityTimestampField](interfaces/EntityTimestampField.md) +- [EntityTypedField](interfaces/EntityTypedField.md) +- [EntityUserField](interfaces/EntityUserField.md) +- [EntityUserIDField](interfaces/EntityUserIDField.md) +- [ExternalRef](interfaces/ExternalRef.md) - [ExternalSelect](interfaces/ExternalSelect.md) - [FeedbackButtons](interfaces/FeedbackButtons.md) - [FileBlock](interfaces/FileBlock.md) @@ -215,6 +238,8 @@ - [FileCommentDeletedEvent](interfaces/FileCommentDeletedEvent.md) - [FileCreatedEvent](interfaces/FileCreatedEvent.md) - [FileDeletedEvent](interfaces/FileDeletedEvent.md) +- [FileEntityFields](interfaces/FileEntityFields.md) +- [FileEntitySlackFile](interfaces/FileEntitySlackFile.md) - [FileInput](interfaces/FileInput.md) - [FilePublicEvent](interfaces/FilePublicEvent.md) - [FilesCommentsDeleteArguments](interfaces/FilesCommentsDeleteArguments.md) @@ -251,12 +276,14 @@ - [IMCreatedEvent](interfaces/IMCreatedEvent.md) - [IMHistoryChangedEvent](interfaces/IMHistoryChangedEvent.md) - [IMOpenEvent](interfaces/IMOpenEvent.md) +- [IncidentEntityFields](interfaces/IncidentEntityFields.md) - [InputBlock](interfaces/InputBlock.md) - [InviteRequestedEvent](interfaces/InviteRequestedEvent.md) - [LinkSharedEvent](interfaces/LinkSharedEvent.md) - [LinkUnfurls](interfaces/LinkUnfurls.md) - [Logger](interfaces/Logger.md) - [MarkdownBlock](interfaces/MarkdownBlock.md) +- [MarkdownTextChunk](interfaces/MarkdownTextChunk.md) - [MaxItemsSelectable](interfaces/MaxItemsSelectable.md) - [MemberJoinedChannelEvent](interfaces/MemberJoinedChannelEvent.md) - [MemberLeftChannelEvent](interfaces/MemberLeftChannelEvent.md) @@ -296,7 +323,10 @@ - [PlainTextElement](interfaces/PlainTextElement.md) - [PlainTextInput](interfaces/PlainTextInput.md) - [PlainTextOption](interfaces/PlainTextOption.md) +- [PlanBlock](interfaces/PlanBlock.md) +- [PlanUpdateChunk](interfaces/PlanUpdateChunk.md) - [RadioButtons](interfaces/RadioButtons.md) +- [RawTextElement](interfaces/RawTextElement.md) - [ReactionAddedEvent](interfaces/ReactionAddedEvent.md) - [ReactionRemovedEvent](interfaces/ReactionRemovedEvent.md) - [ReactionsAddArguments](interfaces/ReactionsAddArguments.md) @@ -355,6 +385,10 @@ - [SubteamSelfAddedEvent](interfaces/SubteamSelfAddedEvent.md) - [SubteamSelfRemovedEvent](interfaces/SubteamSelfRemovedEvent.md) - [SubteamUpdatedEvent](interfaces/SubteamUpdatedEvent.md) +- [TableBlock](interfaces/TableBlock.md) +- [TaskCardBlock](interfaces/TaskCardBlock.md) +- [TaskEntityFields](interfaces/TaskEntityFields.md) +- [TaskUpdateChunk](interfaces/TaskUpdateChunk.md) - [TeamAccessGrantedEvent](interfaces/TeamAccessGrantedEvent.md) - [TeamAccessRevokedEvent](interfaces/TeamAccessRevokedEvent.md) - [TeamDomainChangeEvent](interfaces/TeamDomainChangeEvent.md) @@ -367,6 +401,7 @@ - [UrlImageObject](interfaces/UrlImageObject.md) - [URLInput](interfaces/URLInput.md) - [URLRespondable](interfaces/URLRespondable.md) +- [URLSourceElement](interfaces/URLSourceElement.md) - [UserChangeEvent](interfaces/UserChangeEvent.md) - [UsergroupsCreateArguments](interfaces/UsergroupsCreateArguments.md) - [UsergroupsDisableArguments](interfaces/UsergroupsDisableArguments.md) @@ -537,6 +572,7 @@ - [AllMessageEvents](type-aliases/AllMessageEvents.md) - [AllMessageMetadataEvents](type-aliases/AllMessageMetadataEvents.md) - [AnyBlock](type-aliases/AnyBlock.md) +- [AnyChunk](type-aliases/AnyChunk.md) - [APITestArguments](type-aliases/APITestArguments.md) - [ApiTestResponse](type-aliases/ApiTestResponse.md) - [AppsConnectionsOpenArguments](type-aliases/AppsConnectionsOpenArguments.md) @@ -554,6 +590,7 @@ - [AppsPermissionsUsersListResponse](type-aliases/AppsPermissionsUsersListResponse.md) - [AppsPermissionsUsersRequestResponse](type-aliases/AppsPermissionsUsersRequestResponse.md) - [AppsUninstallResponse](type-aliases/AppsUninstallResponse.md) +- [AppsUserConnectionUpdateResponse](type-aliases/AppsUserConnectionUpdateResponse.md) - [AssistantThreadsSetStatusResponse](type-aliases/AssistantThreadsSetStatusResponse.md) - [AssistantThreadsSetSuggestedPromptsResponse](type-aliases/AssistantThreadsSetSuggestedPromptsResponse.md) - [AssistantThreadsSetTitleResponse](type-aliases/AssistantThreadsSetTitleResponse.md) diff --git a/docs/english/reference/web-api/interfaces/Action.md b/docs/english/reference/web-api/interfaces/Action.md index 2b4311065..c957bce64 100644 --- a/docs/english/reference/web-api/interfaces/Action.md +++ b/docs/english/reference/web-api/interfaces/Action.md @@ -2,7 +2,7 @@ # ~~Interface: Action~~ -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:5 +Defined in: packages/types/dist/block-kit/extensions.d.ts:5 ## Deprecated @@ -20,7 +20,7 @@ Action aliased to [Actionable](Actionable.md) in order to name the mixins in thi optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -34,4 +34,4 @@ among all other `action_id`s in the containing block. Maximum length for this fi type: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:6 +Defined in: packages/types/dist/block-kit/extensions.d.ts:6 diff --git a/docs/english/reference/web-api/interfaces/Actionable.md b/docs/english/reference/web-api/interfaces/Actionable.md index 6cdcb9e7a..34425baf4 100644 --- a/docs/english/reference/web-api/interfaces/Actionable.md +++ b/docs/english/reference/web-api/interfaces/Actionable.md @@ -2,7 +2,7 @@ # ~~Interface: Actionable~~ -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:14 +Defined in: packages/types/dist/block-kit/extensions.d.ts:14 ## Deprecated @@ -48,7 +48,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extension optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -66,7 +66,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi type: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:6 +Defined in: packages/types/dist/block-kit/extensions.d.ts:6 #### Inherited from diff --git a/docs/english/reference/web-api/interfaces/ActionsBlock.md b/docs/english/reference/web-api/interfaces/ActionsBlock.md index 8a3fa4790..a0035bf1b 100644 --- a/docs/english/reference/web-api/interfaces/ActionsBlock.md +++ b/docs/english/reference/web-api/interfaces/ActionsBlock.md @@ -2,7 +2,7 @@ # Interface: ActionsBlock -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:36 +Defined in: packages/types/dist/block-kit/blocks.d.ts:36 ## Description @@ -24,7 +24,7 @@ Holds multiple interactive elements. optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. elements: ActionsBlockElement[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:45 +Defined in: packages/types/dist/block-kit/blocks.d.ts:45 #### Description @@ -61,7 +61,7 @@ There is a maximum of 25 elements in each action block. type: "actions"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:40 +Defined in: packages/types/dist/block-kit/blocks.d.ts:40 #### Description diff --git a/docs/english/reference/web-api/interfaces/AppDeletedEvent.md b/docs/english/reference/web-api/interfaces/AppDeletedEvent.md index 02b5bc432..7feed8a77 100644 --- a/docs/english/reference/web-api/interfaces/AppDeletedEvent.md +++ b/docs/english/reference/web-api/interfaces/AppDeletedEvent.md @@ -2,7 +2,7 @@ # Interface: AppDeletedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:83 +Defined in: packages/types/dist/events/app.d.ts:83 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:83 app_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:85 +Defined in: packages/types/dist/events/app.d.ts:85 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:85 app_name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:86 +Defined in: packages/types/dist/events/app.d.ts:86 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:86 app_owner_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:87 +Defined in: packages/types/dist/events/app.d.ts:87 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:87 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:90 +Defined in: packages/types/dist/events/app.d.ts:90 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:90 team_domain: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:89 +Defined in: packages/types/dist/events/app.d.ts:89 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:89 team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:88 +Defined in: packages/types/dist/events/app.d.ts:88 *** @@ -72,4 +72,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:88 type: "app_deleted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:84 +Defined in: packages/types/dist/events/app.d.ts:84 diff --git a/docs/english/reference/web-api/interfaces/AppHomeOpenedEvent.md b/docs/english/reference/web-api/interfaces/AppHomeOpenedEvent.md index 521cadfdc..800e6c53f 100644 --- a/docs/english/reference/web-api/interfaces/AppHomeOpenedEvent.md +++ b/docs/english/reference/web-api/interfaces/AppHomeOpenedEvent.md @@ -2,7 +2,7 @@ # Interface: AppHomeOpenedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:65 +Defined in: packages/types/dist/events/app.d.ts:65 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:65 channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:68 +Defined in: packages/types/dist/events/app.d.ts:68 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:68 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:71 +Defined in: packages/types/dist/events/app.d.ts:71 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:71 optional tab: "home" | "messages"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:69 +Defined in: packages/types/dist/events/app.d.ts:69 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:69 type: "app_home_opened"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:66 +Defined in: packages/types/dist/events/app.d.ts:66 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:66 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:67 +Defined in: packages/types/dist/events/app.d.ts:67 *** @@ -62,4 +62,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:67 optional view: View; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:70 +Defined in: packages/types/dist/events/app.d.ts:70 diff --git a/docs/english/reference/web-api/interfaces/AppInstalledEvent.md b/docs/english/reference/web-api/interfaces/AppInstalledEvent.md index cd204575b..81373c774 100644 --- a/docs/english/reference/web-api/interfaces/AppInstalledEvent.md +++ b/docs/english/reference/web-api/interfaces/AppInstalledEvent.md @@ -2,7 +2,7 @@ # Interface: AppInstalledEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:73 +Defined in: packages/types/dist/events/app.d.ts:73 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:73 app_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:75 +Defined in: packages/types/dist/events/app.d.ts:75 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:75 app_name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:76 +Defined in: packages/types/dist/events/app.d.ts:76 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:76 app_owner_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:77 +Defined in: packages/types/dist/events/app.d.ts:77 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:77 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:81 +Defined in: packages/types/dist/events/app.d.ts:81 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:81 team_domain: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:80 +Defined in: packages/types/dist/events/app.d.ts:80 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:80 team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:79 +Defined in: packages/types/dist/events/app.d.ts:79 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:79 type: "app_installed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:74 +Defined in: packages/types/dist/events/app.d.ts:74 *** @@ -82,4 +82,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:74 user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:78 +Defined in: packages/types/dist/events/app.d.ts:78 diff --git a/docs/english/reference/web-api/interfaces/AppMentionEvent.md b/docs/english/reference/web-api/interfaces/AppMentionEvent.md index 2bf485ada..f547da39d 100644 --- a/docs/english/reference/web-api/interfaces/AppMentionEvent.md +++ b/docs/english/reference/web-api/interfaces/AppMentionEvent.md @@ -2,7 +2,7 @@ # Interface: AppMentionEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:102 +Defined in: packages/types/dist/events/app.d.ts:102 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:102 optional attachments: MessageAttachment[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:124 +Defined in: packages/types/dist/events/app.d.ts:124 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:124 optional blocks: (Block | KnownBlock)[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:125 +Defined in: packages/types/dist/events/app.d.ts:125 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:125 optional bot_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:105 +Defined in: packages/types/dist/events/app.d.ts:105 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:105 optional bot_profile: BotProfile; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:106 +Defined in: packages/types/dist/events/app.d.ts:106 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:106 channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:136 +Defined in: packages/types/dist/events/app.d.ts:189 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:136 optional client_msg_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:139 +Defined in: packages/types/dist/events/app.d.ts:192 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:139 optional display_as_bot: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:130 +Defined in: packages/types/dist/events/app.d.ts:183 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:130 optional edited: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:131 +Defined in: packages/types/dist/events/app.d.ts:184 #### ts @@ -104,7 +104,7 @@ user: string; event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:137 +Defined in: packages/types/dist/events/app.d.ts:190 *** @@ -114,7 +114,49 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:137 optional files: object[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:126 +Defined in: packages/types/dist/events/app.d.ts:126 + +#### created + +```ts +created: number; +``` + +#### display\_as\_bot + +```ts +display_as_bot: boolean; +``` + +#### editable + +```ts +editable: boolean; +``` + +#### external\_type + +```ts +external_type: string; +``` + +#### file\_access + +```ts +file_access: string; +``` + +#### filetype + +```ts +filetype: string; +``` + +#### has\_rich\_preview + +```ts +has_rich_preview: boolean; +``` #### id @@ -122,6 +164,282 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:126 id: string; ``` +#### is\_external + +```ts +is_external: boolean; +``` + +#### is\_public + +```ts +is_public: boolean; +``` + +#### is\_starred + +```ts +is_starred: boolean; +``` + +#### media\_display\_type + +```ts +media_display_type: string; +``` + +#### mimetype + +```ts +mimetype: string; +``` + +#### mode + +```ts +mode: string; +``` + +#### name + +```ts +name: string; +``` + +#### original\_h? + +```ts +optional original_h: number; +``` + +#### original\_w? + +```ts +optional original_w: number; +``` + +#### permalink + +```ts +permalink: string; +``` + +#### permalink\_public + +```ts +permalink_public: string; +``` + +#### pretty\_type + +```ts +pretty_type: string; +``` + +#### public\_url\_shared + +```ts +public_url_shared: boolean; +``` + +#### size + +```ts +size: number; +``` + +#### thumb\_1024? + +```ts +optional thumb_1024: string; +``` + +#### thumb\_1024\_h? + +```ts +optional thumb_1024_h: number; +``` + +#### thumb\_1024\_w? + +```ts +optional thumb_1024_w: number; +``` + +#### thumb\_160? + +```ts +optional thumb_160: string; +``` + +#### thumb\_360? + +```ts +optional thumb_360: string; +``` + +#### thumb\_360\_h? + +```ts +optional thumb_360_h: number; +``` + +#### thumb\_360\_w? + +```ts +optional thumb_360_w: number; +``` + +#### thumb\_480? + +```ts +optional thumb_480: string; +``` + +#### thumb\_480\_h? + +```ts +optional thumb_480_h: number; +``` + +#### thumb\_480\_w? + +```ts +optional thumb_480_w: number; +``` + +#### thumb\_64? + +```ts +optional thumb_64: string; +``` + +#### thumb\_720? + +```ts +optional thumb_720: string; +``` + +#### thumb\_720\_h? + +```ts +optional thumb_720_h: number; +``` + +#### thumb\_720\_w? + +```ts +optional thumb_720_w: number; +``` + +#### thumb\_80? + +```ts +optional thumb_80: string; +``` + +#### thumb\_800? + +```ts +optional thumb_800: string; +``` + +#### thumb\_800\_h? + +```ts +optional thumb_800_h: number; +``` + +#### thumb\_800\_w? + +```ts +optional thumb_800_w: number; +``` + +#### thumb\_960? + +```ts +optional thumb_960: string; +``` + +#### thumb\_960\_h? + +```ts +optional thumb_960_h: number; +``` + +#### thumb\_960\_w? + +```ts +optional thumb_960_w: number; +``` + +#### thumb\_pdf? + +```ts +optional thumb_pdf: string; +``` + +#### thumb\_pdf\_h? + +```ts +optional thumb_pdf_h: number; +``` + +#### thumb\_pdf\_w? + +```ts +optional thumb_pdf_w: number; +``` + +#### thumb\_tiny? + +```ts +optional thumb_tiny: string; +``` + +#### timestamp + +```ts +timestamp: number; +``` + +#### title + +```ts +title: string; +``` + +#### url\_private + +```ts +url_private: string; +``` + +#### url\_private\_download + +```ts +url_private_download: string; +``` + +#### user + +```ts +user: string; +``` + +#### user\_team + +```ts +user_team: string; +``` + +#### username + +```ts +username: string; +``` + *** ### source\_team? @@ -130,7 +448,7 @@ id: string; optional source_team: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:110 +Defined in: packages/types/dist/events/app.d.ts:110 *** @@ -140,7 +458,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:110 optional subtype: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:104 +Defined in: packages/types/dist/events/app.d.ts:104 *** @@ -150,7 +468,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:104 optional team: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:108 +Defined in: packages/types/dist/events/app.d.ts:108 *** @@ -160,7 +478,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:108 text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:123 +Defined in: packages/types/dist/events/app.d.ts:123 *** @@ -170,7 +488,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:123 optional thread_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:138 +Defined in: packages/types/dist/events/app.d.ts:191 *** @@ -180,7 +498,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:138 ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:135 +Defined in: packages/types/dist/events/app.d.ts:188 *** @@ -190,7 +508,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:135 type: "app_mention"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:103 +Defined in: packages/types/dist/events/app.d.ts:103 *** @@ -200,7 +518,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:103 optional upload: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:129 +Defined in: packages/types/dist/events/app.d.ts:182 *** @@ -210,7 +528,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:129 optional user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:122 +Defined in: packages/types/dist/events/app.d.ts:122 *** @@ -220,7 +538,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:122 optional user_profile: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:111 +Defined in: packages/types/dist/events/app.d.ts:111 #### avatar\_hash? @@ -284,7 +602,7 @@ team: string; optional user_team: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:109 +Defined in: packages/types/dist/events/app.d.ts:109 *** @@ -294,4 +612,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:109 optional username: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:107 +Defined in: packages/types/dist/events/app.d.ts:107 diff --git a/docs/english/reference/web-api/interfaces/AppRateLimitedEvent.md b/docs/english/reference/web-api/interfaces/AppRateLimitedEvent.md index 61ef647f0..d12fcba0b 100644 --- a/docs/english/reference/web-api/interfaces/AppRateLimitedEvent.md +++ b/docs/english/reference/web-api/interfaces/AppRateLimitedEvent.md @@ -2,7 +2,7 @@ # Interface: AppRateLimitedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:141 +Defined in: packages/types/dist/events/app.d.ts:194 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:141 api_app_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:146 +Defined in: packages/types/dist/events/app.d.ts:199 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:146 minute_rate_limited: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:145 +Defined in: packages/types/dist/events/app.d.ts:198 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:145 team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:144 +Defined in: packages/types/dist/events/app.d.ts:197 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:144 token: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:143 +Defined in: packages/types/dist/events/app.d.ts:196 *** @@ -52,4 +52,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:143 type: "app_rate_limited"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:142 +Defined in: packages/types/dist/events/app.d.ts:195 diff --git a/docs/english/reference/web-api/interfaces/AppRequestedEvent.md b/docs/english/reference/web-api/interfaces/AppRequestedEvent.md index cb121d2da..8fd2657c0 100644 --- a/docs/english/reference/web-api/interfaces/AppRequestedEvent.md +++ b/docs/english/reference/web-api/interfaces/AppRequestedEvent.md @@ -2,7 +2,7 @@ # Interface: AppRequestedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:5 +Defined in: packages/types/dist/events/app.d.ts:5 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:5 app_request: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:7 +Defined in: packages/types/dist/events/app.d.ts:7 #### app @@ -172,7 +172,7 @@ id: string; date_created: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:63 +Defined in: packages/types/dist/events/app.d.ts:63 *** @@ -182,7 +182,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:63 is_user_app_collaborator: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:45 +Defined in: packages/types/dist/events/app.d.ts:45 *** @@ -192,7 +192,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:45 message: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:62 +Defined in: packages/types/dist/events/app.d.ts:62 *** @@ -212,7 +212,7 @@ previous_resolution: | null; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:36 +Defined in: packages/types/dist/events/app.d.ts:36 *** @@ -222,7 +222,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:36 scopes: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:56 +Defined in: packages/types/dist/events/app.d.ts:56 #### description @@ -256,7 +256,7 @@ token_type: "user" | "bot" | "app" | null; team: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:51 +Defined in: packages/types/dist/events/app.d.ts:51 #### domain @@ -284,7 +284,7 @@ name: string; type: "app_requested"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:6 +Defined in: packages/types/dist/events/app.d.ts:6 *** @@ -294,7 +294,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:6 user: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:46 +Defined in: packages/types/dist/events/app.d.ts:46 #### email diff --git a/docs/english/reference/web-api/interfaces/AppUninstalledEvent.md b/docs/english/reference/web-api/interfaces/AppUninstalledEvent.md index 048b39d1d..0bff16761 100644 --- a/docs/english/reference/web-api/interfaces/AppUninstalledEvent.md +++ b/docs/english/reference/web-api/interfaces/AppUninstalledEvent.md @@ -2,7 +2,7 @@ # Interface: AppUninstalledEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:148 +Defined in: packages/types/dist/events/app.d.ts:201 ## Properties @@ -12,4 +12,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:148 type: "app_uninstalled"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:149 +Defined in: packages/types/dist/events/app.d.ts:202 diff --git a/docs/english/reference/web-api/interfaces/AppUninstalledTeamEvent.md b/docs/english/reference/web-api/interfaces/AppUninstalledTeamEvent.md index 5313e2a8d..494769ffb 100644 --- a/docs/english/reference/web-api/interfaces/AppUninstalledTeamEvent.md +++ b/docs/english/reference/web-api/interfaces/AppUninstalledTeamEvent.md @@ -2,7 +2,7 @@ # Interface: AppUninstalledTeamEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:92 +Defined in: packages/types/dist/events/app.d.ts:92 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:92 app_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:94 +Defined in: packages/types/dist/events/app.d.ts:94 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:94 app_name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:95 +Defined in: packages/types/dist/events/app.d.ts:95 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:95 app_owner_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:96 +Defined in: packages/types/dist/events/app.d.ts:96 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:96 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:100 +Defined in: packages/types/dist/events/app.d.ts:100 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:100 team_domain: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:98 +Defined in: packages/types/dist/events/app.d.ts:98 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:98 team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:97 +Defined in: packages/types/dist/events/app.d.ts:97 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:97 type: "app_uninstalled_team"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:93 +Defined in: packages/types/dist/events/app.d.ts:93 *** @@ -82,4 +82,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:93 user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/app.d.ts:99 +Defined in: packages/types/dist/events/app.d.ts:99 diff --git a/docs/english/reference/web-api/interfaces/AppsUninstallArguments.md b/docs/english/reference/web-api/interfaces/AppsUninstallArguments.md index 7181146c4..d587e41d2 100644 --- a/docs/english/reference/web-api/interfaces/AppsUninstallArguments.md +++ b/docs/english/reference/web-api/interfaces/AppsUninstallArguments.md @@ -2,7 +2,7 @@ # Interface: AppsUninstallArguments -Defined in: [packages/web-api/src/types/request/apps.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L36) +Defined in: [packages/web-api/src/types/request/apps.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L44) ## Extends diff --git a/docs/english/reference/web-api/interfaces/AppsUserConnectionUpdateArguments.md b/docs/english/reference/web-api/interfaces/AppsUserConnectionUpdateArguments.md new file mode 100644 index 000000000..1f05bc36f --- /dev/null +++ b/docs/english/reference/web-api/interfaces/AppsUserConnectionUpdateArguments.md @@ -0,0 +1,57 @@ +[@slack/web-api](../index.md) / AppsUserConnectionUpdateArguments + +# Interface: AppsUserConnectionUpdateArguments + +Defined in: [packages/web-api/src/types/request/apps.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L36) + +## Extends + +- `TokenOverridable` + +## Properties + +### status + +```ts +status: string; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L40) + +#### Description + +The connection status value to assign to the user. `connected` or `disconnected`. + +*** + +### token? + +```ts +optional token: string; +``` + +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) + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +```ts +TokenOverridable.token +``` + +*** + +### user\_id + +```ts +user_id: string; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L38) + +#### Description + +The identifier for the user receiving the status update. diff --git a/docs/english/reference/web-api/interfaces/AssistantThreadContextChangedEvent.md b/docs/english/reference/web-api/interfaces/AssistantThreadContextChangedEvent.md index d1815cfca..b8dded447 100644 --- a/docs/english/reference/web-api/interfaces/AssistantThreadContextChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/AssistantThreadContextChangedEvent.md @@ -2,7 +2,7 @@ # Interface: AssistantThreadContextChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d.ts:15 +Defined in: packages/types/dist/events/assistant.d.ts:15 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d. assistant_thread: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d.ts:17 +Defined in: packages/types/dist/events/assistant.d.ts:17 #### channel\_id @@ -64,7 +64,7 @@ user_id: string; event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d.ts:27 +Defined in: packages/types/dist/events/assistant.d.ts:27 *** @@ -74,4 +74,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d. type: "assistant_thread_context_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d.ts:16 +Defined in: packages/types/dist/events/assistant.d.ts:16 diff --git a/docs/english/reference/web-api/interfaces/AssistantThreadStartedEvent.md b/docs/english/reference/web-api/interfaces/AssistantThreadStartedEvent.md index 92b4119dc..b9a246e0d 100644 --- a/docs/english/reference/web-api/interfaces/AssistantThreadStartedEvent.md +++ b/docs/english/reference/web-api/interfaces/AssistantThreadStartedEvent.md @@ -2,7 +2,7 @@ # Interface: AssistantThreadStartedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d.ts:1 +Defined in: packages/types/dist/events/assistant.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d. assistant_thread: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d.ts:3 +Defined in: packages/types/dist/events/assistant.d.ts:3 #### channel\_id @@ -64,7 +64,7 @@ user_id: string; event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d.ts:13 +Defined in: packages/types/dist/events/assistant.d.ts:13 *** @@ -74,4 +74,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d. type: "assistant_thread_started"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/assistant.d.ts:2 +Defined in: packages/types/dist/events/assistant.d.ts:2 diff --git a/docs/english/reference/web-api/interfaces/Block.md b/docs/english/reference/web-api/interfaces/Block.md index e3d3dc281..f565c28a0 100644 --- a/docs/english/reference/web-api/interfaces/Block.md +++ b/docs/english/reference/web-api/interfaces/Block.md @@ -2,7 +2,7 @@ # Interface: Block -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:3 +Defined in: packages/types/dist/block-kit/blocks.d.ts:3 ## Extended by @@ -16,6 +16,9 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d. - [`MarkdownBlock`](MarkdownBlock.md) - [`RichTextBlock`](RichTextBlock.md) - [`SectionBlock`](SectionBlock.md) +- [`TableBlock`](TableBlock.md) +- [`TaskCardBlock`](TaskCardBlock.md) +- [`PlanBlock`](PlanBlock.md) - [`VideoBlock`](VideoBlock.md) ## Properties @@ -26,7 +29,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d. optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -44,7 +47,7 @@ a message. If a message is updated, use a new `block_id`. type: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:7 +Defined in: packages/types/dist/block-kit/blocks.d.ts:7 #### Description diff --git a/docs/english/reference/web-api/interfaces/BotMessageEvent.md b/docs/english/reference/web-api/interfaces/BotMessageEvent.md index 0f7b22832..e7c7b71d4 100644 --- a/docs/english/reference/web-api/interfaces/BotMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/BotMessageEvent.md @@ -2,7 +2,7 @@ # Interface: BotMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:38 +Defined in: packages/types/dist/events/message.d.ts:38 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional attachments: MessageAttachment[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:53 +Defined in: packages/types/dist/events/message.d.ts:53 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional blocks: (Block | KnownBlock)[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:54 +Defined in: packages/types/dist/events/message.d.ts:54 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts bot_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:47 +Defined in: packages/types/dist/events/message.d.ts:47 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:42 +Defined in: packages/types/dist/events/message.d.ts:42 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:43 +Defined in: packages/types/dist/events/message.d.ts:43 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional edited: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:55 +Defined in: packages/types/dist/events/message.d.ts:55 #### ts @@ -84,7 +84,7 @@ user: string; event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:41 +Defined in: packages/types/dist/events/message.d.ts:41 *** @@ -94,7 +94,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional icons: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:49 +Defined in: packages/types/dist/events/message.d.ts:49 #### Index Signature @@ -110,7 +110,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional streaming_state: "in_progress" | "completed" | "errored"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:44 +Defined in: packages/types/dist/events/message.d.ts:44 *** @@ -120,7 +120,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "bot_message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:40 +Defined in: packages/types/dist/events/message.d.ts:40 *** @@ -130,7 +130,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:46 +Defined in: packages/types/dist/events/message.d.ts:46 *** @@ -140,7 +140,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional thread_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:59 +Defined in: packages/types/dist/events/message.d.ts:59 *** @@ -150,7 +150,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:45 +Defined in: packages/types/dist/events/message.d.ts:45 *** @@ -160,7 +160,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:39 +Defined in: packages/types/dist/events/message.d.ts:39 *** @@ -170,7 +170,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:52 +Defined in: packages/types/dist/events/message.d.ts:52 *** @@ -180,4 +180,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional username: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:48 +Defined in: packages/types/dist/events/message.d.ts:48 diff --git a/docs/english/reference/web-api/interfaces/Button.md b/docs/english/reference/web-api/interfaces/Button.md index 228758084..822e93f1e 100644 --- a/docs/english/reference/web-api/interfaces/Button.md +++ b/docs/english/reference/web-api/interfaces/Button.md @@ -2,7 +2,7 @@ # Interface: Button -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:9 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:9 ## Description @@ -25,7 +25,7 @@ Allows users a direct path to performing basic actions. optional accessibility_label: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:43 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:43 #### Description @@ -40,7 +40,7 @@ readers instead of the button `text` object. Maximum length for this field is 75 optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -58,7 +58,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -77,7 +77,7 @@ with. optional style: ColorScheme; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:38 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:38 #### Description @@ -96,7 +96,7 @@ If you don't include this field, the default button style will be used. text: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:18 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:18 #### Description @@ -111,7 +111,7 @@ Maximum length for the text in this field is 75 characters. type: "button"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:13 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:13 #### Description @@ -129,7 +129,7 @@ The type of element. In this case `type` is always `button`. optional url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:29 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:29 #### Description @@ -145,7 +145,7 @@ and will need to send an [acknowledgement response](https://docs.slack.dev/inter optional value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:23 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:23 #### Description diff --git a/docs/english/reference/web-api/interfaces/CallRejectedEvent.md b/docs/english/reference/web-api/interfaces/CallRejectedEvent.md index 4857b0e80..baed7ef2f 100644 --- a/docs/english/reference/web-api/interfaces/CallRejectedEvent.md +++ b/docs/english/reference/web-api/interfaces/CallRejectedEvent.md @@ -2,7 +2,7 @@ # Interface: CallRejectedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/call.d.ts:1 +Defined in: packages/types/dist/events/call.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/call.d.ts:1 call_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/call.d.ts:3 +Defined in: packages/types/dist/events/call.d.ts:3 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/call.d.ts:3 channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/call.d.ts:5 +Defined in: packages/types/dist/events/call.d.ts:5 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/call.d.ts:5 external_unique_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/call.d.ts:6 +Defined in: packages/types/dist/events/call.d.ts:6 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/call.d.ts:6 type: "call_rejected"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/call.d.ts:2 +Defined in: packages/types/dist/events/call.d.ts:2 *** @@ -52,4 +52,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/call.d.ts:2 user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/call.d.ts:4 +Defined in: packages/types/dist/events/call.d.ts:4 diff --git a/docs/english/reference/web-api/interfaces/CallUserExternal.md b/docs/english/reference/web-api/interfaces/CallUserExternal.md index 3907855de..c5677cc0b 100644 --- a/docs/english/reference/web-api/interfaces/CallUserExternal.md +++ b/docs/english/reference/web-api/interfaces/CallUserExternal.md @@ -2,7 +2,7 @@ # Interface: CallUserExternal -Defined in: packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:12 +Defined in: packages/types/dist/calls.d.ts:12 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:12 optional avatar_url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:24 +Defined in: packages/types/dist/calls.d.ts:24 #### Description @@ -26,7 +26,7 @@ URL to an avatar image of the user. display_name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:20 +Defined in: packages/types/dist/calls.d.ts:20 #### Description @@ -40,7 +40,7 @@ Name of the user to be displayed in the Call block in a message. external_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:16 +Defined in: packages/types/dist/calls.d.ts:16 #### Description diff --git a/docs/english/reference/web-api/interfaces/CallUserSlack.md b/docs/english/reference/web-api/interfaces/CallUserSlack.md index 4a4f6b08f..ecbe0d6cd 100644 --- a/docs/english/reference/web-api/interfaces/CallUserSlack.md +++ b/docs/english/reference/web-api/interfaces/CallUserSlack.md @@ -2,7 +2,7 @@ # Interface: CallUserSlack -Defined in: packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:5 +Defined in: packages/types/dist/calls.d.ts:5 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:5 slack_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:10 +Defined in: packages/types/dist/calls.d.ts:10 #### Description diff --git a/docs/english/reference/web-api/interfaces/CanvasesDeleteArguments.md b/docs/english/reference/web-api/interfaces/CanvasesDeleteArguments.md index ffed8a277..5583a798e 100644 --- a/docs/english/reference/web-api/interfaces/CanvasesDeleteArguments.md +++ b/docs/english/reference/web-api/interfaces/CanvasesDeleteArguments.md @@ -2,7 +2,7 @@ # Interface: CanvasesDeleteArguments -Defined in: [packages/web-api/src/types/request/canvas.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L83) +Defined in: [packages/web-api/src/types/request/canvas.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L84) ## Extends diff --git a/docs/english/reference/web-api/interfaces/CanvasesEditArguments.md b/docs/english/reference/web-api/interfaces/CanvasesEditArguments.md index 6de9c0882..31261cf8c 100644 --- a/docs/english/reference/web-api/interfaces/CanvasesEditArguments.md +++ b/docs/english/reference/web-api/interfaces/CanvasesEditArguments.md @@ -2,7 +2,7 @@ # Interface: CanvasesEditArguments -Defined in: [packages/web-api/src/types/request/canvas.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L86) +Defined in: [packages/web-api/src/types/request/canvas.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L87) ## Extends @@ -36,7 +36,7 @@ CanvasID.canvas_id changes: [Change, ...Change[]]; ``` -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) +Defined in: [packages/web-api/src/types/request/canvas.ts:89](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L89) #### Description diff --git a/docs/english/reference/web-api/interfaces/CanvasesSectionsLookupArguments.md b/docs/english/reference/web-api/interfaces/CanvasesSectionsLookupArguments.md index 13fdb1d8e..5ed63114e 100644 --- a/docs/english/reference/web-api/interfaces/CanvasesSectionsLookupArguments.md +++ b/docs/english/reference/web-api/interfaces/CanvasesSectionsLookupArguments.md @@ -2,7 +2,7 @@ # Interface: CanvasesSectionsLookupArguments -Defined in: [packages/web-api/src/types/request/canvas.ts:77](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L77) +Defined in: [packages/web-api/src/types/request/canvas.ts:78](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L78) ## Extends @@ -36,7 +36,7 @@ CanvasID.canvas_id criteria: Criteria; ``` -Defined in: [packages/web-api/src/types/request/canvas.ts:79](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L79) +Defined in: [packages/web-api/src/types/request/canvas.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L80) #### Description diff --git a/docs/english/reference/web-api/interfaces/ChannelArchiveEvent.md b/docs/english/reference/web-api/interfaces/ChannelArchiveEvent.md index 9be2c914f..45c2111db 100644 --- a/docs/english/reference/web-api/interfaces/ChannelArchiveEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelArchiveEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelArchiveEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:1 +Defined in: packages/types/dist/events/channel.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:3 +Defined in: packages/types/dist/events/channel.d.ts:3 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:6 +Defined in: packages/types/dist/events/channel.d.ts:6 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts optional is_moved: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:5 +Defined in: packages/types/dist/events/channel.d.ts:5 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts type: "channel_archive"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:2 +Defined in: packages/types/dist/events/channel.d.ts:2 *** @@ -52,4 +52,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:4 +Defined in: packages/types/dist/events/channel.d.ts:4 diff --git a/docs/english/reference/web-api/interfaces/ChannelArchiveMessageEvent.md b/docs/english/reference/web-api/interfaces/ChannelArchiveMessageEvent.md index e1ef42272..b9784e5c7 100644 --- a/docs/english/reference/web-api/interfaces/ChannelArchiveMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelArchiveMessageEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelArchiveMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:61 +Defined in: packages/types/dist/events/message.d.ts:61 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:66 +Defined in: packages/types/dist/events/message.d.ts:66 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:67 +Defined in: packages/types/dist/events/message.d.ts:67 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:70 +Defined in: packages/types/dist/events/message.d.ts:70 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "channel_archive"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:63 +Defined in: packages/types/dist/events/message.d.ts:63 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts team: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:64 +Defined in: packages/types/dist/events/message.d.ts:64 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:68 +Defined in: packages/types/dist/events/message.d.ts:68 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:69 +Defined in: packages/types/dist/events/message.d.ts:69 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:62 +Defined in: packages/types/dist/events/message.d.ts:62 *** @@ -92,4 +92,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:65 +Defined in: packages/types/dist/events/message.d.ts:65 diff --git a/docs/english/reference/web-api/interfaces/ChannelCreatedEvent.md b/docs/english/reference/web-api/interfaces/ChannelCreatedEvent.md index 83b0e9b41..aa6d618e7 100644 --- a/docs/english/reference/web-api/interfaces/ChannelCreatedEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelCreatedEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelCreatedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:8 +Defined in: packages/types/dist/events/channel.d.ts:8 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts channel: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:11 +Defined in: packages/types/dist/events/channel.d.ts:11 #### context\_team\_id @@ -130,7 +130,7 @@ name_normalized: string; event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:10 +Defined in: packages/types/dist/events/channel.d.ts:10 *** @@ -140,4 +140,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts type: "channel_created"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:9 +Defined in: packages/types/dist/events/channel.d.ts:9 diff --git a/docs/english/reference/web-api/interfaces/ChannelDeletedEvent.md b/docs/english/reference/web-api/interfaces/ChannelDeletedEvent.md index e4313efe9..f9746a7a5 100644 --- a/docs/english/reference/web-api/interfaces/ChannelDeletedEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelDeletedEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelDeletedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:32 +Defined in: packages/types/dist/events/channel.d.ts:32 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:34 +Defined in: packages/types/dist/events/channel.d.ts:34 *** @@ -22,4 +22,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts type: "channel_deleted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:33 +Defined in: packages/types/dist/events/channel.d.ts:33 diff --git a/docs/english/reference/web-api/interfaces/ChannelHistoryChangedEvent.md b/docs/english/reference/web-api/interfaces/ChannelHistoryChangedEvent.md index 05d80703d..d65eefd28 100644 --- a/docs/english/reference/web-api/interfaces/ChannelHistoryChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelHistoryChangedEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelHistoryChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:36 +Defined in: packages/types/dist/events/channel.d.ts:36 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:40 +Defined in: packages/types/dist/events/channel.d.ts:40 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts latest: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:38 +Defined in: packages/types/dist/events/channel.d.ts:38 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:39 +Defined in: packages/types/dist/events/channel.d.ts:39 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts type: "channel_history_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:37 +Defined in: packages/types/dist/events/channel.d.ts:37 diff --git a/docs/english/reference/web-api/interfaces/ChannelIDChangedEvent.md b/docs/english/reference/web-api/interfaces/ChannelIDChangedEvent.md index 1570e504b..260c1e160 100644 --- a/docs/english/reference/web-api/interfaces/ChannelIDChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelIDChangedEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelIDChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:42 +Defined in: packages/types/dist/events/channel.d.ts:42 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:46 +Defined in: packages/types/dist/events/channel.d.ts:46 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts new_channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:45 +Defined in: packages/types/dist/events/channel.d.ts:45 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts old_channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:44 +Defined in: packages/types/dist/events/channel.d.ts:44 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts type: "channel_id_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:43 +Defined in: packages/types/dist/events/channel.d.ts:43 diff --git a/docs/english/reference/web-api/interfaces/ChannelJoinMessageEvent.md b/docs/english/reference/web-api/interfaces/ChannelJoinMessageEvent.md index 19075756e..a75f31ab8 100644 --- a/docs/english/reference/web-api/interfaces/ChannelJoinMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelJoinMessageEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelJoinMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:72 +Defined in: packages/types/dist/events/message.d.ts:72 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:78 +Defined in: packages/types/dist/events/message.d.ts:78 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:79 +Defined in: packages/types/dist/events/message.d.ts:79 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:82 +Defined in: packages/types/dist/events/message.d.ts:82 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts inviter: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:77 +Defined in: packages/types/dist/events/message.d.ts:77 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "channel_join"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:74 +Defined in: packages/types/dist/events/message.d.ts:74 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts team: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:75 +Defined in: packages/types/dist/events/message.d.ts:75 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:80 +Defined in: packages/types/dist/events/message.d.ts:80 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:81 +Defined in: packages/types/dist/events/message.d.ts:81 *** @@ -92,7 +92,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:73 +Defined in: packages/types/dist/events/message.d.ts:73 *** @@ -102,4 +102,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:76 +Defined in: packages/types/dist/events/message.d.ts:76 diff --git a/docs/english/reference/web-api/interfaces/ChannelLeaveMessageEvent.md b/docs/english/reference/web-api/interfaces/ChannelLeaveMessageEvent.md index e72c116df..e9f5dff37 100644 --- a/docs/english/reference/web-api/interfaces/ChannelLeaveMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelLeaveMessageEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelLeaveMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:84 +Defined in: packages/types/dist/events/message.d.ts:84 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:89 +Defined in: packages/types/dist/events/message.d.ts:89 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:90 +Defined in: packages/types/dist/events/message.d.ts:90 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:93 +Defined in: packages/types/dist/events/message.d.ts:93 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "channel_leave"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:86 +Defined in: packages/types/dist/events/message.d.ts:86 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts team: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:87 +Defined in: packages/types/dist/events/message.d.ts:87 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:91 +Defined in: packages/types/dist/events/message.d.ts:91 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:92 +Defined in: packages/types/dist/events/message.d.ts:92 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:85 +Defined in: packages/types/dist/events/message.d.ts:85 *** @@ -92,4 +92,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:88 +Defined in: packages/types/dist/events/message.d.ts:88 diff --git a/docs/english/reference/web-api/interfaces/ChannelLeftEvent.md b/docs/english/reference/web-api/interfaces/ChannelLeftEvent.md index 1db7baccd..767d99485 100644 --- a/docs/english/reference/web-api/interfaces/ChannelLeftEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelLeftEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelLeftEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:48 +Defined in: packages/types/dist/events/channel.d.ts:48 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts actor_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:51 +Defined in: packages/types/dist/events/channel.d.ts:51 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:50 +Defined in: packages/types/dist/events/channel.d.ts:50 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:52 +Defined in: packages/types/dist/events/channel.d.ts:52 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts type: "channel_left"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:49 +Defined in: packages/types/dist/events/channel.d.ts:49 diff --git a/docs/english/reference/web-api/interfaces/ChannelNameMessageEvent.md b/docs/english/reference/web-api/interfaces/ChannelNameMessageEvent.md index c1a5664d9..ca71c07e7 100644 --- a/docs/english/reference/web-api/interfaces/ChannelNameMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelNameMessageEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelNameMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:95 +Defined in: packages/types/dist/events/message.d.ts:95 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:102 +Defined in: packages/types/dist/events/message.d.ts:102 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:103 +Defined in: packages/types/dist/events/message.d.ts:103 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:106 +Defined in: packages/types/dist/events/message.d.ts:106 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:100 +Defined in: packages/types/dist/events/message.d.ts:100 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts old_name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:101 +Defined in: packages/types/dist/events/message.d.ts:101 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "channel_name"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:97 +Defined in: packages/types/dist/events/message.d.ts:97 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts team: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:98 +Defined in: packages/types/dist/events/message.d.ts:98 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:104 +Defined in: packages/types/dist/events/message.d.ts:104 *** @@ -92,7 +92,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:105 +Defined in: packages/types/dist/events/message.d.ts:105 *** @@ -102,7 +102,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:96 +Defined in: packages/types/dist/events/message.d.ts:96 *** @@ -112,4 +112,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:99 +Defined in: packages/types/dist/events/message.d.ts:99 diff --git a/docs/english/reference/web-api/interfaces/ChannelPostingPermissionsMessageEvent.md b/docs/english/reference/web-api/interfaces/ChannelPostingPermissionsMessageEvent.md index a68d21ff8..9fa9511b0 100644 --- a/docs/english/reference/web-api/interfaces/ChannelPostingPermissionsMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelPostingPermissionsMessageEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelPostingPermissionsMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:108 +Defined in: packages/types/dist/events/message.d.ts:108 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:112 +Defined in: packages/types/dist/events/message.d.ts:112 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:113 +Defined in: packages/types/dist/events/message.d.ts:113 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:116 +Defined in: packages/types/dist/events/message.d.ts:116 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "channel_posting_permissions"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:110 +Defined in: packages/types/dist/events/message.d.ts:110 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:114 +Defined in: packages/types/dist/events/message.d.ts:114 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:115 +Defined in: packages/types/dist/events/message.d.ts:115 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:109 +Defined in: packages/types/dist/events/message.d.ts:109 *** @@ -82,4 +82,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:111 +Defined in: packages/types/dist/events/message.d.ts:111 diff --git a/docs/english/reference/web-api/interfaces/ChannelPurposeMessageEvent.md b/docs/english/reference/web-api/interfaces/ChannelPurposeMessageEvent.md index 1965fdea3..f78864fc3 100644 --- a/docs/english/reference/web-api/interfaces/ChannelPurposeMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelPurposeMessageEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelPurposeMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:118 +Defined in: packages/types/dist/events/message.d.ts:118 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:122 +Defined in: packages/types/dist/events/message.d.ts:122 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:123 +Defined in: packages/types/dist/events/message.d.ts:123 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:127 +Defined in: packages/types/dist/events/message.d.ts:127 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts purpose: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:125 +Defined in: packages/types/dist/events/message.d.ts:125 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "channel_purpose"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:120 +Defined in: packages/types/dist/events/message.d.ts:120 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:124 +Defined in: packages/types/dist/events/message.d.ts:124 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:126 +Defined in: packages/types/dist/events/message.d.ts:126 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:119 +Defined in: packages/types/dist/events/message.d.ts:119 *** @@ -92,4 +92,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:121 +Defined in: packages/types/dist/events/message.d.ts:121 diff --git a/docs/english/reference/web-api/interfaces/ChannelRenameEvent.md b/docs/english/reference/web-api/interfaces/ChannelRenameEvent.md index ccabfba6a..6caa52243 100644 --- a/docs/english/reference/web-api/interfaces/ChannelRenameEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelRenameEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelRenameEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:54 +Defined in: packages/types/dist/events/channel.d.ts:54 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts channel: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:56 +Defined in: packages/types/dist/events/channel.d.ts:56 #### created @@ -58,7 +58,7 @@ name_normalized: string; event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:64 +Defined in: packages/types/dist/events/channel.d.ts:64 *** @@ -68,4 +68,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts type: "channel_rename"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:55 +Defined in: packages/types/dist/events/channel.d.ts:55 diff --git a/docs/english/reference/web-api/interfaces/ChannelSharedEvent.md b/docs/english/reference/web-api/interfaces/ChannelSharedEvent.md index ff69a9971..3571b7d34 100644 --- a/docs/english/reference/web-api/interfaces/ChannelSharedEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelSharedEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelSharedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:66 +Defined in: packages/types/dist/events/channel.d.ts:66 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:69 +Defined in: packages/types/dist/events/channel.d.ts:69 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts connected_team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:68 +Defined in: packages/types/dist/events/channel.d.ts:68 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:70 +Defined in: packages/types/dist/events/channel.d.ts:70 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts type: "channel_shared"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:67 +Defined in: packages/types/dist/events/channel.d.ts:67 diff --git a/docs/english/reference/web-api/interfaces/ChannelTopicMessageEvent.md b/docs/english/reference/web-api/interfaces/ChannelTopicMessageEvent.md index 2640fa565..82119fb4d 100644 --- a/docs/english/reference/web-api/interfaces/ChannelTopicMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelTopicMessageEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelTopicMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:129 +Defined in: packages/types/dist/events/message.d.ts:129 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:133 +Defined in: packages/types/dist/events/message.d.ts:133 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:134 +Defined in: packages/types/dist/events/message.d.ts:134 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:138 +Defined in: packages/types/dist/events/message.d.ts:138 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "channel_topic"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:131 +Defined in: packages/types/dist/events/message.d.ts:131 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:135 +Defined in: packages/types/dist/events/message.d.ts:135 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts topic: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:136 +Defined in: packages/types/dist/events/message.d.ts:136 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:137 +Defined in: packages/types/dist/events/message.d.ts:137 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:130 +Defined in: packages/types/dist/events/message.d.ts:130 *** @@ -92,4 +92,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:132 +Defined in: packages/types/dist/events/message.d.ts:132 diff --git a/docs/english/reference/web-api/interfaces/ChannelUnarchiveEvent.md b/docs/english/reference/web-api/interfaces/ChannelUnarchiveEvent.md index ae7701b55..470bee515 100644 --- a/docs/english/reference/web-api/interfaces/ChannelUnarchiveEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelUnarchiveEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelUnarchiveEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:72 +Defined in: packages/types/dist/events/channel.d.ts:72 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:74 +Defined in: packages/types/dist/events/channel.d.ts:74 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:76 +Defined in: packages/types/dist/events/channel.d.ts:76 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts type: "channel_unarchive"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:73 +Defined in: packages/types/dist/events/channel.d.ts:73 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:75 +Defined in: packages/types/dist/events/channel.d.ts:75 diff --git a/docs/english/reference/web-api/interfaces/ChannelUnarchiveMessageEvent.md b/docs/english/reference/web-api/interfaces/ChannelUnarchiveMessageEvent.md index 0a5a11412..49727fdea 100644 --- a/docs/english/reference/web-api/interfaces/ChannelUnarchiveMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelUnarchiveMessageEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelUnarchiveMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:140 +Defined in: packages/types/dist/events/message.d.ts:140 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:145 +Defined in: packages/types/dist/events/message.d.ts:145 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:146 +Defined in: packages/types/dist/events/message.d.ts:146 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:149 +Defined in: packages/types/dist/events/message.d.ts:149 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "channel_unarchive"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:142 +Defined in: packages/types/dist/events/message.d.ts:142 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts team: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:143 +Defined in: packages/types/dist/events/message.d.ts:143 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:147 +Defined in: packages/types/dist/events/message.d.ts:147 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:148 +Defined in: packages/types/dist/events/message.d.ts:148 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:141 +Defined in: packages/types/dist/events/message.d.ts:141 *** @@ -92,4 +92,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:144 +Defined in: packages/types/dist/events/message.d.ts:144 diff --git a/docs/english/reference/web-api/interfaces/ChannelUnsharedEvent.md b/docs/english/reference/web-api/interfaces/ChannelUnsharedEvent.md index 62708c3d8..905b45640 100644 --- a/docs/english/reference/web-api/interfaces/ChannelUnsharedEvent.md +++ b/docs/english/reference/web-api/interfaces/ChannelUnsharedEvent.md @@ -2,7 +2,7 @@ # Interface: ChannelUnsharedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:78 +Defined in: packages/types/dist/events/channel.d.ts:78 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:81 +Defined in: packages/types/dist/events/channel.d.ts:81 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:83 +Defined in: packages/types/dist/events/channel.d.ts:83 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts is_ext_shared: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:82 +Defined in: packages/types/dist/events/channel.d.ts:82 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts previously_connected_team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:80 +Defined in: packages/types/dist/events/channel.d.ts:80 *** @@ -52,4 +52,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts type: "channel_unshared"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/channel.d.ts:79 +Defined in: packages/types/dist/events/channel.d.ts:79 diff --git a/docs/english/reference/web-api/interfaces/ChannelsSelect.md b/docs/english/reference/web-api/interfaces/ChannelsSelect.md index f2bda81c8..81ea22559 100644 --- a/docs/english/reference/web-api/interfaces/ChannelsSelect.md +++ b/docs/english/reference/web-api/interfaces/ChannelsSelect.md @@ -2,7 +2,7 @@ # Interface: ChannelsSelect -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:408 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:412 ## Description @@ -26,7 +26,7 @@ in the active workspace. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -44,7 +44,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -63,7 +63,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:416 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:420 #### Description @@ -97,7 +97,7 @@ The ID of any valid public channel to be pre-selected when the menu loads. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -116,7 +116,7 @@ length for the `text` field in this object is 150 characters. optional response_url_enabled: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:58 +Defined in: packages/types/dist/block-kit/extensions.d.ts:58 #### Description @@ -137,7 +137,7 @@ for the message will be determined by the value of this select menu. type: "channels_select"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:412 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:416 #### Description diff --git a/docs/english/reference/web-api/interfaces/Checkboxes.md b/docs/english/reference/web-api/interfaces/Checkboxes.md index 0c60e2eca..31a5b7c36 100644 --- a/docs/english/reference/web-api/interfaces/Checkboxes.md +++ b/docs/english/reference/web-api/interfaces/Checkboxes.md @@ -2,7 +2,7 @@ # Interface: Checkboxes -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:50 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:50 ## Description @@ -25,7 +25,7 @@ Allows users to choose multiple items from a list of options. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -43,7 +43,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -62,7 +62,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_options: Option[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:59 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:59 #### Description @@ -97,7 +97,7 @@ These options will be selected when the checkbox group initially loads. options: Option[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:63 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:63 #### Description @@ -111,7 +111,7 @@ An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options type: "checkboxes"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:54 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:54 #### Description diff --git a/docs/english/reference/web-api/interfaces/Chunk.md b/docs/english/reference/web-api/interfaces/Chunk.md new file mode 100644 index 000000000..1168ec8ed --- /dev/null +++ b/docs/english/reference/web-api/interfaces/Chunk.md @@ -0,0 +1,24 @@ +[@slack/web-api](../index.md) / Chunk + +# Interface: Chunk + +Defined in: packages/types/dist/chunk.d.ts:6 + +Base interface for streaming message chunks. +https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming + +## Extended by + +- [`MarkdownTextChunk`](MarkdownTextChunk.md) +- [`PlanUpdateChunk`](PlanUpdateChunk.md) +- [`TaskUpdateChunk`](TaskUpdateChunk.md) + +## Properties + +### type + +```ts +type: string; +``` + +Defined in: packages/types/dist/chunk.d.ts:7 diff --git a/docs/english/reference/web-api/interfaces/CodedError.md b/docs/english/reference/web-api/interfaces/CodedError.md index c1eff3ce1..9c266b15e 100644 --- a/docs/english/reference/web-api/interfaces/CodedError.md +++ b/docs/english/reference/web-api/interfaces/CodedError.md @@ -41,7 +41,7 @@ NodeJS.ErrnoException.code optional errno: number; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:102 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -89,7 +89,7 @@ NodeJS.ErrnoException.name optional path: string; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:104 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -121,7 +121,7 @@ NodeJS.ErrnoException.stack optional syscall: string; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:105 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/web-api/interfaces/Confirm.md b/docs/english/reference/web-api/interfaces/Confirm.md index 19b68be43..2ddb0bf25 100644 --- a/docs/english/reference/web-api/interfaces/Confirm.md +++ b/docs/english/reference/web-api/interfaces/Confirm.md @@ -2,7 +2,7 @@ # ~~Interface: Confirm~~ -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:14 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:14 ## Deprecated @@ -29,7 +29,7 @@ Defines a dialog that adds a confirmation step to interactive elements. optional confirm: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:29 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:29 #### Description @@ -44,7 +44,7 @@ Maximum length for the `text` in this field is 30 characters. optional deny: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:34 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:34 #### Description @@ -59,7 +59,7 @@ Maximum length for the `text` in this field is 30 characters. optional style: ColorScheme; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:40 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:40 #### Description @@ -77,7 +77,7 @@ text: | MrkdwnElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:24 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:24 #### Description @@ -92,7 +92,7 @@ dialog. Maximum length for the `text` in this field is 300 characters. optional title: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:19 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:19 #### Description diff --git a/docs/english/reference/web-api/interfaces/Confirmable.md b/docs/english/reference/web-api/interfaces/Confirmable.md index 1a4a1c7b2..aa3ffe87e 100644 --- a/docs/english/reference/web-api/interfaces/Confirmable.md +++ b/docs/english/reference/web-api/interfaces/Confirmable.md @@ -2,7 +2,7 @@ # Interface: Confirmable -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:16 +Defined in: packages/types/dist/block-kit/extensions.d.ts:16 ## Extended by @@ -34,7 +34,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extension optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description diff --git a/docs/english/reference/web-api/interfaces/Confirmation.md b/docs/english/reference/web-api/interfaces/Confirmation.md index fd19dd92f..5c159043e 100644 --- a/docs/english/reference/web-api/interfaces/Confirmation.md +++ b/docs/english/reference/web-api/interfaces/Confirmation.md @@ -2,7 +2,7 @@ # Interface: Confirmation -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:161 +Defined in: packages/types/dist/message-attachments.d.ts:161 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments optional dismiss_text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:162 +Defined in: packages/types/dist/message-attachments.d.ts:162 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments optional ok_text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:163 +Defined in: packages/types/dist/message-attachments.d.ts:163 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:164 +Defined in: packages/types/dist/message-attachments.d.ts:164 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments optional title: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:165 +Defined in: packages/types/dist/message-attachments.d.ts:165 diff --git a/docs/english/reference/web-api/interfaces/ConfirmationDialog.md b/docs/english/reference/web-api/interfaces/ConfirmationDialog.md index 08df7557d..efd5265d8 100644 --- a/docs/english/reference/web-api/interfaces/ConfirmationDialog.md +++ b/docs/english/reference/web-api/interfaces/ConfirmationDialog.md @@ -2,7 +2,7 @@ # Interface: ConfirmationDialog -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:46 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:46 ## Description @@ -24,7 +24,7 @@ Defines a dialog that adds a confirmation step to interactive elements. optional confirm: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:29 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:29 #### Description @@ -43,7 +43,7 @@ Maximum length for the `text` in this field is 30 characters. optional deny: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:34 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:34 #### Description @@ -62,7 +62,7 @@ Maximum length for the `text` in this field is 30 characters. optional style: ColorScheme; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:40 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:40 #### Description @@ -84,7 +84,7 @@ text: | MrkdwnElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:24 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:24 #### Description @@ -103,7 +103,7 @@ dialog. Maximum length for the `text` in this field is 300 characters. optional title: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:19 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:19 #### Description diff --git a/docs/english/reference/web-api/interfaces/ContentItemEntityFields.md b/docs/english/reference/web-api/interfaces/ContentItemEntityFields.md new file mode 100644 index 000000000..8028db0cb --- /dev/null +++ b/docs/english/reference/web-api/interfaces/ContentItemEntityFields.md @@ -0,0 +1,65 @@ +[@slack/web-api](../index.md) / ContentItemEntityFields + +# Interface: ContentItemEntityFields + +Defined in: packages/types/dist/message-metadata.d.ts:156 + +## Properties + +### created\_by? + +```ts +optional created_by: EntityTypedField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:159 + +*** + +### date\_created? + +```ts +optional date_created: EntityTimestampField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:160 + +*** + +### date\_updated? + +```ts +optional date_updated: EntityTimestampField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:161 + +*** + +### description? + +```ts +optional description: EntityStringField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:158 + +*** + +### last\_modified\_by? + +```ts +optional last_modified_by: EntityTypedField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:162 + +*** + +### preview? + +```ts +optional preview: EntityImageField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:157 diff --git a/docs/english/reference/web-api/interfaces/ContextActionsBlock.md b/docs/english/reference/web-api/interfaces/ContextActionsBlock.md index 9e05233a4..c196e9d9d 100644 --- a/docs/english/reference/web-api/interfaces/ContextActionsBlock.md +++ b/docs/english/reference/web-api/interfaces/ContextActionsBlock.md @@ -2,12 +2,16 @@ # Interface: ContextActionsBlock -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:74 +Defined in: packages/types/dist/block-kit/blocks.d.ts:75 ## Description Displays actions as contextual info, which can include both feedback buttons and icon buttons. +## See + +[Context actions block reference](https://docs.slack.dev/reference/block-kit/blocks/context-actions-block). + ## Extends - [`Block`](Block.md) @@ -20,7 +24,7 @@ Displays actions as contextual info, which can include both feedback buttons and optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -42,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. elements: ContextActionsBlockElement[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:82 +Defined in: packages/types/dist/block-kit/blocks.d.ts:83 #### Description @@ -56,7 +60,7 @@ An array of [FeedbackButtons](FeedbackButtons.md) or [IconButton](IconButton.md) type: "context_actions"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:78 +Defined in: packages/types/dist/block-kit/blocks.d.ts:79 #### Description diff --git a/docs/english/reference/web-api/interfaces/ContextBlock.md b/docs/english/reference/web-api/interfaces/ContextBlock.md index 95477d1b7..aa18bf0cf 100644 --- a/docs/english/reference/web-api/interfaces/ContextBlock.md +++ b/docs/english/reference/web-api/interfaces/ContextBlock.md @@ -2,7 +2,7 @@ # Interface: ContextBlock -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:56 +Defined in: packages/types/dist/block-kit/blocks.d.ts:56 ## Description @@ -24,7 +24,7 @@ Displays contextual info, which can include both images and text. optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. elements: ContextBlockElement[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:65 +Defined in: packages/types/dist/block-kit/blocks.d.ts:65 #### Description @@ -61,7 +61,7 @@ Maximum number of items is 10. type: "context"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:60 +Defined in: packages/types/dist/block-kit/blocks.d.ts:60 #### Description diff --git a/docs/english/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md b/docs/english/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md index 9b09f3413..249af2579 100644 --- a/docs/english/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md +++ b/docs/english/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md @@ -2,7 +2,7 @@ # Interface: ConversationsCanvasesCreateArguments -Defined in: [packages/web-api/src/types/request/canvas.ts:92](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L92) +Defined in: [packages/web-api/src/types/request/canvas.ts:93](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L93) ## Extends @@ -36,7 +36,7 @@ ChannelID.channel_id optional document_content: DocumentContent; ``` -Defined in: [packages/web-api/src/types/request/canvas.ts:94](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L94) +Defined in: [packages/web-api/src/types/request/canvas.ts:95](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L95) #### Description @@ -50,7 +50,7 @@ Structure describing the type and contents of the Canvas being created. optional title: string; ``` -Defined in: [packages/web-api/src/types/request/canvas.ts:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L96) +Defined in: [packages/web-api/src/types/request/canvas.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L97) #### Description diff --git a/docs/english/reference/web-api/interfaces/ConversationsSelect.md b/docs/english/reference/web-api/interfaces/ConversationsSelect.md index 9f12bb37a..ced8989e0 100644 --- a/docs/english/reference/web-api/interfaces/ConversationsSelect.md +++ b/docs/english/reference/web-api/interfaces/ConversationsSelect.md @@ -2,7 +2,7 @@ # Interface: ConversationsSelect -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:348 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:352 ## Description @@ -26,7 +26,7 @@ visible to the current user in the active workspace. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -44,7 +44,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -63,7 +63,7 @@ with. optional default_to_current_conversation: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:362 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:366 #### Description @@ -78,7 +78,7 @@ modal, if available. Default is `false`. optional filter: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:366 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:370 #### exclude\_bot\_users? @@ -110,7 +110,7 @@ A filter object that reduces the list of available conversations using the speci optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -130,7 +130,7 @@ Defaults to `false`. optional initial_conversation: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:357 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:361 #### Description @@ -145,7 +145,7 @@ The ID of any valid conversation to be pre-selected when the menu loads. If optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -164,7 +164,7 @@ length for the `text` field in this object is 150 characters. optional response_url_enabled: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:58 +Defined in: packages/types/dist/block-kit/extensions.d.ts:58 #### Description @@ -185,7 +185,7 @@ for the message will be determined by the value of this select menu. type: "conversations_select"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:352 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:356 #### Description diff --git a/docs/english/reference/web-api/interfaces/DNDUpdatedEvent.md b/docs/english/reference/web-api/interfaces/DNDUpdatedEvent.md index 8ddd6a7de..e8279c6a1 100644 --- a/docs/english/reference/web-api/interfaces/DNDUpdatedEvent.md +++ b/docs/english/reference/web-api/interfaces/DNDUpdatedEvent.md @@ -2,7 +2,7 @@ # Interface: DNDUpdatedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:1 +Defined in: packages/types/dist/events/dnd.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:1 dnd_status: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:4 +Defined in: packages/types/dist/events/dnd.d.ts:4 #### dnd\_enabled @@ -58,7 +58,7 @@ snooze_remaining: number; event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:12 +Defined in: packages/types/dist/events/dnd.d.ts:12 *** @@ -68,7 +68,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:12 type: "dnd_updated"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:2 +Defined in: packages/types/dist/events/dnd.d.ts:2 *** @@ -78,4 +78,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:2 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:3 +Defined in: packages/types/dist/events/dnd.d.ts:3 diff --git a/docs/english/reference/web-api/interfaces/DNDUpdatedUserEvent.md b/docs/english/reference/web-api/interfaces/DNDUpdatedUserEvent.md index 6e72bdc3f..f8cc50df8 100644 --- a/docs/english/reference/web-api/interfaces/DNDUpdatedUserEvent.md +++ b/docs/english/reference/web-api/interfaces/DNDUpdatedUserEvent.md @@ -2,7 +2,7 @@ # Interface: DNDUpdatedUserEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:14 +Defined in: packages/types/dist/events/dnd.d.ts:14 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:14 dnd_status: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:17 +Defined in: packages/types/dist/events/dnd.d.ts:17 #### dnd\_enabled @@ -40,7 +40,7 @@ next_dnd_start_ts: number; event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:22 +Defined in: packages/types/dist/events/dnd.d.ts:22 *** @@ -50,7 +50,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:22 type: "dnd_updated_user"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:15 +Defined in: packages/types/dist/events/dnd.d.ts:15 *** @@ -60,4 +60,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:15 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/dnd.d.ts:16 +Defined in: packages/types/dist/events/dnd.d.ts:16 diff --git a/docs/english/reference/web-api/interfaces/DateTimepicker.md b/docs/english/reference/web-api/interfaces/DateTimepicker.md index 5df629c4b..3dd143518 100644 --- a/docs/english/reference/web-api/interfaces/DateTimepicker.md +++ b/docs/english/reference/web-api/interfaces/DateTimepicker.md @@ -2,7 +2,7 @@ # Interface: DateTimepicker -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:89 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:89 ## Description @@ -28,7 +28,7 @@ picker will use native UIs. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -46,7 +46,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -65,7 +65,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -85,7 +85,7 @@ Defaults to `false`. optional initial_date_time: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:99 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:99 #### Description @@ -101,7 +101,7 @@ time August 10th, 2021 at 03:17pm PST. type: "datetimepicker"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:93 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:93 #### Description diff --git a/docs/english/reference/web-api/interfaces/Datepicker.md b/docs/english/reference/web-api/interfaces/Datepicker.md index 346b50d66..402b2c4e1 100644 --- a/docs/english/reference/web-api/interfaces/Datepicker.md +++ b/docs/english/reference/web-api/interfaces/Datepicker.md @@ -2,7 +2,7 @@ # Interface: Datepicker -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:70 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:70 ## Description @@ -25,7 +25,7 @@ Allows users to select a date from a calendar style UI. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -43,7 +43,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -62,7 +62,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_date: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:79 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:79 #### Description @@ -97,7 +97,7 @@ This should be in the format `YYYY-MM-DD`. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -116,7 +116,7 @@ length for the `text` field in this object is 150 characters. type: "datepicker"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:74 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:74 #### Description diff --git a/docs/english/reference/web-api/interfaces/Dialog.md b/docs/english/reference/web-api/interfaces/Dialog.md index 2a42c42f4..0cffdd567 100644 --- a/docs/english/reference/web-api/interfaces/Dialog.md +++ b/docs/english/reference/web-api/interfaces/Dialog.md @@ -2,7 +2,7 @@ # ~~Interface: Dialog~~ -Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:5 +Defined in: packages/types/dist/dialog.d.ts:5 Reusable shapes for argument values @@ -18,7 +18,7 @@ Dialogs are a deprecated surface in Slack. For more details on how to upgrade, c callback_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:7 +Defined in: packages/types/dist/dialog.d.ts:7 *** @@ -28,7 +28,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:7 elements: object[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:8 +Defined in: packages/types/dist/dialog.d.ts:8 #### ~~data\_source?~~ @@ -105,7 +105,7 @@ optional selected_options: SelectOption[]; #### ~~subtype?~~ ```ts -optional subtype: "number" | "email" | "tel" | "url"; +optional subtype: "number" | "url" | "email" | "tel"; ``` #### ~~type~~ @@ -128,7 +128,7 @@ optional value: string; optional notify_on_cancel: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:29 +Defined in: packages/types/dist/dialog.d.ts:29 *** @@ -138,7 +138,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:29 optional state: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:30 +Defined in: packages/types/dist/dialog.d.ts:30 *** @@ -148,7 +148,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:30 optional submit_label: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:28 +Defined in: packages/types/dist/dialog.d.ts:28 *** @@ -158,4 +158,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:28 title: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:6 +Defined in: packages/types/dist/dialog.d.ts:6 diff --git a/docs/english/reference/web-api/interfaces/DispatchActionConfig.md b/docs/english/reference/web-api/interfaces/DispatchActionConfig.md index 0e0ab980f..9b6a15d8d 100644 --- a/docs/english/reference/web-api/interfaces/DispatchActionConfig.md +++ b/docs/english/reference/web-api/interfaces/DispatchActionConfig.md @@ -2,7 +2,7 @@ # Interface: DispatchActionConfig -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:52 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:52 ## Description @@ -20,7 +20,7 @@ Defines when a [PlainTextElement](PlainTextElement.md) will return a [\`block\_a optional trigger_actions_on: ("on_enter_pressed" | "on_character_entered")[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:61 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:61 #### Description diff --git a/docs/english/reference/web-api/interfaces/Dispatchable.md b/docs/english/reference/web-api/interfaces/Dispatchable.md index e2701ca0f..9dd327415 100644 --- a/docs/english/reference/web-api/interfaces/Dispatchable.md +++ b/docs/english/reference/web-api/interfaces/Dispatchable.md @@ -2,7 +2,7 @@ # Interface: Dispatchable -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:23 +Defined in: packages/types/dist/block-kit/extensions.d.ts:23 ## Extended by @@ -20,7 +20,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extension optional dispatch_action_config: DispatchActionConfig; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:28 +Defined in: packages/types/dist/block-kit/extensions.d.ts:28 #### Description diff --git a/docs/english/reference/web-api/interfaces/DividerBlock.md b/docs/english/reference/web-api/interfaces/DividerBlock.md index cbf51b9d9..3e627aeaf 100644 --- a/docs/english/reference/web-api/interfaces/DividerBlock.md +++ b/docs/english/reference/web-api/interfaces/DividerBlock.md @@ -2,7 +2,7 @@ # Interface: DividerBlock -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:89 +Defined in: packages/types/dist/block-kit/blocks.d.ts:90 ## Description @@ -25,7 +25,7 @@ different blocks inside of a message. The divider block is nice and neat, requir optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -47,7 +47,7 @@ a message. If a message is updated, use a new `block_id`. type: "divider"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:93 +Defined in: packages/types/dist/block-kit/blocks.d.ts:94 #### Description diff --git a/docs/english/reference/web-api/interfaces/EKMAccessDeniedMessageEvent.md b/docs/english/reference/web-api/interfaces/EKMAccessDeniedMessageEvent.md index b6b66bdad..a425e9338 100644 --- a/docs/english/reference/web-api/interfaces/EKMAccessDeniedMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/EKMAccessDeniedMessageEvent.md @@ -2,7 +2,7 @@ # Interface: EKMAccessDeniedMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:151 +Defined in: packages/types/dist/events/message.d.ts:151 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:155 +Defined in: packages/types/dist/events/message.d.ts:155 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:156 +Defined in: packages/types/dist/events/message.d.ts:156 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:154 +Defined in: packages/types/dist/events/message.d.ts:154 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "ekm_access_denied"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:153 +Defined in: packages/types/dist/events/message.d.ts:153 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:158 +Defined in: packages/types/dist/events/message.d.ts:158 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:157 +Defined in: packages/types/dist/events/message.d.ts:157 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:152 +Defined in: packages/types/dist/events/message.d.ts:152 *** @@ -82,4 +82,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: "UREVOKEDU"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:159 +Defined in: packages/types/dist/events/message.d.ts:159 diff --git a/docs/english/reference/web-api/interfaces/EmailDomainChangedEvent.md b/docs/english/reference/web-api/interfaces/EmailDomainChangedEvent.md index f3244b434..f6286a439 100644 --- a/docs/english/reference/web-api/interfaces/EmailDomainChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/EmailDomainChangedEvent.md @@ -2,7 +2,7 @@ # Interface: EmailDomainChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/email.d.ts:1 +Defined in: packages/types/dist/events/email.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/email.d.ts:1 email_domain: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/email.d.ts:3 +Defined in: packages/types/dist/events/email.d.ts:3 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/email.d.ts:3 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/email.d.ts:4 +Defined in: packages/types/dist/events/email.d.ts:4 *** @@ -32,4 +32,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/email.d.ts:4 type: "email_domain_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/email.d.ts:2 +Defined in: packages/types/dist/events/email.d.ts:2 diff --git a/docs/english/reference/web-api/interfaces/EmailInput.md b/docs/english/reference/web-api/interfaces/EmailInput.md index bad41360b..00e4db37f 100644 --- a/docs/english/reference/web-api/interfaces/EmailInput.md +++ b/docs/english/reference/web-api/interfaces/EmailInput.md @@ -2,7 +2,7 @@ # Interface: EmailInput -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:106 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:106 ## Description @@ -25,7 +25,7 @@ Allows user to enter an email into a single-line field. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -43,7 +43,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional dispatch_action_config: DispatchActionConfig; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:28 +Defined in: packages/types/dist/block-kit/extensions.d.ts:28 #### Description @@ -62,7 +62,7 @@ A [DispatchActionConfig](DispatchActionConfig.md) object that determines when du optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:114 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:114 #### Description @@ -96,7 +96,7 @@ The initial value in the email input when it is loaded. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -115,7 +115,7 @@ length for the `text` field in this object is 150 characters. type: "email_text_input"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:110 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:110 #### Description diff --git a/docs/english/reference/web-api/interfaces/EmojiChangedEvent.md b/docs/english/reference/web-api/interfaces/EmojiChangedEvent.md index 0996a3ce8..2d17e565d 100644 --- a/docs/english/reference/web-api/interfaces/EmojiChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/EmojiChangedEvent.md @@ -2,7 +2,7 @@ # Interface: EmojiChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:1 +Defined in: packages/types/dist/events/emoji.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:1 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:9 +Defined in: packages/types/dist/events/emoji.d.ts:9 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:9 optional name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:5 +Defined in: packages/types/dist/events/emoji.d.ts:5 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:5 optional names: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:4 +Defined in: packages/types/dist/events/emoji.d.ts:4 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:4 optional new_name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:8 +Defined in: packages/types/dist/events/emoji.d.ts:8 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:8 optional old_name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:7 +Defined in: packages/types/dist/events/emoji.d.ts:7 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:7 subtype: "add" | "remove" | "rename"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:3 +Defined in: packages/types/dist/events/emoji.d.ts:3 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:3 type: "emoji_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:2 +Defined in: packages/types/dist/events/emoji.d.ts:2 *** @@ -82,4 +82,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:2 optional value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/emoji.d.ts:6 +Defined in: packages/types/dist/events/emoji.d.ts:6 diff --git a/docs/english/reference/web-api/interfaces/EntityActionButton.md b/docs/english/reference/web-api/interfaces/EntityActionButton.md new file mode 100644 index 000000000..15c7fbfac --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityActionButton.md @@ -0,0 +1,87 @@ +[@slack/web-api](../index.md) / EntityActionButton + +# Interface: EntityActionButton + +Defined in: packages/types/dist/message-metadata.d.ts:269 + +## Properties + +### accessibility\_label? + +```ts +optional accessibility_label: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:275 + +*** + +### action\_id + +```ts +action_id: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:271 + +*** + +### processing\_state? + +```ts +optional processing_state: object; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:276 + +#### enabled + +```ts +enabled: boolean; +``` + +#### interstitial\_text? + +```ts +optional interstitial_text: string; +``` + +*** + +### style? + +```ts +optional style: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:273 + +*** + +### text + +```ts +text: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:270 + +*** + +### url? + +```ts +optional url: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:274 + +*** + +### value? + +```ts +optional value: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:272 diff --git a/docs/english/reference/web-api/interfaces/EntityArrayItemField.md b/docs/english/reference/web-api/interfaces/EntityArrayItemField.md new file mode 100644 index 000000000..138ef5798 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityArrayItemField.md @@ -0,0 +1,203 @@ +[@slack/web-api](../index.md) / EntityArrayItemField + +# Interface: EntityArrayItemField + +Defined in: packages/types/dist/message-metadata.d.ts:164 + +## Extends + +- `Omit`\<[`EntityTypedField`](EntityTypedField.md), `"type"`\> + +## Properties + +### alt\_text? + +```ts +optional alt_text: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:177 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`alt_text`](EntityTypedField.md#alt_text) + +*** + +### edit? + +```ts +optional edit: EntityEditSupport; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:178 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`edit`](EntityTypedField.md#edit) + +*** + +### entity\_ref? + +```ts +optional entity_ref: EntityRefField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:181 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`entity_ref`](EntityTypedField.md#entity_ref) + +*** + +### format? + +```ts +optional format: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:174 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`format`](EntityTypedField.md#format) + +*** + +### icon? + +```ts +optional icon: EntityIconField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:172 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`icon`](EntityTypedField.md#icon) + +*** + +### image\_url? + +```ts +optional image_url: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:175 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`image_url`](EntityTypedField.md#image_url) + +*** + +### label? + +```ts +optional label: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:169 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`label`](EntityTypedField.md#label) + +*** + +### link? + +```ts +optional link: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:171 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`link`](EntityTypedField.md#link) + +*** + +### long? + +```ts +optional long: boolean; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:173 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`long`](EntityTypedField.md#long) + +*** + +### slack\_file? + +```ts +optional slack_file: SlackFile; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:176 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`slack_file`](EntityTypedField.md#slack_file) + +*** + +### tag\_color? + +```ts +optional tag_color: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:179 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`tag_color`](EntityTypedField.md#tag_color) + +*** + +### type? + +```ts +optional type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:165 + +*** + +### user? + +```ts +optional user: + | EntityUserIDField + | EntityUserField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:180 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`user`](EntityTypedField.md#user) + +*** + +### value? + +```ts +optional value: string | number; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:170 + +#### Inherited from + +[`EntityTypedField`](EntityTypedField.md).[`value`](EntityTypedField.md#value) diff --git a/docs/english/reference/web-api/interfaces/EntityAttributes.md b/docs/english/reference/web-api/interfaces/EntityAttributes.md new file mode 100644 index 000000000..82321db0a --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityAttributes.md @@ -0,0 +1,97 @@ +[@slack/web-api](../index.md) / EntityAttributes + +# Interface: EntityAttributes + +Defined in: packages/types/dist/message-metadata.d.ts:73 + +## Properties + +### display\_id? + +```ts +optional display_id: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:79 + +*** + +### display\_type? + +```ts +optional display_type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:78 + +*** + +### full\_size\_preview? + +```ts +optional full_size_preview: EntityFullSizePreview; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:83 + +*** + +### locale? + +```ts +optional locale: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:82 + +*** + +### metadata\_last\_modified? + +```ts +optional metadata_last_modified: number; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:84 + +*** + +### product\_icon? + +```ts +optional product_icon: EntityIconField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:80 + +*** + +### product\_name? + +```ts +optional product_name: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:81 + +*** + +### title + +```ts +title: object; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:74 + +#### edit? + +```ts +optional edit: EntityEditSupport; +``` + +#### text + +```ts +text: string; +``` diff --git a/docs/english/reference/web-api/interfaces/EntityBooleanCheckboxField.md b/docs/english/reference/web-api/interfaces/EntityBooleanCheckboxField.md new file mode 100644 index 000000000..7cb1da988 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityBooleanCheckboxField.md @@ -0,0 +1,35 @@ +[@slack/web-api](../index.md) / EntityBooleanCheckboxField + +# Interface: EntityBooleanCheckboxField + +Defined in: packages/types/dist/message-metadata.d.ts:210 + +## Properties + +### description? + +```ts +optional description: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:213 + +*** + +### text + +```ts +text: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:212 + +*** + +### type + +```ts +type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:211 diff --git a/docs/english/reference/web-api/interfaces/EntityBooleanTextField.md b/docs/english/reference/web-api/interfaces/EntityBooleanTextField.md new file mode 100644 index 000000000..b4b43fb14 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityBooleanTextField.md @@ -0,0 +1,55 @@ +[@slack/web-api](../index.md) / EntityBooleanTextField + +# Interface: EntityBooleanTextField + +Defined in: packages/types/dist/message-metadata.d.ts:215 + +## Properties + +### false\_description? + +```ts +optional false_description: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:220 + +*** + +### false\_text + +```ts +false_text: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:218 + +*** + +### true\_description? + +```ts +optional true_description: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:219 + +*** + +### true\_text + +```ts +true_text: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:217 + +*** + +### type + +```ts +type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:216 diff --git a/docs/english/reference/web-api/interfaces/EntityCustomField.md b/docs/english/reference/web-api/interfaces/EntityCustomField.md new file mode 100644 index 000000000..83b6932e5 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityCustomField.md @@ -0,0 +1,179 @@ +[@slack/web-api](../index.md) / EntityCustomField + +# Interface: EntityCustomField + +Defined in: packages/types/dist/message-metadata.d.ts:236 + +## Properties + +### alt\_text? + +```ts +optional alt_text: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:247 + +*** + +### boolean? + +```ts +optional boolean: + | EntityBooleanCheckboxField + | EntityBooleanTextField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:253 + +*** + +### edit? + +```ts +optional edit: EntityEditSupport; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:249 + +*** + +### entity\_ref? + +```ts +optional entity_ref: EntityRefField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:252 + +*** + +### format? + +```ts +optional format: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:244 + +*** + +### icon? + +```ts +optional icon: EntityIconField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:242 + +*** + +### image\_url? + +```ts +optional image_url: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:245 + +*** + +### item\_type? + +```ts +optional item_type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:250 + +*** + +### key + +```ts +key: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:238 + +*** + +### label + +```ts +label: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:237 + +*** + +### link? + +```ts +optional link: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:241 + +*** + +### long? + +```ts +optional long: boolean; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:243 + +*** + +### slack\_file? + +```ts +optional slack_file: SlackFile; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:246 + +*** + +### tag\_color? + +```ts +optional tag_color: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:248 + +*** + +### type + +```ts +type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:239 + +*** + +### user? + +```ts +optional user: + | EntityUserIDField + | EntityUserField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:251 + +*** + +### value? + +```ts +optional value: string | number | EntityArrayItemField[]; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:240 diff --git a/docs/english/reference/web-api/interfaces/EntityEditSupport.md b/docs/english/reference/web-api/interfaces/EntityEditSupport.md new file mode 100644 index 000000000..223d4772e --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityEditSupport.md @@ -0,0 +1,135 @@ +[@slack/web-api](../index.md) / EntityEditSupport + +# Interface: EntityEditSupport + +Defined in: packages/types/dist/message-metadata.d.ts:94 + +## Properties + +### enabled + +```ts +enabled: boolean; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:95 + +*** + +### hint? + +```ts +optional hint: PlainTextElement; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:97 + +*** + +### number? + +```ts +optional number: object; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:106 + +#### is\_decimal\_allowed? + +```ts +optional is_decimal_allowed: boolean; +``` + +#### max\_value? + +```ts +optional max_value: number; +``` + +#### min\_value? + +```ts +optional min_value: number; +``` + +*** + +### optional? + +```ts +optional optional: boolean; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:98 + +*** + +### placeholder? + +```ts +optional placeholder: PlainTextElement; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:96 + +*** + +### select? + +```ts +optional select: object; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:99 + +#### current\_value? + +```ts +optional current_value: string; +``` + +#### current\_values? + +```ts +optional current_values: string[]; +``` + +#### fetch\_options\_dynamically? + +```ts +optional fetch_options_dynamically: boolean; +``` + +#### min\_query\_length? + +```ts +optional min_query_length: number; +``` + +#### static\_options? + +```ts +optional static_options: Option[]; +``` + +*** + +### text? + +```ts +optional text: object; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:111 + +#### max\_length? + +```ts +optional max_length: number; +``` + +#### min\_length? + +```ts +optional min_length: number; +``` diff --git a/docs/english/reference/web-api/interfaces/EntityFullSizePreview.md b/docs/english/reference/web-api/interfaces/EntityFullSizePreview.md new file mode 100644 index 000000000..903862798 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityFullSizePreview.md @@ -0,0 +1,57 @@ +[@slack/web-api](../index.md) / EntityFullSizePreview + +# Interface: EntityFullSizePreview + +Defined in: packages/types/dist/message-metadata.d.ts:116 + +## Properties + +### error? + +```ts +optional error: object; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:120 + +#### code + +```ts +code: string; +``` + +#### message? + +```ts +optional message: string; +``` + +*** + +### is\_supported + +```ts +is_supported: boolean; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:117 + +*** + +### mime\_type? + +```ts +optional mime_type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:119 + +*** + +### preview\_url? + +```ts +optional preview_url: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:118 diff --git a/docs/english/reference/web-api/interfaces/EntityIconField.md b/docs/english/reference/web-api/interfaces/EntityIconField.md new file mode 100644 index 000000000..af61fddac --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityIconField.md @@ -0,0 +1,47 @@ +[@slack/web-api](../index.md) / EntityIconField + +# Interface: EntityIconField + +Defined in: packages/types/dist/message-metadata.d.ts:86 + +## Properties + +### alt\_text + +```ts +alt_text: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:87 + +*** + +### slack\_file? + +```ts +optional slack_file: object; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:89 + +#### id? + +```ts +optional id: string; +``` + +#### url? + +```ts +optional url: string; +``` + +*** + +### url? + +```ts +optional url: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:88 diff --git a/docs/english/reference/web-api/interfaces/EntityImageField.md b/docs/english/reference/web-api/interfaces/EntityImageField.md new file mode 100644 index 000000000..9abc77cf8 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityImageField.md @@ -0,0 +1,65 @@ +[@slack/web-api](../index.md) / EntityImageField + +# Interface: EntityImageField + +Defined in: packages/types/dist/message-metadata.d.ts:228 + +## Properties + +### alt\_text + +```ts +alt_text: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:229 + +*** + +### image\_url? + +```ts +optional image_url: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:231 + +*** + +### label? + +```ts +optional label: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:230 + +*** + +### slack\_file? + +```ts +optional slack_file: SlackFile; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:232 + +*** + +### title? + +```ts +optional title: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:233 + +*** + +### type? + +```ts +optional type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:234 diff --git a/docs/english/reference/web-api/interfaces/EntityMetadata.md b/docs/english/reference/web-api/interfaces/EntityMetadata.md new file mode 100644 index 000000000..400c61ecf --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityMetadata.md @@ -0,0 +1,131 @@ +[@slack/web-api](../index.md) / EntityMetadata + +# Interface: EntityMetadata + +Defined in: packages/types/dist/message-metadata.d.ts:26 + +## Description + +Metadata that represents a work object entity. + +## Properties + +### app\_unfurl\_url? + +```ts +optional app_unfurl_url: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:56 + +#### Description + +The exact URL posted in the source message. Required in metadata passed to `chat.unfurl`. + +*** + +### entity\_payload + +```ts +entity_payload: object; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:34 + +#### actions? + +```ts +optional actions: object; +``` + +##### actions.overflow\_actions? + +```ts +optional overflow_actions: EntityActionButton[]; +``` + +##### actions.primary\_actions? + +```ts +optional primary_actions: EntityActionButton[]; +``` + +#### attributes + +```ts +attributes: EntityAttributes; +``` + +#### custom\_fields? + +```ts +optional custom_fields: EntityCustomField[]; +``` + +#### display\_order? + +```ts +optional display_order: string[]; +``` + +#### fields? + +```ts +optional fields: + | ContentItemEntityFields + | FileEntityFields + | IncidentEntityFields + | TaskEntityFields; +``` + +#### slack\_file? + +```ts +optional slack_file: FileEntitySlackFile; +``` + +#### Description + +Schema for the given entity type. + +*** + +### entity\_type + +```ts +entity_type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:30 + +#### Description + +Entity type. + +*** + +### external\_ref + +```ts +external_ref: ExternalRef; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:48 + +#### Description + +Reference (and optional type) used to identify an entity within the developer's system. + +*** + +### url + +```ts +url: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:52 + +#### Description + +URL used to identify an entity within the developer's system. diff --git a/docs/english/reference/web-api/interfaces/EntityRefField.md b/docs/english/reference/web-api/interfaces/EntityRefField.md new file mode 100644 index 000000000..58b8cda26 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityRefField.md @@ -0,0 +1,55 @@ +[@slack/web-api](../index.md) / EntityRefField + +# Interface: EntityRefField + +Defined in: packages/types/dist/message-metadata.d.ts:203 + +## Properties + +### display\_type? + +```ts +optional display_type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:207 + +*** + +### entity\_url + +```ts +entity_url: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:204 + +*** + +### external\_ref + +```ts +external_ref: ExternalRef; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:205 + +*** + +### icon? + +```ts +optional icon: EntityIconField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:208 + +*** + +### title + +```ts +title: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:206 diff --git a/docs/english/reference/web-api/interfaces/EntityStringField.md b/docs/english/reference/web-api/interfaces/EntityStringField.md new file mode 100644 index 000000000..a1981f161 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityStringField.md @@ -0,0 +1,95 @@ +[@slack/web-api](../index.md) / EntityStringField + +# Interface: EntityStringField + +Defined in: packages/types/dist/message-metadata.d.ts:183 + +## Properties + +### edit? + +```ts +optional edit: EntityEditSupport; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:192 + +*** + +### format? + +```ts +optional format: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:186 + +*** + +### icon? + +```ts +optional icon: EntityIconField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:188 + +*** + +### label? + +```ts +optional label: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:185 + +*** + +### link? + +```ts +optional link: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:187 + +*** + +### long? + +```ts +optional long: boolean; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:189 + +*** + +### tag\_color? + +```ts +optional tag_color: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:191 + +*** + +### type? + +```ts +optional type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:190 + +*** + +### value + +```ts +value: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:184 diff --git a/docs/english/reference/web-api/interfaces/EntityTimestampField.md b/docs/english/reference/web-api/interfaces/EntityTimestampField.md new file mode 100644 index 000000000..a7e04e24e --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityTimestampField.md @@ -0,0 +1,45 @@ +[@slack/web-api](../index.md) / EntityTimestampField + +# Interface: EntityTimestampField + +Defined in: packages/types/dist/message-metadata.d.ts:222 + +## Properties + +### edit? + +```ts +optional edit: EntityEditSupport; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:226 + +*** + +### label? + +```ts +optional label: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:224 + +*** + +### type? + +```ts +optional type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:225 + +*** + +### value + +```ts +value: number; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:223 diff --git a/docs/english/reference/web-api/interfaces/EntityTypedField.md b/docs/english/reference/web-api/interfaces/EntityTypedField.md new file mode 100644 index 000000000..118c58394 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityTypedField.md @@ -0,0 +1,147 @@ +[@slack/web-api](../index.md) / EntityTypedField + +# Interface: EntityTypedField + +Defined in: packages/types/dist/message-metadata.d.ts:167 + +## Properties + +### alt\_text? + +```ts +optional alt_text: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:177 + +*** + +### edit? + +```ts +optional edit: EntityEditSupport; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:178 + +*** + +### entity\_ref? + +```ts +optional entity_ref: EntityRefField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:181 + +*** + +### format? + +```ts +optional format: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:174 + +*** + +### icon? + +```ts +optional icon: EntityIconField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:172 + +*** + +### image\_url? + +```ts +optional image_url: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:175 + +*** + +### label? + +```ts +optional label: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:169 + +*** + +### link? + +```ts +optional link: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:171 + +*** + +### long? + +```ts +optional long: boolean; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:173 + +*** + +### slack\_file? + +```ts +optional slack_file: SlackFile; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:176 + +*** + +### tag\_color? + +```ts +optional tag_color: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:179 + +*** + +### type + +```ts +type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:168 + +*** + +### user? + +```ts +optional user: + | EntityUserIDField + | EntityUserField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:180 + +*** + +### value? + +```ts +optional value: string | number; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:170 diff --git a/docs/english/reference/web-api/interfaces/EntityUserField.md b/docs/english/reference/web-api/interfaces/EntityUserField.md new file mode 100644 index 000000000..c5ce8f306 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityUserField.md @@ -0,0 +1,45 @@ +[@slack/web-api](../index.md) / EntityUserField + +# Interface: EntityUserField + +Defined in: packages/types/dist/message-metadata.d.ts:197 + +## Properties + +### email? + +```ts +optional email: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:200 + +*** + +### icon? + +```ts +optional icon: EntityIconField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:201 + +*** + +### text + +```ts +text: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:198 + +*** + +### url? + +```ts +optional url: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:199 diff --git a/docs/english/reference/web-api/interfaces/EntityUserIDField.md b/docs/english/reference/web-api/interfaces/EntityUserIDField.md new file mode 100644 index 000000000..5b7cab7e1 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/EntityUserIDField.md @@ -0,0 +1,15 @@ +[@slack/web-api](../index.md) / EntityUserIDField + +# Interface: EntityUserIDField + +Defined in: packages/types/dist/message-metadata.d.ts:194 + +## Properties + +### user\_id + +```ts +user_id: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:195 diff --git a/docs/english/reference/web-api/interfaces/ExternalRef.md b/docs/english/reference/web-api/interfaces/ExternalRef.md new file mode 100644 index 000000000..65df9e980 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/ExternalRef.md @@ -0,0 +1,25 @@ +[@slack/web-api](../index.md) / ExternalRef + +# Interface: ExternalRef + +Defined in: packages/types/dist/message-metadata.d.ts:58 + +## Properties + +### id + +```ts +id: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:59 + +*** + +### type? + +```ts +optional type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:60 diff --git a/docs/english/reference/web-api/interfaces/ExternalSelect.md b/docs/english/reference/web-api/interfaces/ExternalSelect.md index 0526931b9..ce2e1db4f 100644 --- a/docs/english/reference/web-api/interfaces/ExternalSelect.md +++ b/docs/english/reference/web-api/interfaces/ExternalSelect.md @@ -2,7 +2,7 @@ # Interface: ExternalSelect -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:440 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:444 ## Description @@ -26,7 +26,7 @@ options. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -44,7 +44,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -63,7 +63,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_option: PlainTextOption; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:448 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:452 #### Description @@ -97,7 +97,7 @@ A single option to be selected when the menu initially loads. optional min_query_length: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:454 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:458 #### Description @@ -113,7 +113,7 @@ of typed characters required before dispatch. The default value is `3`. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -132,7 +132,7 @@ length for the `text` field in this object is 150 characters. type: "external_select"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:444 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:448 #### Description diff --git a/docs/english/reference/web-api/interfaces/FeedbackButtons.md b/docs/english/reference/web-api/interfaces/FeedbackButtons.md index dd12f8c2d..e689912e5 100644 --- a/docs/english/reference/web-api/interfaces/FeedbackButtons.md +++ b/docs/english/reference/web-api/interfaces/FeedbackButtons.md @@ -2,7 +2,7 @@ # Interface: FeedbackButtons -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:119 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:119 ## Description @@ -20,7 +20,7 @@ Buttons to indicate positive or negative feedback. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -38,7 +38,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi negative_button: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:145 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:148 #### accessibility\_label? @@ -78,6 +78,10 @@ The negative feedback button value. A button to indicate negative feedback. +#### See + +[Feedback buttons object fields reference](https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element/#button-object-fields). + *** ### positive\_button @@ -86,7 +90,7 @@ A button to indicate negative feedback. positive_button: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:127 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:129 #### accessibility\_label? @@ -126,6 +130,10 @@ The positive feedback button value. A button to indicate positive feedback. +#### See + +[Feedback buttons object fields reference](https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element/#button-object-fields). + *** ### type @@ -134,12 +142,16 @@ A button to indicate positive feedback. type: "feedback_buttons"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:123 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:124 #### Description The type of block. For a feedback buttons block, `type` is always `feedback_buttons`. +#### See + +[Feedback buttons element reference](https://docs.slack.dev/reference/block-kit/block-elements/feedback-buttons-element). + #### Overrides [`Actionable`](Actionable.md).[`type`](Actionable.md#type) diff --git a/docs/english/reference/web-api/interfaces/FileBlock.md b/docs/english/reference/web-api/interfaces/FileBlock.md index 817322f42..652a79557 100644 --- a/docs/english/reference/web-api/interfaces/FileBlock.md +++ b/docs/english/reference/web-api/interfaces/FileBlock.md @@ -2,7 +2,7 @@ # Interface: FileBlock -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:102 +Defined in: packages/types/dist/block-kit/blocks.d.ts:103 ## Description @@ -27,7 +27,7 @@ that contain remote files. If you want to add remote files to messages, optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -49,7 +49,7 @@ a message. If a message is updated, use a new `block_id`. external_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:114 +Defined in: packages/types/dist/block-kit/blocks.d.ts:115 #### Description @@ -63,7 +63,7 @@ The external unique ID for this file. source: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:110 +Defined in: packages/types/dist/block-kit/blocks.d.ts:111 #### Description @@ -77,7 +77,7 @@ At the moment, source will always be `remote` for a remote file. type: "file"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:106 +Defined in: packages/types/dist/block-kit/blocks.d.ts:107 #### Description diff --git a/docs/english/reference/web-api/interfaces/FileChangeEvent.md b/docs/english/reference/web-api/interfaces/FileChangeEvent.md index 24595c6c1..c70930a16 100644 --- a/docs/english/reference/web-api/interfaces/FileChangeEvent.md +++ b/docs/english/reference/web-api/interfaces/FileChangeEvent.md @@ -2,7 +2,7 @@ # Interface: FileChangeEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:1 +Defined in: packages/types/dist/events/file.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:1 file: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:4 +Defined in: packages/types/dist/events/file.d.ts:4 #### id @@ -28,7 +28,7 @@ id: string; file_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:3 +Defined in: packages/types/dist/events/file.d.ts:3 *** @@ -38,4 +38,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:3 type: "file_change"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:2 +Defined in: packages/types/dist/events/file.d.ts:2 diff --git a/docs/english/reference/web-api/interfaces/FileCommentDeletedEvent.md b/docs/english/reference/web-api/interfaces/FileCommentDeletedEvent.md index ee236ecd6..daaee8f56 100644 --- a/docs/english/reference/web-api/interfaces/FileCommentDeletedEvent.md +++ b/docs/english/reference/web-api/interfaces/FileCommentDeletedEvent.md @@ -2,7 +2,7 @@ # Interface: FileCommentDeletedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:8 +Defined in: packages/types/dist/events/file.d.ts:8 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:8 comment: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:10 +Defined in: packages/types/dist/events/file.d.ts:10 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:10 file: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:12 +Defined in: packages/types/dist/events/file.d.ts:12 #### id @@ -38,7 +38,7 @@ id: string; file_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:11 +Defined in: packages/types/dist/events/file.d.ts:11 *** @@ -48,4 +48,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:11 type: "file_comment_deleted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:9 +Defined in: packages/types/dist/events/file.d.ts:9 diff --git a/docs/english/reference/web-api/interfaces/FileCreatedEvent.md b/docs/english/reference/web-api/interfaces/FileCreatedEvent.md index 7802dbbd2..a0f4d0c2e 100644 --- a/docs/english/reference/web-api/interfaces/FileCreatedEvent.md +++ b/docs/english/reference/web-api/interfaces/FileCreatedEvent.md @@ -2,7 +2,7 @@ # Interface: FileCreatedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:16 +Defined in: packages/types/dist/events/file.d.ts:16 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:16 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:23 +Defined in: packages/types/dist/events/file.d.ts:23 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:23 file: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:20 +Defined in: packages/types/dist/events/file.d.ts:20 #### id @@ -38,7 +38,7 @@ id: string; file_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:18 +Defined in: packages/types/dist/events/file.d.ts:18 *** @@ -48,7 +48,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:18 type: "file_created"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:17 +Defined in: packages/types/dist/events/file.d.ts:17 *** @@ -58,4 +58,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:17 user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:19 +Defined in: packages/types/dist/events/file.d.ts:19 diff --git a/docs/english/reference/web-api/interfaces/FileDeletedEvent.md b/docs/english/reference/web-api/interfaces/FileDeletedEvent.md index 25b766c18..3c723855d 100644 --- a/docs/english/reference/web-api/interfaces/FileDeletedEvent.md +++ b/docs/english/reference/web-api/interfaces/FileDeletedEvent.md @@ -2,7 +2,7 @@ # Interface: FileDeletedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:25 +Defined in: packages/types/dist/events/file.d.ts:25 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:25 optional channel_ids: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:28 +Defined in: packages/types/dist/events/file.d.ts:28 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:28 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:29 +Defined in: packages/types/dist/events/file.d.ts:29 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:29 file_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:27 +Defined in: packages/types/dist/events/file.d.ts:27 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:27 type: "file_deleted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:26 +Defined in: packages/types/dist/events/file.d.ts:26 diff --git a/docs/english/reference/web-api/interfaces/FileEntityFields.md b/docs/english/reference/web-api/interfaces/FileEntityFields.md new file mode 100644 index 000000000..76491863b --- /dev/null +++ b/docs/english/reference/web-api/interfaces/FileEntityFields.md @@ -0,0 +1,85 @@ +[@slack/web-api](../index.md) / FileEntityFields + +# Interface: FileEntityFields + +Defined in: packages/types/dist/message-metadata.d.ts:125 + +## Properties + +### created\_by? + +```ts +optional created_by: EntityTypedField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:127 + +*** + +### date\_created? + +```ts +optional date_created: EntityTimestampField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:128 + +*** + +### date\_updated? + +```ts +optional date_updated: EntityTimestampField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:129 + +*** + +### file\_size? + +```ts +optional file_size: EntityStringField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:131 + +*** + +### full\_size\_preview? + +```ts +optional full_size_preview: EntityFullSizePreview; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:133 + +*** + +### last\_modified\_by? + +```ts +optional last_modified_by: EntityTypedField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:130 + +*** + +### mime\_type? + +```ts +optional mime_type: EntityStringField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:132 + +*** + +### preview? + +```ts +optional preview: EntityImageField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:126 diff --git a/docs/english/reference/web-api/interfaces/FileEntitySlackFile.md b/docs/english/reference/web-api/interfaces/FileEntitySlackFile.md new file mode 100644 index 000000000..d1a841d88 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/FileEntitySlackFile.md @@ -0,0 +1,25 @@ +[@slack/web-api](../index.md) / FileEntitySlackFile + +# Interface: FileEntitySlackFile + +Defined in: packages/types/dist/message-metadata.d.ts:69 + +## Properties + +### id + +```ts +id: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:70 + +*** + +### type? + +```ts +optional type: string; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:71 diff --git a/docs/english/reference/web-api/interfaces/FileInput.md b/docs/english/reference/web-api/interfaces/FileInput.md index cf50f3a2d..f397ac5fc 100644 --- a/docs/english/reference/web-api/interfaces/FileInput.md +++ b/docs/english/reference/web-api/interfaces/FileInput.md @@ -2,7 +2,7 @@ # Interface: FileInput -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:166 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:169 ## Description @@ -25,7 +25,7 @@ your app must have the `files:read` scope. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -43,7 +43,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional filetypes: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:176 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:179 #### Description @@ -59,7 +59,7 @@ for convenience only, and you should perform your own file type validation based optional max_files: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:181 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:184 #### Description @@ -74,7 +74,7 @@ Maximum number of files that can be uploaded for this `file_input` element. Mini type: "file_input"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:170 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:173 #### Description diff --git a/docs/english/reference/web-api/interfaces/FilePublicEvent.md b/docs/english/reference/web-api/interfaces/FilePublicEvent.md index 7dec4b9a6..cee7e75e8 100644 --- a/docs/english/reference/web-api/interfaces/FilePublicEvent.md +++ b/docs/english/reference/web-api/interfaces/FilePublicEvent.md @@ -2,7 +2,7 @@ # Interface: FilePublicEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:31 +Defined in: packages/types/dist/events/file.d.ts:31 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:31 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:38 +Defined in: packages/types/dist/events/file.d.ts:38 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:38 file: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:35 +Defined in: packages/types/dist/events/file.d.ts:35 #### id @@ -38,7 +38,7 @@ id: string; file_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:33 +Defined in: packages/types/dist/events/file.d.ts:33 *** @@ -48,7 +48,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:33 type: "file_public"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:32 +Defined in: packages/types/dist/events/file.d.ts:32 *** @@ -58,4 +58,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:32 user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:34 +Defined in: packages/types/dist/events/file.d.ts:34 diff --git a/docs/english/reference/web-api/interfaces/FileShareMessageEvent.md b/docs/english/reference/web-api/interfaces/FileShareMessageEvent.md index 3e03ef342..0efc4e662 100644 --- a/docs/english/reference/web-api/interfaces/FileShareMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/FileShareMessageEvent.md @@ -2,7 +2,7 @@ # Interface: FileShareMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:161 +Defined in: packages/types/dist/events/message.d.ts:161 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional attachments: MessageAttachment[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:165 +Defined in: packages/types/dist/events/message.d.ts:165 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional blocks: (Block | KnownBlock)[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:166 +Defined in: packages/types/dist/events/message.d.ts:166 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:175 +Defined in: packages/types/dist/events/message.d.ts:175 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:176 +Defined in: packages/types/dist/events/message.d.ts:176 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional display_as_bot: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:169 +Defined in: packages/types/dist/events/message.d.ts:169 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:177 +Defined in: packages/types/dist/events/message.d.ts:177 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional files: File[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:167 +Defined in: packages/types/dist/events/message.d.ts:167 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional parent_user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:172 +Defined in: packages/types/dist/events/message.d.ts:172 *** @@ -92,7 +92,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "file_share"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:163 +Defined in: packages/types/dist/events/message.d.ts:163 *** @@ -102,7 +102,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:164 +Defined in: packages/types/dist/events/message.d.ts:164 *** @@ -112,7 +112,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional thread_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:174 +Defined in: packages/types/dist/events/message.d.ts:174 *** @@ -122,7 +122,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:173 +Defined in: packages/types/dist/events/message.d.ts:173 *** @@ -132,7 +132,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:162 +Defined in: packages/types/dist/events/message.d.ts:162 *** @@ -142,7 +142,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional upload: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:168 +Defined in: packages/types/dist/events/message.d.ts:168 *** @@ -152,7 +152,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:171 +Defined in: packages/types/dist/events/message.d.ts:171 *** @@ -162,4 +162,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional x_files: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:170 +Defined in: packages/types/dist/events/message.d.ts:170 diff --git a/docs/english/reference/web-api/interfaces/FileSharedEvent.md b/docs/english/reference/web-api/interfaces/FileSharedEvent.md index 607407d2f..06d4c70a4 100644 --- a/docs/english/reference/web-api/interfaces/FileSharedEvent.md +++ b/docs/english/reference/web-api/interfaces/FileSharedEvent.md @@ -2,7 +2,7 @@ # Interface: FileSharedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:40 +Defined in: packages/types/dist/events/file.d.ts:40 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:40 channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:47 +Defined in: packages/types/dist/events/file.d.ts:47 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:47 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:48 +Defined in: packages/types/dist/events/file.d.ts:48 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:48 file: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:44 +Defined in: packages/types/dist/events/file.d.ts:44 #### id @@ -48,7 +48,7 @@ id: string; file_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:42 +Defined in: packages/types/dist/events/file.d.ts:42 *** @@ -58,7 +58,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:42 type: "file_shared"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:41 +Defined in: packages/types/dist/events/file.d.ts:41 *** @@ -68,4 +68,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:41 user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:43 +Defined in: packages/types/dist/events/file.d.ts:43 diff --git a/docs/english/reference/web-api/interfaces/FileUnsharedEvent.md b/docs/english/reference/web-api/interfaces/FileUnsharedEvent.md index d2b9ee081..dac380f8e 100644 --- a/docs/english/reference/web-api/interfaces/FileUnsharedEvent.md +++ b/docs/english/reference/web-api/interfaces/FileUnsharedEvent.md @@ -2,7 +2,7 @@ # Interface: FileUnsharedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:50 +Defined in: packages/types/dist/events/file.d.ts:50 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:50 channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:57 +Defined in: packages/types/dist/events/file.d.ts:57 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:57 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:58 +Defined in: packages/types/dist/events/file.d.ts:58 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:58 file: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:54 +Defined in: packages/types/dist/events/file.d.ts:54 #### id @@ -48,7 +48,7 @@ id: string; file_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:52 +Defined in: packages/types/dist/events/file.d.ts:52 *** @@ -58,7 +58,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:52 type: "file_unshared"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:51 +Defined in: packages/types/dist/events/file.d.ts:51 *** @@ -68,4 +68,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:51 user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/file.d.ts:53 +Defined in: packages/types/dist/events/file.d.ts:53 diff --git a/docs/english/reference/web-api/interfaces/Focusable.md b/docs/english/reference/web-api/interfaces/Focusable.md index a797fa681..212554c17 100644 --- a/docs/english/reference/web-api/interfaces/Focusable.md +++ b/docs/english/reference/web-api/interfaces/Focusable.md @@ -2,7 +2,7 @@ # Interface: Focusable -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:30 +Defined in: packages/types/dist/block-kit/extensions.d.ts:30 ## Extended by @@ -35,7 +35,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extension optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description diff --git a/docs/english/reference/web-api/interfaces/FunctionExecutedEvent.md b/docs/english/reference/web-api/interfaces/FunctionExecutedEvent.md index bf2184184..25e9ff7e9 100644 --- a/docs/english/reference/web-api/interfaces/FunctionExecutedEvent.md +++ b/docs/english/reference/web-api/interfaces/FunctionExecutedEvent.md @@ -2,7 +2,7 @@ # Interface: FunctionExecutedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.ts:11 +Defined in: packages/types/dist/events/function.d.ts:11 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.t bot_access_token: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.ts:30 +Defined in: packages/types/dist/events/function.d.ts:30 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.t event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.ts:29 +Defined in: packages/types/dist/events/function.d.ts:29 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.t function: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.ts:13 +Defined in: packages/types/dist/events/function.d.ts:13 #### app\_id @@ -108,7 +108,7 @@ type: string; function_execution_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.ts:27 +Defined in: packages/types/dist/events/function.d.ts:27 *** @@ -118,7 +118,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.t inputs: FunctionInputs; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.ts:26 +Defined in: packages/types/dist/events/function.d.ts:26 *** @@ -128,7 +128,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.t type: "function_executed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.ts:12 +Defined in: packages/types/dist/events/function.d.ts:12 *** @@ -138,4 +138,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.t workflow_execution_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/function.d.ts:28 +Defined in: packages/types/dist/events/function.d.ts:28 diff --git a/docs/english/reference/web-api/interfaces/GenericMessageEvent.md b/docs/english/reference/web-api/interfaces/GenericMessageEvent.md index f395fa739..ce3a1329f 100644 --- a/docs/english/reference/web-api/interfaces/GenericMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/GenericMessageEvent.md @@ -2,7 +2,7 @@ # Interface: GenericMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:7 +Defined in: packages/types/dist/events/message.d.ts:7 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional assistant_thread: Record; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:36 +Defined in: packages/types/dist/events/message.d.ts:36 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional attachments: MessageAttachment[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:20 +Defined in: packages/types/dist/events/message.d.ts:20 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional blocks: (Block | KnownBlock)[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:21 +Defined in: packages/types/dist/events/message.d.ts:21 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional bot_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:14 +Defined in: packages/types/dist/events/message.d.ts:14 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional bot_profile: BotProfile; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:15 +Defined in: packages/types/dist/events/message.d.ts:15 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:12 +Defined in: packages/types/dist/events/message.d.ts:12 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:19 +Defined in: packages/types/dist/events/message.d.ts:19 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional client_msg_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:27 +Defined in: packages/types/dist/events/message.d.ts:27 *** @@ -92,7 +92,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional edited: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:23 +Defined in: packages/types/dist/events/message.d.ts:23 #### ts @@ -114,7 +114,7 @@ user: string; event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:10 +Defined in: packages/types/dist/events/message.d.ts:10 *** @@ -124,7 +124,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional files: File[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:22 +Defined in: packages/types/dist/events/message.d.ts:22 *** @@ -134,7 +134,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional is_starred: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:29 +Defined in: packages/types/dist/events/message.d.ts:29 *** @@ -144,7 +144,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional parent_user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:28 +Defined in: packages/types/dist/events/message.d.ts:28 *** @@ -154,7 +154,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional pinned_to: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:30 +Defined in: packages/types/dist/events/message.d.ts:30 *** @@ -164,7 +164,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional reactions: object[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:31 +Defined in: packages/types/dist/events/message.d.ts:31 #### count @@ -192,7 +192,7 @@ users: string[]; subtype: undefined; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:9 +Defined in: packages/types/dist/events/message.d.ts:9 *** @@ -202,7 +202,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional team: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:11 +Defined in: packages/types/dist/events/message.d.ts:11 *** @@ -212,7 +212,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:16 +Defined in: packages/types/dist/events/message.d.ts:16 *** @@ -222,7 +222,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional thread_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:18 +Defined in: packages/types/dist/events/message.d.ts:18 *** @@ -232,7 +232,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:17 +Defined in: packages/types/dist/events/message.d.ts:17 *** @@ -242,7 +242,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:8 +Defined in: packages/types/dist/events/message.d.ts:8 *** @@ -252,4 +252,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:13 +Defined in: packages/types/dist/events/message.d.ts:13 diff --git a/docs/english/reference/web-api/interfaces/GridMigrationFinishedEvent.md b/docs/english/reference/web-api/interfaces/GridMigrationFinishedEvent.md index e8b6a38d4..42f105592 100644 --- a/docs/english/reference/web-api/interfaces/GridMigrationFinishedEvent.md +++ b/docs/english/reference/web-api/interfaces/GridMigrationFinishedEvent.md @@ -2,7 +2,7 @@ # Interface: GridMigrationFinishedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/grid-migration.d.ts:1 +Defined in: packages/types/dist/events/grid-migration.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/grid-migrati enterprise_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/grid-migration.d.ts:3 +Defined in: packages/types/dist/events/grid-migration.d.ts:3 *** @@ -22,4 +22,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/grid-migrati type: "grid_migration_finished"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/grid-migration.d.ts:2 +Defined in: packages/types/dist/events/grid-migration.d.ts:2 diff --git a/docs/english/reference/web-api/interfaces/GridMigrationStartedEvent.md b/docs/english/reference/web-api/interfaces/GridMigrationStartedEvent.md index ac06c9675..e887e85fe 100644 --- a/docs/english/reference/web-api/interfaces/GridMigrationStartedEvent.md +++ b/docs/english/reference/web-api/interfaces/GridMigrationStartedEvent.md @@ -2,7 +2,7 @@ # Interface: GridMigrationStartedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/grid-migration.d.ts:5 +Defined in: packages/types/dist/events/grid-migration.d.ts:5 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/grid-migrati enterprise_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/grid-migration.d.ts:7 +Defined in: packages/types/dist/events/grid-migration.d.ts:7 *** @@ -22,4 +22,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/grid-migrati type: "grid_migration_started"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/grid-migration.d.ts:6 +Defined in: packages/types/dist/events/grid-migration.d.ts:6 diff --git a/docs/english/reference/web-api/interfaces/GroupArchiveEvent.md b/docs/english/reference/web-api/interfaces/GroupArchiveEvent.md index 4bc5e47ff..dfd08da2c 100644 --- a/docs/english/reference/web-api/interfaces/GroupArchiveEvent.md +++ b/docs/english/reference/web-api/interfaces/GroupArchiveEvent.md @@ -2,7 +2,7 @@ # Interface: GroupArchiveEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:1 +Defined in: packages/types/dist/events/group.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:1 channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:3 +Defined in: packages/types/dist/events/group.d.ts:3 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:3 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:6 +Defined in: packages/types/dist/events/group.d.ts:6 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:6 is_moved: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:5 +Defined in: packages/types/dist/events/group.d.ts:5 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:5 type: "group_archive"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:2 +Defined in: packages/types/dist/events/group.d.ts:2 *** @@ -52,4 +52,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:2 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:4 +Defined in: packages/types/dist/events/group.d.ts:4 diff --git a/docs/english/reference/web-api/interfaces/GroupCloseEvent.md b/docs/english/reference/web-api/interfaces/GroupCloseEvent.md index 451c4d4ba..e658f23a0 100644 --- a/docs/english/reference/web-api/interfaces/GroupCloseEvent.md +++ b/docs/english/reference/web-api/interfaces/GroupCloseEvent.md @@ -2,7 +2,7 @@ # Interface: GroupCloseEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:8 +Defined in: packages/types/dist/events/group.d.ts:8 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:8 channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:11 +Defined in: packages/types/dist/events/group.d.ts:11 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:1 type: "group_close"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:9 +Defined in: packages/types/dist/events/group.d.ts:9 *** @@ -32,4 +32,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:9 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:10 +Defined in: packages/types/dist/events/group.d.ts:10 diff --git a/docs/english/reference/web-api/interfaces/GroupDeletedEvent.md b/docs/english/reference/web-api/interfaces/GroupDeletedEvent.md index 65095cd39..fa6b1066f 100644 --- a/docs/english/reference/web-api/interfaces/GroupDeletedEvent.md +++ b/docs/english/reference/web-api/interfaces/GroupDeletedEvent.md @@ -2,7 +2,7 @@ # Interface: GroupDeletedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:13 +Defined in: packages/types/dist/events/group.d.ts:13 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:1 actor_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:17 +Defined in: packages/types/dist/events/group.d.ts:17 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:1 channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:15 +Defined in: packages/types/dist/events/group.d.ts:15 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:1 date_deleted: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:16 +Defined in: packages/types/dist/events/group.d.ts:16 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:1 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:18 +Defined in: packages/types/dist/events/group.d.ts:18 *** @@ -52,4 +52,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:1 type: "group_deleted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:14 +Defined in: packages/types/dist/events/group.d.ts:14 diff --git a/docs/english/reference/web-api/interfaces/GroupHistoryChangedEvent.md b/docs/english/reference/web-api/interfaces/GroupHistoryChangedEvent.md index cbbdc1bf0..d1f7758d9 100644 --- a/docs/english/reference/web-api/interfaces/GroupHistoryChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/GroupHistoryChangedEvent.md @@ -2,7 +2,7 @@ # Interface: GroupHistoryChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:20 +Defined in: packages/types/dist/events/group.d.ts:20 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:2 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:24 +Defined in: packages/types/dist/events/group.d.ts:24 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:2 latest: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:22 +Defined in: packages/types/dist/events/group.d.ts:22 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:2 ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:23 +Defined in: packages/types/dist/events/group.d.ts:23 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:2 type: "group_history_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:21 +Defined in: packages/types/dist/events/group.d.ts:21 diff --git a/docs/english/reference/web-api/interfaces/GroupLeftEvent.md b/docs/english/reference/web-api/interfaces/GroupLeftEvent.md index 63f8f01ad..c551e0b0b 100644 --- a/docs/english/reference/web-api/interfaces/GroupLeftEvent.md +++ b/docs/english/reference/web-api/interfaces/GroupLeftEvent.md @@ -2,7 +2,7 @@ # Interface: GroupLeftEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:26 +Defined in: packages/types/dist/events/group.d.ts:26 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:2 actor_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:29 +Defined in: packages/types/dist/events/group.d.ts:29 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:2 channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:28 +Defined in: packages/types/dist/events/group.d.ts:28 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:2 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:30 +Defined in: packages/types/dist/events/group.d.ts:30 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:3 type: "group_left"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:27 +Defined in: packages/types/dist/events/group.d.ts:27 diff --git a/docs/english/reference/web-api/interfaces/GroupOpenEvent.md b/docs/english/reference/web-api/interfaces/GroupOpenEvent.md index 386fd53be..02c0b537c 100644 --- a/docs/english/reference/web-api/interfaces/GroupOpenEvent.md +++ b/docs/english/reference/web-api/interfaces/GroupOpenEvent.md @@ -2,7 +2,7 @@ # Interface: GroupOpenEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:32 +Defined in: packages/types/dist/events/group.d.ts:32 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:3 channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:35 +Defined in: packages/types/dist/events/group.d.ts:35 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:3 type: "group_open"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:33 +Defined in: packages/types/dist/events/group.d.ts:33 *** @@ -32,4 +32,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:3 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:34 +Defined in: packages/types/dist/events/group.d.ts:34 diff --git a/docs/english/reference/web-api/interfaces/GroupRenameEvent.md b/docs/english/reference/web-api/interfaces/GroupRenameEvent.md index e2eccf85d..20669c971 100644 --- a/docs/english/reference/web-api/interfaces/GroupRenameEvent.md +++ b/docs/english/reference/web-api/interfaces/GroupRenameEvent.md @@ -2,7 +2,7 @@ # Interface: GroupRenameEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:37 +Defined in: packages/types/dist/events/group.d.ts:37 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:3 channel: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:39 +Defined in: packages/types/dist/events/group.d.ts:39 #### created @@ -58,7 +58,7 @@ name_normalized: string; event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:47 +Defined in: packages/types/dist/events/group.d.ts:47 *** @@ -68,4 +68,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:4 type: "group_rename"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:38 +Defined in: packages/types/dist/events/group.d.ts:38 diff --git a/docs/english/reference/web-api/interfaces/GroupUnarchiveEvent.md b/docs/english/reference/web-api/interfaces/GroupUnarchiveEvent.md index 27bdfa678..5f2d0a018 100644 --- a/docs/english/reference/web-api/interfaces/GroupUnarchiveEvent.md +++ b/docs/english/reference/web-api/interfaces/GroupUnarchiveEvent.md @@ -2,7 +2,7 @@ # Interface: GroupUnarchiveEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:49 +Defined in: packages/types/dist/events/group.d.ts:49 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:4 actor_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:52 +Defined in: packages/types/dist/events/group.d.ts:52 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:5 channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:51 +Defined in: packages/types/dist/events/group.d.ts:51 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:5 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:53 +Defined in: packages/types/dist/events/group.d.ts:53 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:5 type: "group_unarchive"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/group.d.ts:50 +Defined in: packages/types/dist/events/group.d.ts:50 diff --git a/docs/english/reference/web-api/interfaces/HeaderBlock.md b/docs/english/reference/web-api/interfaces/HeaderBlock.md index 22edb83da..848e2c282 100644 --- a/docs/english/reference/web-api/interfaces/HeaderBlock.md +++ b/docs/english/reference/web-api/interfaces/HeaderBlock.md @@ -2,7 +2,7 @@ # Interface: HeaderBlock -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:121 +Defined in: packages/types/dist/block-kit/blocks.d.ts:122 ## Description @@ -25,7 +25,7 @@ font. Use it to delineate between different groups of content in your app's surf optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -47,7 +47,7 @@ a message. If a message is updated, use a new `block_id`. text: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:130 +Defined in: packages/types/dist/block-kit/blocks.d.ts:131 #### Description @@ -62,7 +62,7 @@ Maximum length for the text in this field is 150 characters. type: "header"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:125 +Defined in: packages/types/dist/block-kit/blocks.d.ts:126 #### Description diff --git a/docs/english/reference/web-api/interfaces/HomeView.md b/docs/english/reference/web-api/interfaces/HomeView.md index b7c635ecf..b36daeaaa 100644 --- a/docs/english/reference/web-api/interfaces/HomeView.md +++ b/docs/english/reference/web-api/interfaces/HomeView.md @@ -2,7 +2,7 @@ # Interface: HomeView -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:22 +Defined in: packages/types/dist/views.d.ts:22 ## Extends @@ -16,7 +16,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:22 blocks: AnyBlock[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:5 +Defined in: packages/types/dist/views.d.ts:5 #### Description @@ -36,7 +36,7 @@ BaseView.blocks optional callback_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:18 +Defined in: packages/types/dist/views.d.ts:18 #### Description @@ -61,7 +61,7 @@ BaseView.callback_id optional external_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:20 +Defined in: packages/types/dist/views.d.ts:20 #### Description @@ -81,7 +81,7 @@ BaseView.external_id optional private_metadata: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:12 +Defined in: packages/types/dist/views.d.ts:12 #### Description @@ -104,7 +104,7 @@ BaseView.private_metadata type: "home"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:24 +Defined in: packages/types/dist/views.d.ts:24 #### Description diff --git a/docs/english/reference/web-api/interfaces/IMCloseEvent.md b/docs/english/reference/web-api/interfaces/IMCloseEvent.md index e8d0b792d..53f43ed74 100644 --- a/docs/english/reference/web-api/interfaces/IMCloseEvent.md +++ b/docs/english/reference/web-api/interfaces/IMCloseEvent.md @@ -2,7 +2,7 @@ # Interface: IMCloseEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:1 +Defined in: packages/types/dist/events/im.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:1 channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:4 +Defined in: packages/types/dist/events/im.d.ts:4 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:4 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:5 +Defined in: packages/types/dist/events/im.d.ts:5 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:5 type: "im_close"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:2 +Defined in: packages/types/dist/events/im.d.ts:2 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:2 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:3 +Defined in: packages/types/dist/events/im.d.ts:3 diff --git a/docs/english/reference/web-api/interfaces/IMCreatedEvent.md b/docs/english/reference/web-api/interfaces/IMCreatedEvent.md index 65eba4d0a..21cdec560 100644 --- a/docs/english/reference/web-api/interfaces/IMCreatedEvent.md +++ b/docs/english/reference/web-api/interfaces/IMCreatedEvent.md @@ -2,7 +2,7 @@ # Interface: IMCreatedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:7 +Defined in: packages/types/dist/events/im.d.ts:7 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:7 channel: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:10 +Defined in: packages/types/dist/events/im.d.ts:10 #### id @@ -28,7 +28,7 @@ id: string; type: "im_created"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:8 +Defined in: packages/types/dist/events/im.d.ts:8 *** @@ -38,4 +38,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:8 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:9 +Defined in: packages/types/dist/events/im.d.ts:9 diff --git a/docs/english/reference/web-api/interfaces/IMHistoryChangedEvent.md b/docs/english/reference/web-api/interfaces/IMHistoryChangedEvent.md index 3cf88c0bb..836addb26 100644 --- a/docs/english/reference/web-api/interfaces/IMHistoryChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/IMHistoryChangedEvent.md @@ -2,7 +2,7 @@ # Interface: IMHistoryChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:14 +Defined in: packages/types/dist/events/im.d.ts:14 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:14 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:18 +Defined in: packages/types/dist/events/im.d.ts:18 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:18 latest: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:16 +Defined in: packages/types/dist/events/im.d.ts:16 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:16 ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:17 +Defined in: packages/types/dist/events/im.d.ts:17 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:17 type: "im_history_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:15 +Defined in: packages/types/dist/events/im.d.ts:15 diff --git a/docs/english/reference/web-api/interfaces/IMOpenEvent.md b/docs/english/reference/web-api/interfaces/IMOpenEvent.md index 3bf5f3e07..d692527bb 100644 --- a/docs/english/reference/web-api/interfaces/IMOpenEvent.md +++ b/docs/english/reference/web-api/interfaces/IMOpenEvent.md @@ -2,7 +2,7 @@ # Interface: IMOpenEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:20 +Defined in: packages/types/dist/events/im.d.ts:20 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:20 channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:23 +Defined in: packages/types/dist/events/im.d.ts:23 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:23 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:24 +Defined in: packages/types/dist/events/im.d.ts:24 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:24 type: "im_open"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:21 +Defined in: packages/types/dist/events/im.d.ts:21 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:21 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/im.d.ts:22 +Defined in: packages/types/dist/events/im.d.ts:22 diff --git a/docs/english/reference/web-api/interfaces/IconButton.md b/docs/english/reference/web-api/interfaces/IconButton.md index 789e8e0de..61122835d 100644 --- a/docs/english/reference/web-api/interfaces/IconButton.md +++ b/docs/english/reference/web-api/interfaces/IconButton.md @@ -2,12 +2,16 @@ # Interface: IconButton -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:186 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:190 ## Description An icon button to perform actions. +## See + +[Icon button element reference](https://docs.slack.dev/reference/block-kit/block-elements/icon-button-element). + ## Extends - [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md) @@ -20,7 +24,7 @@ An icon button to perform actions. optional accessibility_label: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:204 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:208 #### Description @@ -34,7 +38,7 @@ A label for longer descriptive text about a button element. This label will be r optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -52,7 +56,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -71,7 +75,7 @@ with. icon: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:195 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:199 #### Description @@ -91,7 +95,7 @@ trash text: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:200 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:204 #### Description @@ -109,7 +113,7 @@ Defines an object containing some text. type: "icon_button"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:190 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:194 #### Description @@ -127,7 +131,7 @@ The type of element. In this case `type` is always `icon_button`. optional value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:208 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:212 #### Description @@ -141,7 +145,7 @@ The button value. optional visible_to_user_ids: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:212 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:216 #### Description diff --git a/docs/english/reference/web-api/interfaces/IncidentEntityFields.md b/docs/english/reference/web-api/interfaces/IncidentEntityFields.md new file mode 100644 index 000000000..07299fc09 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/IncidentEntityFields.md @@ -0,0 +1,95 @@ +[@slack/web-api](../index.md) / IncidentEntityFields + +# Interface: IncidentEntityFields + +Defined in: packages/types/dist/message-metadata.d.ts:145 + +## Properties + +### assigned\_to? + +```ts +optional assigned_to: EntityTypedField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:150 + +*** + +### created\_by? + +```ts +optional created_by: EntityTypedField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:149 + +*** + +### date\_created? + +```ts +optional date_created: EntityTimestampField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:151 + +*** + +### date\_updated? + +```ts +optional date_updated: EntityTimestampField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:152 + +*** + +### description? + +```ts +optional description: EntityStringField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:153 + +*** + +### priority? + +```ts +optional priority: EntityStringField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:147 + +*** + +### service? + +```ts +optional service: EntityStringField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:154 + +*** + +### status? + +```ts +optional status: EntityStringField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:146 + +*** + +### urgency? + +```ts +optional urgency: EntityStringField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:148 diff --git a/docs/english/reference/web-api/interfaces/InputBlock.md b/docs/english/reference/web-api/interfaces/InputBlock.md index 89d26e747..37cf7b8d6 100644 --- a/docs/english/reference/web-api/interfaces/InputBlock.md +++ b/docs/english/reference/web-api/interfaces/InputBlock.md @@ -2,7 +2,7 @@ # Interface: InputBlock -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:163 +Defined in: packages/types/dist/block-kit/blocks.d.ts:164 ## Description @@ -26,7 +26,7 @@ Collects information from users via block elements. optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -48,7 +48,7 @@ a message. If a message is updated, use a new `block_id`. optional dispatch_action: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:191 +Defined in: packages/types/dist/block-kit/blocks.d.ts:192 #### Description @@ -63,7 +63,7 @@ A boolean that indicates whether or not the use of elements in this block should element: InputBlockElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:186 +Defined in: packages/types/dist/block-kit/blocks.d.ts:187 #### Description @@ -77,7 +77,7 @@ A block element. optional hint: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:177 +Defined in: packages/types/dist/block-kit/blocks.d.ts:178 #### Description @@ -92,7 +92,7 @@ An optional hint that appears below an input element in a lighter grey. It must label: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:172 +Defined in: packages/types/dist/block-kit/blocks.d.ts:173 #### Description @@ -107,7 +107,7 @@ Maximum length for the text in this field is 2000 characters. optional optional: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:182 +Defined in: packages/types/dist/block-kit/blocks.d.ts:183 #### Description @@ -122,7 +122,7 @@ Defaults to `false`. type: "input"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:167 +Defined in: packages/types/dist/block-kit/blocks.d.ts:168 #### Description diff --git a/docs/english/reference/web-api/interfaces/InviteRequestedEvent.md b/docs/english/reference/web-api/interfaces/InviteRequestedEvent.md index 3ec1063d0..4057e70cb 100644 --- a/docs/english/reference/web-api/interfaces/InviteRequestedEvent.md +++ b/docs/english/reference/web-api/interfaces/InviteRequestedEvent.md @@ -2,7 +2,7 @@ # Interface: InviteRequestedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/invite.d.ts:1 +Defined in: packages/types/dist/events/invite.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/invite.d.ts: invite_request: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/invite.d.ts:3 +Defined in: packages/types/dist/events/invite.d.ts:3 #### channel\_ids @@ -100,4 +100,4 @@ name: string; type: "invite_requested"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/invite.d.ts:2 +Defined in: packages/types/dist/events/invite.d.ts:2 diff --git a/docs/english/reference/web-api/interfaces/LinkSharedEvent.md b/docs/english/reference/web-api/interfaces/LinkSharedEvent.md index be6591589..9e66d54ae 100644 --- a/docs/english/reference/web-api/interfaces/LinkSharedEvent.md +++ b/docs/english/reference/web-api/interfaces/LinkSharedEvent.md @@ -2,7 +2,7 @@ # Interface: LinkSharedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared.d.ts:1 +Defined in: packages/types/dist/events/link-shared.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared. channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared.d.ts:3 +Defined in: packages/types/dist/events/link-shared.d.ts:3 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared. event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared.d.ts:14 +Defined in: packages/types/dist/events/link-shared.d.ts:14 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared. is_bot_user_member: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared.d.ts:4 +Defined in: packages/types/dist/events/link-shared.d.ts:4 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared. links: object[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared.d.ts:8 +Defined in: packages/types/dist/events/link-shared.d.ts:8 #### domain @@ -64,7 +64,7 @@ url: string; message_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared.d.ts:6 +Defined in: packages/types/dist/events/link-shared.d.ts:6 *** @@ -74,7 +74,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared. optional source: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared.d.ts:13 +Defined in: packages/types/dist/events/link-shared.d.ts:13 *** @@ -84,7 +84,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared. optional thread_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared.d.ts:7 +Defined in: packages/types/dist/events/link-shared.d.ts:7 *** @@ -94,7 +94,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared. type: "link_shared"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared.d.ts:2 +Defined in: packages/types/dist/events/link-shared.d.ts:2 *** @@ -104,7 +104,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared. optional unfurl_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared.d.ts:12 +Defined in: packages/types/dist/events/link-shared.d.ts:12 *** @@ -114,4 +114,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared. user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/link-shared.d.ts:5 +Defined in: packages/types/dist/events/link-shared.d.ts:5 diff --git a/docs/english/reference/web-api/interfaces/LinkUnfurls.md b/docs/english/reference/web-api/interfaces/LinkUnfurls.md index ac145a04f..968c95934 100644 --- a/docs/english/reference/web-api/interfaces/LinkUnfurls.md +++ b/docs/english/reference/web-api/interfaces/LinkUnfurls.md @@ -2,7 +2,7 @@ # Interface: LinkUnfurls -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:167 +Defined in: packages/types/dist/message-attachments.d.ts:167 ## Indexable diff --git a/docs/english/reference/web-api/interfaces/Logger.md b/docs/english/reference/web-api/interfaces/Logger.md index 0bd4fb79c..576a1c084 100644 --- a/docs/english/reference/web-api/interfaces/Logger.md +++ b/docs/english/reference/web-api/interfaces/Logger.md @@ -2,7 +2,7 @@ # Interface: Logger -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:13 +Defined in: packages/logger/dist/index.d.ts:13 Interface for objects where objects in this package's logs can be sent (can be used as `logger` option). @@ -14,7 +14,7 @@ Interface for objects where objects in this package's logs can be sent (can be u debug(...msg): void; ``` -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:18 +Defined in: packages/logger/dist/index.d.ts:18 Output debug message @@ -38,7 +38,7 @@ any data to log error(...msg): void; ``` -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:33 +Defined in: packages/logger/dist/index.d.ts:33 Output error message @@ -62,7 +62,7 @@ any data to log getLevel(): LogLevel; ``` -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:43 +Defined in: packages/logger/dist/index.d.ts:43 Return the current LogLevel. @@ -78,7 +78,7 @@ Return the current LogLevel. info(...msg): void; ``` -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:23 +Defined in: packages/logger/dist/index.d.ts:23 Output info message @@ -102,7 +102,7 @@ any data to log setLevel(level): void; ``` -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:39 +Defined in: packages/logger/dist/index.d.ts:39 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. @@ -127,7 +127,7 @@ as a string, like 'error' (case-insensitive) setName(name): void; ``` -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:49 +Defined in: packages/logger/dist/index.d.ts:49 This allows the instance to be named so that they can easily be filtered when many loggers are sending output to the same destination. @@ -152,7 +152,7 @@ as a string, will be output with every log after the level warn(...msg): void; ``` -Defined in: packages/web-api/node\_modules/@slack/logger/dist/index.d.ts:28 +Defined in: packages/logger/dist/index.d.ts:28 Output warn message diff --git a/docs/english/reference/web-api/interfaces/MarkdownBlock.md b/docs/english/reference/web-api/interfaces/MarkdownBlock.md index adda1b5ca..d201d4ebc 100644 --- a/docs/english/reference/web-api/interfaces/MarkdownBlock.md +++ b/docs/english/reference/web-api/interfaces/MarkdownBlock.md @@ -2,7 +2,7 @@ # Interface: MarkdownBlock -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:199 +Defined in: packages/types/dist/block-kit/blocks.d.ts:200 ## Description @@ -26,7 +26,7 @@ appears as intended. Note that passing a single block may result in multiple blo optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -48,7 +48,7 @@ a message. If a message is updated, use a new `block_id`. text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:207 +Defined in: packages/types/dist/block-kit/blocks.d.ts:208 #### Description @@ -62,7 +62,7 @@ The standard markdown-formatted text. Limit 12,000 characters max. type: "markdown"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:203 +Defined in: packages/types/dist/block-kit/blocks.d.ts:204 #### Description diff --git a/docs/english/reference/web-api/interfaces/MarkdownTextChunk.md b/docs/english/reference/web-api/interfaces/MarkdownTextChunk.md new file mode 100644 index 000000000..a9dc242b9 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/MarkdownTextChunk.md @@ -0,0 +1,36 @@ +[@slack/web-api](../index.md) / MarkdownTextChunk + +# Interface: MarkdownTextChunk + +Defined in: packages/types/dist/chunk.d.ts:13 + +Used for streaming text content with markdown formatting support. +https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming + +## Extends + +- [`Chunk`](Chunk.md) + +## Properties + +### text + +```ts +text: string; +``` + +Defined in: packages/types/dist/chunk.d.ts:15 + +*** + +### type + +```ts +type: "markdown_text"; +``` + +Defined in: packages/types/dist/chunk.d.ts:14 + +#### Overrides + +[`Chunk`](Chunk.md).[`type`](Chunk.md#type) diff --git a/docs/english/reference/web-api/interfaces/MaxItemsSelectable.md b/docs/english/reference/web-api/interfaces/MaxItemsSelectable.md index ad20730d5..61e416b5c 100644 --- a/docs/english/reference/web-api/interfaces/MaxItemsSelectable.md +++ b/docs/english/reference/web-api/interfaces/MaxItemsSelectable.md @@ -2,7 +2,7 @@ # Interface: MaxItemsSelectable -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:38 +Defined in: packages/types/dist/block-kit/extensions.d.ts:38 ## Extended by @@ -20,7 +20,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extension optional max_selected_items: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:42 +Defined in: packages/types/dist/block-kit/extensions.d.ts:42 #### Description diff --git a/docs/english/reference/web-api/interfaces/MeMessageEvent.md b/docs/english/reference/web-api/interfaces/MeMessageEvent.md index 4c3d98ca4..c91b5ccf0 100644 --- a/docs/english/reference/web-api/interfaces/MeMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/MeMessageEvent.md @@ -2,7 +2,7 @@ # Interface: MeMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:179 +Defined in: packages/types/dist/events/message.d.ts:179 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:183 +Defined in: packages/types/dist/events/message.d.ts:183 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:184 +Defined in: packages/types/dist/events/message.d.ts:184 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:182 +Defined in: packages/types/dist/events/message.d.ts:182 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "me_message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:181 +Defined in: packages/types/dist/events/message.d.ts:181 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:186 +Defined in: packages/types/dist/events/message.d.ts:186 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:187 +Defined in: packages/types/dist/events/message.d.ts:187 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:180 +Defined in: packages/types/dist/events/message.d.ts:180 *** @@ -82,4 +82,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:185 +Defined in: packages/types/dist/events/message.d.ts:185 diff --git a/docs/english/reference/web-api/interfaces/MemberJoinedChannelEvent.md b/docs/english/reference/web-api/interfaces/MemberJoinedChannelEvent.md index 34c72bc32..c2532fb3e 100644 --- a/docs/english/reference/web-api/interfaces/MemberJoinedChannelEvent.md +++ b/docs/english/reference/web-api/interfaces/MemberJoinedChannelEvent.md @@ -2,7 +2,7 @@ # Interface: MemberJoinedChannelEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:1 +Defined in: packages/types/dist/events/member.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:4 +Defined in: packages/types/dist/events/member.d.ts:4 *** @@ -22,7 +22,17 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: channel_type: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:5 +Defined in: packages/types/dist/events/member.d.ts:5 + +*** + +### enterprise? + +```ts +optional enterprise: string; +``` + +Defined in: packages/types/dist/events/member.d.ts:8 *** @@ -32,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:8 +Defined in: packages/types/dist/events/member.d.ts:9 *** @@ -42,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: optional inviter: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:7 +Defined in: packages/types/dist/events/member.d.ts:7 *** @@ -52,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: team: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:6 +Defined in: packages/types/dist/events/member.d.ts:6 *** @@ -62,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: type: "member_joined_channel"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:2 +Defined in: packages/types/dist/events/member.d.ts:2 *** @@ -72,4 +82,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:3 +Defined in: packages/types/dist/events/member.d.ts:3 diff --git a/docs/english/reference/web-api/interfaces/MemberLeftChannelEvent.md b/docs/english/reference/web-api/interfaces/MemberLeftChannelEvent.md index c941e8e97..5d575d136 100644 --- a/docs/english/reference/web-api/interfaces/MemberLeftChannelEvent.md +++ b/docs/english/reference/web-api/interfaces/MemberLeftChannelEvent.md @@ -2,7 +2,7 @@ # Interface: MemberLeftChannelEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:10 +Defined in: packages/types/dist/events/member.d.ts:11 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:13 +Defined in: packages/types/dist/events/member.d.ts:14 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: channel_type: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:14 +Defined in: packages/types/dist/events/member.d.ts:15 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:16 +Defined in: packages/types/dist/events/member.d.ts:17 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: team: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:15 +Defined in: packages/types/dist/events/member.d.ts:16 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: type: "member_left_channel"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:11 +Defined in: packages/types/dist/events/member.d.ts:12 *** @@ -62,4 +62,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts: user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/member.d.ts:12 +Defined in: packages/types/dist/events/member.d.ts:13 diff --git a/docs/english/reference/web-api/interfaces/MessageAttachment.md b/docs/english/reference/web-api/interfaces/MessageAttachment.md index f620a16dd..e50cf767a 100644 --- a/docs/english/reference/web-api/interfaces/MessageAttachment.md +++ b/docs/english/reference/web-api/interfaces/MessageAttachment.md @@ -2,7 +2,7 @@ # Interface: MessageAttachment -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:8 +Defined in: packages/types/dist/message-attachments.d.ts:8 Add [secondary attachments](https://docs.slack.dev/messaging/formatting-message-text#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://docs.slack.dev/messaging/formatting-message-text#attachments). @@ -19,7 +19,7 @@ Message attachments are considered a legacy part of messaging functionality. The optional actions: AttachmentAction[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:97 +Defined in: packages/types/dist/message-attachments.d.ts:97 *** @@ -29,7 +29,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments optional app_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:107 +Defined in: packages/types/dist/message-attachments.d.ts:107 *** @@ -39,7 +39,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments optional app_unfurl_url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:105 +Defined in: packages/types/dist/message-attachments.d.ts:105 *** @@ -49,7 +49,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments optional author_icon: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:41 +Defined in: packages/types/dist/message-attachments.d.ts:41 #### Description @@ -64,7 +64,7 @@ Will only work if `author_name` is present. optional author_link: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:36 +Defined in: packages/types/dist/message-attachments.d.ts:36 #### Description @@ -78,7 +78,7 @@ A valid URL that will hyperlink the `author_name` text. Will only work if `autho optional author_name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:32 +Defined in: packages/types/dist/message-attachments.d.ts:32 #### Description @@ -92,7 +92,7 @@ Small text used to display the author's name. optional author_subname: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:42 +Defined in: packages/types/dist/message-attachments.d.ts:42 *** @@ -102,7 +102,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments optional blocks: AnyBlock[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:13 +Defined in: packages/types/dist/message-attachments.d.ts:13 #### Description @@ -117,7 +117,7 @@ An array of [layout blocks](../type-aliases/KnownBlock.md) in the same format optional bot_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:108 +Defined in: packages/types/dist/message-attachments.d.ts:108 *** @@ -127,7 +127,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments optional callback_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:98 +Defined in: packages/types/dist/message-attachments.d.ts:98 *** @@ -137,7 +137,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments optional color: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:23 +Defined in: packages/types/dist/message-attachments.d.ts:23 #### Description @@ -152,7 +152,7 @@ be one of `good` (green), `warning` (yellow), `danger` (red), or any hex color c optional fallback: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:18 +Defined in: packages/types/dist/message-attachments.d.ts:18 #### Description @@ -167,7 +167,7 @@ don't show formatted text (e.g. mobile notifications). optional fields: MessageAttachmentField[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:63 +Defined in: packages/types/dist/message-attachments.d.ts:63 #### Description @@ -183,7 +183,7 @@ For best results, include no more than 2-3 field objects. optional footer: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:83 +Defined in: packages/types/dist/message-attachments.d.ts:83 #### Description @@ -198,7 +198,7 @@ and may be truncated further when displayed to users in environments with limite optional footer_icon: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:89 +Defined in: packages/types/dist/message-attachments.d.ts:89 #### Description @@ -214,7 +214,7 @@ It's best to use an image that is similarly sized. optional image_url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:70 +Defined in: packages/types/dist/message-attachments.d.ts:70 #### Description @@ -231,7 +231,7 @@ maintaining the original aspect ratio. Cannot be used with `thumb_url`. optional is_app_unfurl: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:106 +Defined in: packages/types/dist/message-attachments.d.ts:106 *** @@ -241,7 +241,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments optional mrkdwn_in: ("text" | "pretext" | "fields")[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:104 +Defined in: packages/types/dist/message-attachments.d.ts:104 #### Description @@ -257,7 +257,7 @@ the `text` or `pretext` properties. optional pretext: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:28 +Defined in: packages/types/dist/message-attachments.d.ts:28 #### Description @@ -272,7 +272,7 @@ or with [\`mrkdwn\`](https://docs.slack.dev/messaging/formatting-message-text#ba optional preview: MessageAttachmentPreview; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:109 +Defined in: packages/types/dist/message-attachments.d.ts:109 *** @@ -282,7 +282,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments optional text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:57 +Defined in: packages/types/dist/message-attachments.d.ts:57 #### Description @@ -299,7 +299,7 @@ a "Show more..." link to expand the content. optional thumb_url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:78 +Defined in: packages/types/dist/message-attachments.d.ts:78 #### Description @@ -317,7 +317,7 @@ For best results, please use images that are already 75px by 75px. optional title: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:46 +Defined in: packages/types/dist/message-attachments.d.ts:46 #### Description @@ -331,7 +331,7 @@ Large title text near the top of the attachment. optional title_link: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:50 +Defined in: packages/types/dist/message-attachments.d.ts:50 #### Description @@ -345,7 +345,7 @@ A valid URL that turns the `title` text into a hyperlink. optional ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:96 +Defined in: packages/types/dist/message-attachments.d.ts:96 #### Description diff --git a/docs/english/reference/web-api/interfaces/MessageAttachmentField.md b/docs/english/reference/web-api/interfaces/MessageAttachmentField.md index 4d0a4b836..6c7e9648b 100644 --- a/docs/english/reference/web-api/interfaces/MessageAttachmentField.md +++ b/docs/english/reference/web-api/interfaces/MessageAttachmentField.md @@ -2,7 +2,7 @@ # Interface: MessageAttachmentField -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:115 +Defined in: packages/types/dist/message-attachments.d.ts:115 ## Description @@ -20,7 +20,7 @@ A field object to include in a [MessageAttachment](MessageAttachment.md). optional short: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:129 +Defined in: packages/types/dist/message-attachments.d.ts:129 #### Description @@ -35,7 +35,7 @@ other field objects. Defaults to `false`. title: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:120 +Defined in: packages/types/dist/message-attachments.d.ts:120 #### Description @@ -50,7 +50,7 @@ will be escaped for you. value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-attachments.d.ts:124 +Defined in: packages/types/dist/message-attachments.d.ts:124 #### Description diff --git a/docs/english/reference/web-api/interfaces/MessageChangedEvent.md b/docs/english/reference/web-api/interfaces/MessageChangedEvent.md index b25920ca0..2c306a4ee 100644 --- a/docs/english/reference/web-api/interfaces/MessageChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/MessageChangedEvent.md @@ -2,7 +2,7 @@ # Interface: MessageChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:189 +Defined in: packages/types/dist/events/message.d.ts:189 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:194 +Defined in: packages/types/dist/events/message.d.ts:194 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:195 +Defined in: packages/types/dist/events/message.d.ts:195 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:192 +Defined in: packages/types/dist/events/message.d.ts:192 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts hidden: true; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:193 +Defined in: packages/types/dist/events/message.d.ts:193 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts message: AllMessageEvents; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:197 +Defined in: packages/types/dist/events/message.d.ts:197 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts previous_message: AllMessageEvents; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:198 +Defined in: packages/types/dist/events/message.d.ts:198 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "message_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:191 +Defined in: packages/types/dist/events/message.d.ts:191 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:196 +Defined in: packages/types/dist/events/message.d.ts:196 *** @@ -92,4 +92,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:190 +Defined in: packages/types/dist/events/message.d.ts:190 diff --git a/docs/english/reference/web-api/interfaces/MessageDeletedEvent.md b/docs/english/reference/web-api/interfaces/MessageDeletedEvent.md index 3908ec7e1..97e43285d 100644 --- a/docs/english/reference/web-api/interfaces/MessageDeletedEvent.md +++ b/docs/english/reference/web-api/interfaces/MessageDeletedEvent.md @@ -2,7 +2,7 @@ # Interface: MessageDeletedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:200 +Defined in: packages/types/dist/events/message.d.ts:200 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:205 +Defined in: packages/types/dist/events/message.d.ts:205 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:206 +Defined in: packages/types/dist/events/message.d.ts:206 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts deleted_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:208 +Defined in: packages/types/dist/events/message.d.ts:208 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:203 +Defined in: packages/types/dist/events/message.d.ts:203 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts hidden: true; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:204 +Defined in: packages/types/dist/events/message.d.ts:204 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts previous_message: AllMessageEvents; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:209 +Defined in: packages/types/dist/events/message.d.ts:209 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts subtype: "message_deleted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:202 +Defined in: packages/types/dist/events/message.d.ts:202 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:207 +Defined in: packages/types/dist/events/message.d.ts:207 *** @@ -92,4 +92,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:201 +Defined in: packages/types/dist/events/message.d.ts:201 diff --git a/docs/english/reference/web-api/interfaces/MessageMetadata.md b/docs/english/reference/web-api/interfaces/MessageMetadata.md index f3ecde52c..c3eece6f1 100644 --- a/docs/english/reference/web-api/interfaces/MessageMetadata.md +++ b/docs/english/reference/web-api/interfaces/MessageMetadata.md @@ -2,11 +2,11 @@ # Interface: MessageMetadata -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-metadata.d.ts:6 +Defined in: packages/types/dist/message-metadata.d.ts:7 ## Description -Application-specific data to attach to Slack message. +Application-specific event data to attach to a Slack message. ## See @@ -21,7 +21,7 @@ Application-specific data to attach to Slack message. event_payload: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-metadata.d.ts:15 +Defined in: packages/types/dist/message-metadata.d.ts:16 #### Index Signature @@ -46,7 +46,7 @@ A free-form object containing whatever data your application wishes to attach to event_type: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-metadata.d.ts:11 +Defined in: packages/types/dist/message-metadata.d.ts:12 #### Description diff --git a/docs/english/reference/web-api/interfaces/MessageMetadataDeletedEvent.md b/docs/english/reference/web-api/interfaces/MessageMetadataDeletedEvent.md index 34489e8d8..1109fa4a4 100644 --- a/docs/english/reference/web-api/interfaces/MessageMetadataDeletedEvent.md +++ b/docs/english/reference/web-api/interfaces/MessageMetadataDeletedEvent.md @@ -2,7 +2,7 @@ # Interface: MessageMetadataDeletedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:26 +Defined in: packages/types/dist/events/message-metadata.d.ts:26 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta app_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:31 +Defined in: packages/types/dist/events/message-metadata.d.ts:31 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta optional bot_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:32 +Defined in: packages/types/dist/events/message-metadata.d.ts:32 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:28 +Defined in: packages/types/dist/events/message-metadata.d.ts:28 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta deleted_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:36 +Defined in: packages/types/dist/events/message-metadata.d.ts:36 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:29 +Defined in: packages/types/dist/events/message-metadata.d.ts:29 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta message_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:35 +Defined in: packages/types/dist/events/message-metadata.d.ts:35 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta previous_metadata: MessageMetadata; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:30 +Defined in: packages/types/dist/events/message-metadata.d.ts:30 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:34 +Defined in: packages/types/dist/events/message-metadata.d.ts:34 *** @@ -92,7 +92,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta type: "message_metadata_deleted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:27 +Defined in: packages/types/dist/events/message-metadata.d.ts:27 *** @@ -102,4 +102,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:33 +Defined in: packages/types/dist/events/message-metadata.d.ts:33 diff --git a/docs/english/reference/web-api/interfaces/MessageMetadataEventPayloadObject.md b/docs/english/reference/web-api/interfaces/MessageMetadataEventPayloadObject.md index fdce339dd..6176f3551 100644 --- a/docs/english/reference/web-api/interfaces/MessageMetadataEventPayloadObject.md +++ b/docs/english/reference/web-api/interfaces/MessageMetadataEventPayloadObject.md @@ -2,7 +2,7 @@ # Interface: MessageMetadataEventPayloadObject -Defined in: packages/web-api/node\_modules/@slack/types/dist/message-metadata.d.ts:19 +Defined in: packages/types/dist/message-metadata.d.ts:20 ## Indexable diff --git a/docs/english/reference/web-api/interfaces/MessageMetadataPostedEvent.md b/docs/english/reference/web-api/interfaces/MessageMetadataPostedEvent.md index aa8f990cd..c42bd4a3a 100644 --- a/docs/english/reference/web-api/interfaces/MessageMetadataPostedEvent.md +++ b/docs/english/reference/web-api/interfaces/MessageMetadataPostedEvent.md @@ -2,7 +2,7 @@ # Interface: MessageMetadataPostedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:3 +Defined in: packages/types/dist/events/message-metadata.d.ts:3 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta app_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:5 +Defined in: packages/types/dist/events/message-metadata.d.ts:5 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta optional bot_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:6 +Defined in: packages/types/dist/events/message-metadata.d.ts:6 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:9 +Defined in: packages/types/dist/events/message-metadata.d.ts:9 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:12 +Defined in: packages/types/dist/events/message-metadata.d.ts:12 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta message_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:11 +Defined in: packages/types/dist/events/message-metadata.d.ts:11 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta metadata: MessageMetadata; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:10 +Defined in: packages/types/dist/events/message-metadata.d.ts:10 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:8 +Defined in: packages/types/dist/events/message-metadata.d.ts:8 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta type: "message_metadata_posted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:4 +Defined in: packages/types/dist/events/message-metadata.d.ts:4 *** @@ -92,4 +92,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:7 +Defined in: packages/types/dist/events/message-metadata.d.ts:7 diff --git a/docs/english/reference/web-api/interfaces/MessageMetadataUpdatedEvent.md b/docs/english/reference/web-api/interfaces/MessageMetadataUpdatedEvent.md index 1b22d2463..d64b981fb 100644 --- a/docs/english/reference/web-api/interfaces/MessageMetadataUpdatedEvent.md +++ b/docs/english/reference/web-api/interfaces/MessageMetadataUpdatedEvent.md @@ -2,7 +2,7 @@ # Interface: MessageMetadataUpdatedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:14 +Defined in: packages/types/dist/events/message-metadata.d.ts:14 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta app_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:19 +Defined in: packages/types/dist/events/message-metadata.d.ts:19 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta optional bot_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:20 +Defined in: packages/types/dist/events/message-metadata.d.ts:20 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:16 +Defined in: packages/types/dist/events/message-metadata.d.ts:16 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:17 +Defined in: packages/types/dist/events/message-metadata.d.ts:17 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta message_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:23 +Defined in: packages/types/dist/events/message-metadata.d.ts:23 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta metadata: MessageMetadata; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:24 +Defined in: packages/types/dist/events/message-metadata.d.ts:24 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta previous_metadata: MessageMetadata; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:18 +Defined in: packages/types/dist/events/message-metadata.d.ts:18 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:22 +Defined in: packages/types/dist/events/message-metadata.d.ts:22 *** @@ -92,7 +92,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta type: "message_metadata_updated"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:15 +Defined in: packages/types/dist/events/message-metadata.d.ts:15 *** @@ -102,4 +102,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-meta user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:21 +Defined in: packages/types/dist/events/message-metadata.d.ts:21 diff --git a/docs/english/reference/web-api/interfaces/MessageRepliedEvent.md b/docs/english/reference/web-api/interfaces/MessageRepliedEvent.md index 7fccd0326..527ba68c8 100644 --- a/docs/english/reference/web-api/interfaces/MessageRepliedEvent.md +++ b/docs/english/reference/web-api/interfaces/MessageRepliedEvent.md @@ -2,7 +2,7 @@ # Interface: MessageRepliedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:211 +Defined in: packages/types/dist/events/message.d.ts:211 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:216 +Defined in: packages/types/dist/events/message.d.ts:216 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:217 +Defined in: packages/types/dist/events/message.d.ts:217 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:214 +Defined in: packages/types/dist/events/message.d.ts:214 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts hidden: true; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:215 +Defined in: packages/types/dist/events/message.d.ts:215 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts message: AllMessageEvents & object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:219 +Defined in: packages/types/dist/events/message.d.ts:219 #### Type Declaration @@ -82,7 +82,7 @@ thread_ts: string; subtype: "message_replied"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:213 +Defined in: packages/types/dist/events/message.d.ts:213 *** @@ -92,7 +92,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:218 +Defined in: packages/types/dist/events/message.d.ts:218 *** @@ -102,4 +102,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:212 +Defined in: packages/types/dist/events/message.d.ts:212 diff --git a/docs/english/reference/web-api/interfaces/ModalView.md b/docs/english/reference/web-api/interfaces/ModalView.md index e116fc690..4525b863e 100644 --- a/docs/english/reference/web-api/interfaces/ModalView.md +++ b/docs/english/reference/web-api/interfaces/ModalView.md @@ -2,7 +2,7 @@ # Interface: ModalView -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:26 +Defined in: packages/types/dist/views.d.ts:26 ## Extends @@ -16,7 +16,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:26 blocks: AnyBlock[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:5 +Defined in: packages/types/dist/views.d.ts:5 #### Description @@ -36,7 +36,7 @@ BaseView.blocks optional callback_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:18 +Defined in: packages/types/dist/views.d.ts:18 #### Description @@ -61,7 +61,7 @@ BaseView.callback_id optional clear_on_close: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:49 +Defined in: packages/types/dist/views.d.ts:49 #### Description @@ -76,7 +76,7 @@ Defaults to `false`. optional close: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:38 +Defined in: packages/types/dist/views.d.ts:38 #### Description @@ -91,7 +91,7 @@ bottom-right of the view. Maximum length of 24 characters. optional external_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:20 +Defined in: packages/types/dist/views.d.ts:20 #### Description @@ -111,7 +111,7 @@ BaseView.external_id optional notify_on_close: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:55 +Defined in: packages/types/dist/views.d.ts:55 #### Description @@ -127,7 +127,7 @@ clicks the close button. Defaults to `false`. optional private_metadata: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:12 +Defined in: packages/types/dist/views.d.ts:12 #### Description @@ -150,7 +150,7 @@ BaseView.private_metadata optional submit: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:44 +Defined in: packages/types/dist/views.d.ts:44 #### Description @@ -166,7 +166,7 @@ characters. title: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:33 +Defined in: packages/types/dist/views.d.ts:33 #### Description @@ -181,7 +181,7 @@ maximum length of 24 characters. type: "modal"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:28 +Defined in: packages/types/dist/views.d.ts:28 #### Description diff --git a/docs/english/reference/web-api/interfaces/MrkdwnElement.md b/docs/english/reference/web-api/interfaces/MrkdwnElement.md index 46b576078..6a18c18bc 100644 --- a/docs/english/reference/web-api/interfaces/MrkdwnElement.md +++ b/docs/english/reference/web-api/interfaces/MrkdwnElement.md @@ -2,7 +2,7 @@ # Interface: MrkdwnElement -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:143 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:143 ## Description @@ -20,7 +20,7 @@ Defines an object containing some text. text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:152 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:152 #### Description @@ -35,7 +35,7 @@ The minimum length is 1 and maximum length is 3000 characters. type: "mrkdwn"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:147 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:147 #### Description @@ -49,7 +49,7 @@ The formatting to use for this text object. optional verbatim: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:159 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:159 #### Description diff --git a/docs/english/reference/web-api/interfaces/MrkdwnOption.md b/docs/english/reference/web-api/interfaces/MrkdwnOption.md index 8c39a09f2..20ec04fa9 100644 --- a/docs/english/reference/web-api/interfaces/MrkdwnOption.md +++ b/docs/english/reference/web-api/interfaces/MrkdwnOption.md @@ -2,7 +2,7 @@ # Interface: MrkdwnOption -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:80 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:80 ## Extends @@ -16,7 +16,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/compositi optional description: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:78 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:78 #### Description @@ -37,7 +37,7 @@ OptionDescriptor.description text: MrkdwnElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:85 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:85 #### Description @@ -52,7 +52,7 @@ radio buttons and checkboxes. Maximum length for the `text` in this field is 75 optional url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:73 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:73 #### Description @@ -73,7 +73,7 @@ OptionDescriptor.url optional value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:68 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:68 #### Description diff --git a/docs/english/reference/web-api/interfaces/MultiChannelsSelect.md b/docs/english/reference/web-api/interfaces/MultiChannelsSelect.md index 42f637e61..4f8400544 100644 --- a/docs/english/reference/web-api/interfaces/MultiChannelsSelect.md +++ b/docs/english/reference/web-api/interfaces/MultiChannelsSelect.md @@ -2,7 +2,7 @@ # Interface: MultiChannelsSelect -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:424 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:428 ## Description @@ -26,7 +26,7 @@ user in the active workspace. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -44,7 +44,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -63,7 +63,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_channels: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:432 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:436 #### Description @@ -97,7 +97,7 @@ An array of one or more IDs of any valid public channel to be pre-selected when optional max_selected_items: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:42 +Defined in: packages/types/dist/block-kit/extensions.d.ts:42 #### Description @@ -115,7 +115,7 @@ Specifies the maximum number of items that can be selected. Minimum number is 1. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -134,7 +134,7 @@ length for the `text` field in this object is 150 characters. type: "multi_channels_select"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:428 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:432 #### Description diff --git a/docs/english/reference/web-api/interfaces/MultiConversationsSelect.md b/docs/english/reference/web-api/interfaces/MultiConversationsSelect.md index 9809253c9..8ae7b79bc 100644 --- a/docs/english/reference/web-api/interfaces/MultiConversationsSelect.md +++ b/docs/english/reference/web-api/interfaces/MultiConversationsSelect.md @@ -2,7 +2,7 @@ # Interface: MultiConversationsSelect -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:378 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:382 ## Description @@ -26,7 +26,7 @@ MPIMs visible to the current user in the active workspace. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -44,7 +44,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -63,7 +63,7 @@ with. optional default_to_current_conversation: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:392 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:396 #### Description @@ -78,7 +78,7 @@ modal, if available. Default is `false`. optional filter: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:396 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:400 #### exclude\_bot\_users? @@ -110,7 +110,7 @@ A filter object that reduces the list of available conversations using the speci optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -130,7 +130,7 @@ Defaults to `false`. optional initial_conversations: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:387 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:391 #### Description @@ -145,7 +145,7 @@ An array of one or more IDs of any valid conversations to be pre-selected when t optional max_selected_items: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:42 +Defined in: packages/types/dist/block-kit/extensions.d.ts:42 #### Description @@ -163,7 +163,7 @@ Specifies the maximum number of items that can be selected. Minimum number is 1. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -182,7 +182,7 @@ length for the `text` field in this object is 150 characters. type: "multi_conversations_select"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:382 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:386 #### Description diff --git a/docs/english/reference/web-api/interfaces/MultiExternalSelect.md b/docs/english/reference/web-api/interfaces/MultiExternalSelect.md index 368c910cc..6574e5127 100644 --- a/docs/english/reference/web-api/interfaces/MultiExternalSelect.md +++ b/docs/english/reference/web-api/interfaces/MultiExternalSelect.md @@ -2,7 +2,7 @@ # Interface: MultiExternalSelect -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:461 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:465 ## Description @@ -25,7 +25,7 @@ This menu will load its options from an external data source, allowing for a dyn optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -43,7 +43,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -62,7 +62,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_options: PlainTextOption[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:469 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:473 #### Description @@ -96,7 +96,7 @@ An array of options to be selected when the menu initially loads. optional max_selected_items: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:42 +Defined in: packages/types/dist/block-kit/extensions.d.ts:42 #### Description @@ -114,7 +114,7 @@ Specifies the maximum number of items that can be selected. Minimum number is 1. optional min_query_length: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:475 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:479 #### Description @@ -130,7 +130,7 @@ of typed characters required before dispatch. The default value is `3`. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -149,7 +149,7 @@ length for the `text` field in this object is 150 characters. type: "multi_external_select"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:465 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:469 #### Description diff --git a/docs/english/reference/web-api/interfaces/MultiStaticSelect.md b/docs/english/reference/web-api/interfaces/MultiStaticSelect.md index 8e469d480..a900300b2 100644 --- a/docs/english/reference/web-api/interfaces/MultiStaticSelect.md +++ b/docs/english/reference/web-api/interfaces/MultiStaticSelect.md @@ -2,7 +2,7 @@ # Interface: MultiStaticSelect -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:318 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:322 ## Description @@ -26,7 +26,7 @@ element. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -44,7 +44,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -63,7 +63,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_options: PlainTextOption[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:327 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:331 #### Description @@ -98,7 +98,7 @@ An array of option objects that exactly match one or more of the options within optional max_selected_items: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:42 +Defined in: packages/types/dist/block-kit/extensions.d.ts:42 #### Description @@ -116,7 +116,7 @@ Specifies the maximum number of items that can be selected. Minimum number is 1. optional option_groups: object[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:337 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:341 #### label @@ -143,7 +143,7 @@ this field should not be. optional options: PlainTextOption[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:332 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:336 #### Description @@ -158,7 +158,7 @@ specified, this field should not be. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -177,7 +177,7 @@ length for the `text` field in this object is 150 characters. type: "multi_static_select"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:322 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:326 #### Description diff --git a/docs/english/reference/web-api/interfaces/MultiUsersSelect.md b/docs/english/reference/web-api/interfaces/MultiUsersSelect.md index ac9317f1a..85b3e11bc 100644 --- a/docs/english/reference/web-api/interfaces/MultiUsersSelect.md +++ b/docs/english/reference/web-api/interfaces/MultiUsersSelect.md @@ -2,7 +2,7 @@ # Interface: MultiUsersSelect -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:272 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:276 ## Description @@ -26,7 +26,7 @@ in the active workspace. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -44,7 +44,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -63,7 +63,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_users: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:280 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:284 #### Description @@ -97,7 +97,7 @@ An array of user IDs of any valid users to be pre-selected when the menu loads. optional max_selected_items: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:42 +Defined in: packages/types/dist/block-kit/extensions.d.ts:42 #### Description @@ -115,7 +115,7 @@ Specifies the maximum number of items that can be selected. Minimum number is 1. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -134,7 +134,7 @@ length for the `text` field in this object is 150 characters. type: "multi_users_select"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:276 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:280 #### Description diff --git a/docs/english/reference/web-api/interfaces/NumberInput.md b/docs/english/reference/web-api/interfaces/NumberInput.md index 2d736c66b..bd958f8fa 100644 --- a/docs/english/reference/web-api/interfaces/NumberInput.md +++ b/docs/english/reference/web-api/interfaces/NumberInput.md @@ -2,7 +2,7 @@ # Interface: NumberInput -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:484 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:488 ## Description @@ -27,7 +27,7 @@ decimal numbers. For example, 0.25, 5.5, and -10 are all valid input values. Dec optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -45,7 +45,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional dispatch_action_config: DispatchActionConfig; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:28 +Defined in: packages/types/dist/block-kit/extensions.d.ts:28 #### Description @@ -64,7 +64,7 @@ A [DispatchActionConfig](DispatchActionConfig.md) object that determines when du optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -84,7 +84,7 @@ Defaults to `false`. optional initial_value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:496 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:500 #### Description @@ -98,7 +98,7 @@ The initial value in the input when it is loaded. is_decimal_allowed: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:492 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:496 #### Description @@ -112,7 +112,7 @@ Decimal numbers are allowed if this property is `true`, set the value to `false` optional max_value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:504 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:508 #### Description @@ -126,7 +126,7 @@ The maximum value, cannot be less than `min_value`. optional min_value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:500 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:504 #### Description @@ -140,7 +140,7 @@ The minimum value, cannot be greater than `max_value`. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -159,7 +159,7 @@ length for the `text` field in this object is 150 characters. type: "number_input"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:488 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:492 #### Description diff --git a/docs/english/reference/web-api/interfaces/OptionGroup.md b/docs/english/reference/web-api/interfaces/OptionGroup.md index 633ea5f27..d5a4ab5a2 100644 --- a/docs/english/reference/web-api/interfaces/OptionGroup.md +++ b/docs/english/reference/web-api/interfaces/OptionGroup.md @@ -2,7 +2,7 @@ # Interface: OptionGroup -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:104 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:104 ## Description @@ -20,7 +20,7 @@ Defines a way to group options in a select or multi-select menu. label: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:109 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:109 #### Description @@ -35,7 +35,7 @@ Maximum length for the `text` in this field is 75 characters. options: Option[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:113 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:113 #### Description diff --git a/docs/english/reference/web-api/interfaces/Overflow.md b/docs/english/reference/web-api/interfaces/Overflow.md index 6f2f87b54..613733111 100644 --- a/docs/english/reference/web-api/interfaces/Overflow.md +++ b/docs/english/reference/web-api/interfaces/Overflow.md @@ -2,7 +2,7 @@ # Interface: Overflow -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:515 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:519 ## Description @@ -29,7 +29,7 @@ overflow menu options, instead of actions. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -47,7 +47,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -66,7 +66,7 @@ with. options: PlainTextOption[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:523 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:527 #### Description @@ -80,7 +80,7 @@ An array of up to 5 [PlainTextOption](PlainTextOption.md) to display in the menu type: "overflow"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:519 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:523 #### Description diff --git a/docs/english/reference/web-api/interfaces/PinAddedEvent.md b/docs/english/reference/web-api/interfaces/PinAddedEvent.md index ed918aaaa..3b4493a58 100644 --- a/docs/english/reference/web-api/interfaces/PinAddedEvent.md +++ b/docs/english/reference/web-api/interfaces/PinAddedEvent.md @@ -2,7 +2,7 @@ # Interface: PinAddedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:30 +Defined in: packages/types/dist/events/pin.d.ts:30 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:30 channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:33 +Defined in: packages/types/dist/events/pin.d.ts:33 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:33 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:42 +Defined in: packages/types/dist/events/pin.d.ts:42 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:42 item: PinnedItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:34 +Defined in: packages/types/dist/events/pin.d.ts:34 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:34 item_user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:35 +Defined in: packages/types/dist/events/pin.d.ts:35 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:35 pin_count: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:36 +Defined in: packages/types/dist/events/pin.d.ts:36 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:36 pinned_info: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:37 +Defined in: packages/types/dist/events/pin.d.ts:37 #### channel @@ -90,7 +90,7 @@ pinned_ts: number; type: "pin_added"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:31 +Defined in: packages/types/dist/events/pin.d.ts:31 *** @@ -100,4 +100,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:31 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:32 +Defined in: packages/types/dist/events/pin.d.ts:32 diff --git a/docs/english/reference/web-api/interfaces/PinRemovedEvent.md b/docs/english/reference/web-api/interfaces/PinRemovedEvent.md index fc0c00a19..e6901cb70 100644 --- a/docs/english/reference/web-api/interfaces/PinRemovedEvent.md +++ b/docs/english/reference/web-api/interfaces/PinRemovedEvent.md @@ -2,7 +2,7 @@ # Interface: PinRemovedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:44 +Defined in: packages/types/dist/events/pin.d.ts:44 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:44 channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:47 +Defined in: packages/types/dist/events/pin.d.ts:47 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:47 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:57 +Defined in: packages/types/dist/events/pin.d.ts:57 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:57 has_pins: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:56 +Defined in: packages/types/dist/events/pin.d.ts:56 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:56 item: PinnedItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:48 +Defined in: packages/types/dist/events/pin.d.ts:48 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:48 item_user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:49 +Defined in: packages/types/dist/events/pin.d.ts:49 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:49 pin_count: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:50 +Defined in: packages/types/dist/events/pin.d.ts:50 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:50 pinned_info: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:51 +Defined in: packages/types/dist/events/pin.d.ts:51 #### channel @@ -100,7 +100,7 @@ pinned_ts: number; type: "pin_removed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:45 +Defined in: packages/types/dist/events/pin.d.ts:45 *** @@ -110,4 +110,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:45 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/pin.d.ts:46 +Defined in: packages/types/dist/events/pin.d.ts:46 diff --git a/docs/english/reference/web-api/interfaces/Placeholdable.md b/docs/english/reference/web-api/interfaces/Placeholdable.md index 071d0c208..a6a128120 100644 --- a/docs/english/reference/web-api/interfaces/Placeholdable.md +++ b/docs/english/reference/web-api/interfaces/Placeholdable.md @@ -2,7 +2,7 @@ # Interface: Placeholdable -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:44 +Defined in: packages/types/dist/block-kit/extensions.d.ts:44 ## Extended by @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extension optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description diff --git a/docs/english/reference/web-api/interfaces/PlainTextElement.md b/docs/english/reference/web-api/interfaces/PlainTextElement.md index 6d9c0610b..6bc85f931 100644 --- a/docs/english/reference/web-api/interfaces/PlainTextElement.md +++ b/docs/english/reference/web-api/interfaces/PlainTextElement.md @@ -2,7 +2,7 @@ # Interface: PlainTextElement -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:125 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:125 ## Description @@ -20,7 +20,7 @@ Defines an object containing some text. optional emoji: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:137 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:137 #### Description @@ -34,7 +34,7 @@ Indicates whether emojis in a text field should be escaped into the colon emoji text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:133 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:133 #### Description @@ -48,7 +48,7 @@ The text for the block. The minimum length is 1 and maximum length is 3000 chara type: "plain_text"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:129 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:129 #### Description diff --git a/docs/english/reference/web-api/interfaces/PlainTextInput.md b/docs/english/reference/web-api/interfaces/PlainTextInput.md index f463ac8f4..c2735c7f0 100644 --- a/docs/english/reference/web-api/interfaces/PlainTextInput.md +++ b/docs/english/reference/web-api/interfaces/PlainTextInput.md @@ -2,7 +2,7 @@ # Interface: PlainTextInput -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:530 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:534 ## Description @@ -25,7 +25,7 @@ Allows users to enter freeform text data into a single-line or multi-line field. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -43,7 +43,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional dispatch_action_config: DispatchActionConfig; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:28 +Defined in: packages/types/dist/block-kit/extensions.d.ts:28 #### Description @@ -62,7 +62,7 @@ A [DispatchActionConfig](DispatchActionConfig.md) object that determines when du optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:538 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:542 #### Description @@ -96,7 +96,7 @@ The initial value in the plain-text input when it is loaded. optional max_length: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:553 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:557 #### Description @@ -111,7 +111,7 @@ they will receive an error. optional min_length: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:548 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:552 #### Description @@ -126,7 +126,7 @@ an error. Maximum value is 3000. optional multiline: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:543 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:547 #### Description @@ -141,7 +141,7 @@ Defaults to `false`. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -160,7 +160,7 @@ length for the `text` field in this object is 150 characters. type: "plain_text_input"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:534 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:538 #### Description diff --git a/docs/english/reference/web-api/interfaces/PlainTextOption.md b/docs/english/reference/web-api/interfaces/PlainTextOption.md index c0e82af62..f68a9a72c 100644 --- a/docs/english/reference/web-api/interfaces/PlainTextOption.md +++ b/docs/english/reference/web-api/interfaces/PlainTextOption.md @@ -2,7 +2,7 @@ # Interface: PlainTextOption -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:87 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:87 ## Extends @@ -16,7 +16,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/compositi optional description: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:78 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:78 #### Description @@ -37,7 +37,7 @@ OptionDescriptor.description text: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:92 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:92 #### Description @@ -52,7 +52,7 @@ overflow, select and multi-select menus. Maximum length for the `text` in this f optional url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:73 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:73 #### Description @@ -73,7 +73,7 @@ OptionDescriptor.url optional value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:68 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:68 #### Description diff --git a/docs/english/reference/web-api/interfaces/PlanBlock.md b/docs/english/reference/web-api/interfaces/PlanBlock.md new file mode 100644 index 000000000..7bf695042 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/PlanBlock.md @@ -0,0 +1,85 @@ +[@slack/web-api](../index.md) / PlanBlock + +# Interface: PlanBlock + +Defined in: packages/types/dist/block-kit/blocks.d.ts:339 + +## Description + +A collection of related tasks. + +## See + +https://docs.slack.dev/reference/block-kit/blocks/plan-block/ + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 + +#### 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://docs.slack.dev/interactivity/handling-user-interaction#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) + +*** + +### tasks? + +```ts +optional tasks: (Record | TaskCardBlock)[]; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:351 + +#### Description + +A sequence of task card blocks. Each task represents a single action within the plan. + +*** + +### title + +```ts +title: string; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:347 + +#### Description + +Title of the plan in plain text. + +*** + +### type + +```ts +type: "plan"; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:343 + +#### Description + +The type of block. In this case `type` is always `plan`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) diff --git a/docs/english/reference/web-api/interfaces/PlanUpdateChunk.md b/docs/english/reference/web-api/interfaces/PlanUpdateChunk.md new file mode 100644 index 000000000..7ce9f4156 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/PlanUpdateChunk.md @@ -0,0 +1,36 @@ +[@slack/web-api](../index.md) / PlanUpdateChunk + +# Interface: PlanUpdateChunk + +Defined in: packages/types/dist/chunk.d.ts:21 + +Used for displaying an updated title of a plan. +https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming + +## Extends + +- [`Chunk`](Chunk.md) + +## Properties + +### title + +```ts +title: string; +``` + +Defined in: packages/types/dist/chunk.d.ts:23 + +*** + +### type + +```ts +type: "plan_update"; +``` + +Defined in: packages/types/dist/chunk.d.ts:22 + +#### Overrides + +[`Chunk`](Chunk.md).[`type`](Chunk.md#type) diff --git a/docs/english/reference/web-api/interfaces/RadioButtons.md b/docs/english/reference/web-api/interfaces/RadioButtons.md index 4397b6546..cffd00266 100644 --- a/docs/english/reference/web-api/interfaces/RadioButtons.md +++ b/docs/english/reference/web-api/interfaces/RadioButtons.md @@ -2,7 +2,7 @@ # Interface: RadioButtons -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:560 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:564 ## Description @@ -25,7 +25,7 @@ Allows users to choose one item from a list of possible options. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -43,7 +43,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -62,7 +62,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_option: Option; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:569 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:573 #### Description @@ -97,7 +97,7 @@ be selected when the radio button group initially loads. options: Option[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:573 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:577 #### Description @@ -111,7 +111,7 @@ An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options type: "radio_buttons"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:564 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:568 #### Description diff --git a/docs/english/reference/web-api/interfaces/RawTextElement.md b/docs/english/reference/web-api/interfaces/RawTextElement.md new file mode 100644 index 000000000..3de4c6c98 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/RawTextElement.md @@ -0,0 +1,41 @@ +[@slack/web-api](../index.md) / RawTextElement + +# Interface: RawTextElement + +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:165 + +## Description + +Defines an object containing some text. + +## See + +[Text object reference](https://docs.slack.dev/reference/block-kit/composition-objects/text-object). + +## Properties + +### text + +```ts +text: string; +``` + +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:173 + +#### Description + +The text for the block. The minimum length is 1 character. + +*** + +### type + +```ts +type: "raw_text"; +``` + +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:169 + +#### Description + +The formatting to use for this text object. diff --git a/docs/english/reference/web-api/interfaces/ReactionAddedEvent.md b/docs/english/reference/web-api/interfaces/ReactionAddedEvent.md index bd9997654..4e2268996 100644 --- a/docs/english/reference/web-api/interfaces/ReactionAddedEvent.md +++ b/docs/english/reference/web-api/interfaces/ReactionAddedEvent.md @@ -2,7 +2,7 @@ # Interface: ReactionAddedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:6 +Defined in: packages/types/dist/events/reaction.d.ts:6 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:12 +Defined in: packages/types/dist/events/reaction.d.ts:12 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t item: ReactionMessageItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:11 +Defined in: packages/types/dist/events/reaction.d.ts:11 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t item_user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:10 +Defined in: packages/types/dist/events/reaction.d.ts:10 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t reaction: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:9 +Defined in: packages/types/dist/events/reaction.d.ts:9 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t type: "reaction_added"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:7 +Defined in: packages/types/dist/events/reaction.d.ts:7 *** @@ -62,4 +62,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:8 +Defined in: packages/types/dist/events/reaction.d.ts:8 diff --git a/docs/english/reference/web-api/interfaces/ReactionRemovedEvent.md b/docs/english/reference/web-api/interfaces/ReactionRemovedEvent.md index a1d2a91b2..80d98e5b7 100644 --- a/docs/english/reference/web-api/interfaces/ReactionRemovedEvent.md +++ b/docs/english/reference/web-api/interfaces/ReactionRemovedEvent.md @@ -2,7 +2,7 @@ # Interface: ReactionRemovedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:14 +Defined in: packages/types/dist/events/reaction.d.ts:14 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:20 +Defined in: packages/types/dist/events/reaction.d.ts:20 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t item: ReactionMessageItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:19 +Defined in: packages/types/dist/events/reaction.d.ts:19 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t item_user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:18 +Defined in: packages/types/dist/events/reaction.d.ts:18 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t reaction: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:17 +Defined in: packages/types/dist/events/reaction.d.ts:17 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t type: "reaction_removed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:15 +Defined in: packages/types/dist/events/reaction.d.ts:15 *** @@ -62,4 +62,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.t user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/reaction.d.ts:16 +Defined in: packages/types/dist/events/reaction.d.ts:16 diff --git a/docs/english/reference/web-api/interfaces/RetryOptions.md b/docs/english/reference/web-api/interfaces/RetryOptions.md index ce2f0ce74..8f0f9d6ac 100644 --- a/docs/english/reference/web-api/interfaces/RetryOptions.md +++ b/docs/english/reference/web-api/interfaces/RetryOptions.md @@ -18,7 +18,7 @@ Options to create retry policies. Extends from https://github.com/tim-kos/node-r optional factor: number; ``` -Defined in: packages/web-api/node\_modules/@types/retry/index.d.ts:125 +Defined in: node\_modules/@types/retry/index.d.ts:125 The exponential factor to use. @@ -42,7 +42,7 @@ OperationOptions.factor optional forever: boolean; ``` -Defined in: packages/web-api/node\_modules/@types/retry/index.d.ts:88 +Defined in: node\_modules/@types/retry/index.d.ts:88 Whether to retry forever. @@ -66,7 +66,7 @@ OperationOptions.forever optional maxRetryTime: number; ``` -Defined in: packages/web-api/node\_modules/@types/retry/index.d.ts:98 +Defined in: node\_modules/@types/retry/index.d.ts:98 The maximum time (in milliseconds) that the retried operation is allowed to run. @@ -90,7 +90,7 @@ OperationOptions.maxRetryTime optional maxTimeout: number; ``` -Defined in: packages/web-api/node\_modules/@types/retry/index.d.ts:135 +Defined in: node\_modules/@types/retry/index.d.ts:135 The maximum number of milliseconds between two retries. @@ -114,7 +114,7 @@ OperationOptions.maxTimeout optional minTimeout: number; ``` -Defined in: packages/web-api/node\_modules/@types/retry/index.d.ts:130 +Defined in: node\_modules/@types/retry/index.d.ts:130 The number of milliseconds before starting the first retry. @@ -138,7 +138,7 @@ OperationOptions.minTimeout optional randomize: boolean; ``` -Defined in: packages/web-api/node\_modules/@types/retry/index.d.ts:140 +Defined in: node\_modules/@types/retry/index.d.ts:140 Randomizes the timeouts by multiplying a factor between 1-2. @@ -162,7 +162,7 @@ OperationOptions.randomize optional retries: number; ``` -Defined in: packages/web-api/node\_modules/@types/retry/index.d.ts:109 +Defined in: node\_modules/@types/retry/index.d.ts:109 The maximum amount of times to retry the operation. @@ -186,7 +186,7 @@ OperationOptions.retries optional unref: boolean; ``` -Defined in: packages/web-api/node\_modules/@types/retry/index.d.ts:93 +Defined in: node\_modules/@types/retry/index.d.ts:93 Whether to [unref](https://nodejs.org/api/timers.html#timers_unref) the setTimeout's. diff --git a/docs/english/reference/web-api/interfaces/RichTextBlock.md b/docs/english/reference/web-api/interfaces/RichTextBlock.md index a46d81f68..01c3857c0 100644 --- a/docs/english/reference/web-api/interfaces/RichTextBlock.md +++ b/docs/english/reference/web-api/interfaces/RichTextBlock.md @@ -2,7 +2,7 @@ # Interface: RichTextBlock -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:223 +Defined in: packages/types/dist/block-kit/blocks.d.ts:224 ## Description @@ -29,7 +29,7 @@ the [RichTextInput](RichTextInput.md). optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -51,7 +51,7 @@ a message. If a message is updated, use a new `block_id`. elements: RichTextBlockElement[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:228 +Defined in: packages/types/dist/block-kit/blocks.d.ts:229 *** @@ -61,7 +61,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d. type: "rich_text"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:227 +Defined in: packages/types/dist/block-kit/blocks.d.ts:228 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextBorderable.md b/docs/english/reference/web-api/interfaces/RichTextBorderable.md index a5a8542e2..c033db2ed 100644 --- a/docs/english/reference/web-api/interfaces/RichTextBorderable.md +++ b/docs/english/reference/web-api/interfaces/RichTextBorderable.md @@ -2,7 +2,7 @@ # Interface: RichTextBorderable -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:61 +Defined in: packages/types/dist/block-kit/extensions.d.ts:61 For use in setting border style details on certain Rich Text elements. @@ -20,7 +20,7 @@ For use in setting border style details on certain Rich Text elements. optional border: 0 | 1; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:66 +Defined in: packages/types/dist/block-kit/extensions.d.ts:66 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextBroadcastMention.md b/docs/english/reference/web-api/interfaces/RichTextBroadcastMention.md index 550c4c346..bc174bd48 100644 --- a/docs/english/reference/web-api/interfaces/RichTextBroadcastMention.md +++ b/docs/english/reference/web-api/interfaces/RichTextBroadcastMention.md @@ -2,7 +2,7 @@ # Interface: RichTextBroadcastMention -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:677 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:699 ## Description @@ -20,7 +20,7 @@ A broadcast mention element for use in a rich text message. range: "channel" | "here" | "everyone"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:685 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:707 #### Description @@ -34,7 +34,7 @@ The range of the broadcast; can be one of `here`, `channel` and `everyone`. optional style: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:75 +Defined in: packages/types/dist/block-kit/extensions.d.ts:75 #### bold? @@ -76,6 +76,16 @@ optional strike: boolean; When `true`, strikes through the text in this element. Defaults to `false`. +#### underline? + +```ts +optional underline: boolean; +``` + +##### Description + +When `true`, underlines the text in this element. Defaults to `false`. + #### Description A limited style object for styling rich text `text` elements. @@ -92,7 +102,7 @@ A limited style object for styling rich text `text` elements. type: "broadcast"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:681 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:703 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextChannelMention.md b/docs/english/reference/web-api/interfaces/RichTextChannelMention.md index b33ab6396..13120de96 100644 --- a/docs/english/reference/web-api/interfaces/RichTextChannelMention.md +++ b/docs/english/reference/web-api/interfaces/RichTextChannelMention.md @@ -2,7 +2,7 @@ # Interface: RichTextChannelMention -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:703 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:725 ## Description @@ -20,7 +20,7 @@ A channel mention element for use in a rich text message. channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:711 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:733 #### Description @@ -34,7 +34,7 @@ The encoded channel ID, e.g. C1234ABCD. optional style: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:75 +Defined in: packages/types/dist/block-kit/extensions.d.ts:75 #### bold? @@ -76,6 +76,16 @@ optional strike: boolean; When `true`, strikes through the text in this element. Defaults to `false`. +#### underline? + +```ts +optional underline: boolean; +``` + +##### Description + +When `true`, underlines the text in this element. Defaults to `false`. + #### Description A limited style object for styling rich text `text` elements. @@ -92,7 +102,7 @@ A limited style object for styling rich text `text` elements. type: "channel"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:707 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:729 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextColor.md b/docs/english/reference/web-api/interfaces/RichTextColor.md index 2ad39e2b5..9210b933f 100644 --- a/docs/english/reference/web-api/interfaces/RichTextColor.md +++ b/docs/english/reference/web-api/interfaces/RichTextColor.md @@ -2,7 +2,7 @@ # Interface: RichTextColor -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:690 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:712 ## Description @@ -20,7 +20,7 @@ A hex color element for use in a rich text message. optional style: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:75 +Defined in: packages/types/dist/block-kit/extensions.d.ts:75 #### bold? @@ -62,6 +62,16 @@ optional strike: boolean; When `true`, strikes through the text in this element. Defaults to `false`. +#### underline? + +```ts +optional underline: boolean; +``` + +##### Description + +When `true`, underlines the text in this element. Defaults to `false`. + #### Description A limited style object for styling rich text `text` elements. @@ -78,7 +88,7 @@ A limited style object for styling rich text `text` elements. type: "color"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:694 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:716 #### Description @@ -92,7 +102,7 @@ The type of element. In this case `type` is always `color`. value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:698 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:720 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextDate.md b/docs/english/reference/web-api/interfaces/RichTextDate.md index abe78ad99..98997f941 100644 --- a/docs/english/reference/web-api/interfaces/RichTextDate.md +++ b/docs/english/reference/web-api/interfaces/RichTextDate.md @@ -2,7 +2,7 @@ # Interface: RichTextDate -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:716 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:738 ## Description @@ -20,7 +20,7 @@ A date element for use in a rich text message. optional fallback: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:756 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:778 #### Description @@ -34,7 +34,7 @@ Text to display in place of the date should parsing, formatting or displaying fa format: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:748 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:770 #### Description @@ -68,7 +68,7 @@ TODO: test/document `{member_local_time}`, `{status_expiration}` and `{calendar_ optional style: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:75 +Defined in: packages/types/dist/block-kit/extensions.d.ts:75 #### bold? @@ -110,6 +110,16 @@ optional strike: boolean; When `true`, strikes through the text in this element. Defaults to `false`. +#### underline? + +```ts +optional underline: boolean; +``` + +##### Description + +When `true`, underlines the text in this element. Defaults to `false`. + #### Description A limited style object for styling rich text `text` elements. @@ -126,7 +136,7 @@ A limited style object for styling rich text `text` elements. timestamp: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:724 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:746 #### Description @@ -140,7 +150,7 @@ A UNIX timestamp for the date to be displayed in seconds. type: "date"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:720 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:742 #### Description @@ -154,7 +164,7 @@ The type of element. In this case `type` is always `date`. optional url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:752 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:774 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextEmoji.md b/docs/english/reference/web-api/interfaces/RichTextEmoji.md index 6d661c8d7..76b97355f 100644 --- a/docs/english/reference/web-api/interfaces/RichTextEmoji.md +++ b/docs/english/reference/web-api/interfaces/RichTextEmoji.md @@ -2,7 +2,7 @@ # Interface: RichTextEmoji -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:761 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:783 ## Description @@ -20,7 +20,7 @@ An emoji element for use in a rich text message. name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:769 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:791 #### Description @@ -34,7 +34,7 @@ Name of emoji, without colons or skin tones, e.g. `wave` optional style: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:75 +Defined in: packages/types/dist/block-kit/extensions.d.ts:75 #### bold? @@ -76,6 +76,16 @@ optional strike: boolean; When `true`, strikes through the text in this element. Defaults to `false`. +#### underline? + +```ts +optional underline: boolean; +``` + +##### Description + +When `true`, underlines the text in this element. Defaults to `false`. + #### Description A limited style object for styling rich text `text` elements. @@ -92,7 +102,7 @@ A limited style object for styling rich text `text` elements. type: "emoji"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:765 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:787 #### Description @@ -106,7 +116,7 @@ The type of element. In this case `type` is always `emoji`. optional unicode: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:773 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:795 #### Description @@ -120,7 +130,7 @@ Lowercase hexadecimal Unicode representation of a standard emoji (not for use wi optional url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:777 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:799 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextInput.md b/docs/english/reference/web-api/interfaces/RichTextInput.md index 612ad58fe..7fb6e6e75 100644 --- a/docs/english/reference/web-api/interfaces/RichTextInput.md +++ b/docs/english/reference/web-api/interfaces/RichTextInput.md @@ -2,7 +2,7 @@ # Interface: RichTextInput -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:921 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:943 ## Description @@ -26,7 +26,7 @@ same experience you have writing messages in Slack. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -44,7 +44,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional dispatch_action_config: DispatchActionConfig; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:28 +Defined in: packages/types/dist/block-kit/extensions.d.ts:28 #### Description @@ -63,7 +63,7 @@ A [DispatchActionConfig](DispatchActionConfig.md) object that determines when du optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_value: RichTextBlock; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:929 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:951 #### Description @@ -97,7 +97,7 @@ Initial contents of the input when it is loaded. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -116,7 +116,7 @@ length for the `text` field in this object is 150 characters. type: "rich_text_input"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:925 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:947 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextLink.md b/docs/english/reference/web-api/interfaces/RichTextLink.md index edebba906..a39119d03 100644 --- a/docs/english/reference/web-api/interfaces/RichTextLink.md +++ b/docs/english/reference/web-api/interfaces/RichTextLink.md @@ -2,7 +2,7 @@ # Interface: RichTextLink -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:782 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:804 ## Description @@ -20,7 +20,7 @@ A link element for use in a rich text message. optional style: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:75 +Defined in: packages/types/dist/block-kit/extensions.d.ts:75 #### bold? @@ -62,6 +62,16 @@ optional strike: boolean; When `true`, strikes through the text in this element. Defaults to `false`. +#### underline? + +```ts +optional underline: boolean; +``` + +##### Description + +When `true`, underlines the text in this element. Defaults to `false`. + #### Description A limited style object for styling rich text `text` elements. @@ -78,7 +88,7 @@ A limited style object for styling rich text `text` elements. optional text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:790 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:812 #### Description @@ -92,7 +102,7 @@ The text to link. type: "link"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:786 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:808 #### Description @@ -106,7 +116,7 @@ The type of element. In this case `type` is always `link`. optional unsafe: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:794 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:816 #### Description @@ -120,7 +130,7 @@ TODO: ? url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:798 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:820 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextList.md b/docs/english/reference/web-api/interfaces/RichTextList.md index adf06ce89..d9b8057ac 100644 --- a/docs/english/reference/web-api/interfaces/RichTextList.md +++ b/docs/english/reference/web-api/interfaces/RichTextList.md @@ -2,7 +2,7 @@ # Interface: RichTextList -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:869 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:891 ## Description @@ -20,7 +20,7 @@ A list block within a rich text field. optional border: 0 | 1; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:66 +Defined in: packages/types/dist/block-kit/extensions.d.ts:66 #### Description @@ -39,7 +39,7 @@ while `1` renders a border. elements: RichTextSection[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:877 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:899 #### Description @@ -53,7 +53,7 @@ An array of [RichTextSection](RichTextSection.md) elements comprising each list optional indent: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:887 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:909 #### Description @@ -68,7 +68,7 @@ or characters rendered as the list points. Also affected by the `style` property style: "bullet" | "ordered"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:882 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:904 #### Description @@ -83,7 +83,7 @@ The type of list. Can be either `bullet` (the list points are all rendered the s type: "rich_text_list"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:873 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:895 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextPreformatted.md b/docs/english/reference/web-api/interfaces/RichTextPreformatted.md index 2043b70d1..47e8af037 100644 --- a/docs/english/reference/web-api/interfaces/RichTextPreformatted.md +++ b/docs/english/reference/web-api/interfaces/RichTextPreformatted.md @@ -2,7 +2,7 @@ # Interface: RichTextPreformatted -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:905 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:927 ## Description @@ -20,7 +20,7 @@ A block of preformatted text within a rich text field. optional border: 0 | 1; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:66 +Defined in: packages/types/dist/block-kit/extensions.d.ts:66 #### Description @@ -39,7 +39,7 @@ while `1` renders a border. elements: (RichTextLink | RichTextText)[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:913 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:935 #### Description @@ -53,7 +53,7 @@ An array of either [RichTextLink](RichTextLink.md) or [RichTextText](RichTextTex type: "rich_text_preformatted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:909 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:931 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextQuote.md b/docs/english/reference/web-api/interfaces/RichTextQuote.md index 8d3deff7d..581473efa 100644 --- a/docs/english/reference/web-api/interfaces/RichTextQuote.md +++ b/docs/english/reference/web-api/interfaces/RichTextQuote.md @@ -2,7 +2,7 @@ # Interface: RichTextQuote -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:892 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:914 ## Description @@ -20,7 +20,7 @@ A quote block within a rich text field. optional border: 0 | 1; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:66 +Defined in: packages/types/dist/block-kit/extensions.d.ts:66 #### Description @@ -39,7 +39,7 @@ while `1` renders a border. elements: RichTextElement[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:900 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:922 #### Description @@ -53,7 +53,7 @@ An array of [RichTextElement](../type-aliases/RichTextElement.md) comprising the type: "rich_text_quote"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:896 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:918 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextSection.md b/docs/english/reference/web-api/interfaces/RichTextSection.md index dbffaa21d..683523083 100644 --- a/docs/english/reference/web-api/interfaces/RichTextSection.md +++ b/docs/english/reference/web-api/interfaces/RichTextSection.md @@ -2,7 +2,7 @@ # Interface: RichTextSection -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:859 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:881 ## Description @@ -16,7 +16,7 @@ A section block within a rich text field. elements: RichTextElement[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:864 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:886 *** @@ -26,7 +26,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-ele type: "rich_text_section"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:863 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:885 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextStyleable.md b/docs/english/reference/web-api/interfaces/RichTextStyleable.md index 0dcdf8075..ae0dcdda0 100644 --- a/docs/english/reference/web-api/interfaces/RichTextStyleable.md +++ b/docs/english/reference/web-api/interfaces/RichTextStyleable.md @@ -2,7 +2,7 @@ # Interface: RichTextStyleable -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:71 +Defined in: packages/types/dist/block-kit/extensions.d.ts:71 ## Description @@ -29,7 +29,7 @@ For use styling Rich Text sub-elements. optional style: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:75 +Defined in: packages/types/dist/block-kit/extensions.d.ts:75 #### bold? @@ -71,6 +71,16 @@ optional strike: boolean; When `true`, strikes through the text in this element. Defaults to `false`. +#### underline? + +```ts +optional underline: boolean; +``` + +##### Description + +When `true`, underlines the text in this element. Defaults to `false`. + #### Description A limited style object for styling rich text `text` elements. diff --git a/docs/english/reference/web-api/interfaces/RichTextTeamMention.md b/docs/english/reference/web-api/interfaces/RichTextTeamMention.md index 044eb8bef..5d406d49c 100644 --- a/docs/english/reference/web-api/interfaces/RichTextTeamMention.md +++ b/docs/english/reference/web-api/interfaces/RichTextTeamMention.md @@ -2,7 +2,7 @@ # Interface: RichTextTeamMention -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:803 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:825 ## Description @@ -20,7 +20,7 @@ A workspace or team mention element for use in a rich text message. optional style: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:75 +Defined in: packages/types/dist/block-kit/extensions.d.ts:75 #### bold? @@ -62,6 +62,16 @@ optional strike: boolean; When `true`, strikes through the text in this element. Defaults to `false`. +#### underline? + +```ts +optional underline: boolean; +``` + +##### Description + +When `true`, underlines the text in this element. Defaults to `false`. + #### Description A limited style object for styling rich text `text` elements. @@ -78,7 +88,7 @@ A limited style object for styling rich text `text` elements. team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:811 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:833 #### Description @@ -92,7 +102,7 @@ The encoded team ID, e.g. T1234ABCD. type: "team"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:807 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:829 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextText.md b/docs/english/reference/web-api/interfaces/RichTextText.md index 77fd81449..17723b1af 100644 --- a/docs/english/reference/web-api/interfaces/RichTextText.md +++ b/docs/english/reference/web-api/interfaces/RichTextText.md @@ -2,7 +2,7 @@ # Interface: RichTextText -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:816 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:838 ## Description @@ -20,7 +20,7 @@ A generic text element for use in a rich text message. optional style: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:75 +Defined in: packages/types/dist/block-kit/extensions.d.ts:75 #### bold? @@ -62,6 +62,16 @@ optional strike: boolean; When `true`, strikes through the text in this element. Defaults to `false`. +#### underline? + +```ts +optional underline: boolean; +``` + +##### Description + +When `true`, underlines the text in this element. Defaults to `false`. + #### Description A limited style object for styling rich text `text` elements. @@ -78,7 +88,7 @@ A limited style object for styling rich text `text` elements. text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:824 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:846 #### Description @@ -92,7 +102,7 @@ The text to render. type: "text"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:820 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:842 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextUserMention.md b/docs/english/reference/web-api/interfaces/RichTextUserMention.md index bad75187a..9246295a7 100644 --- a/docs/english/reference/web-api/interfaces/RichTextUserMention.md +++ b/docs/english/reference/web-api/interfaces/RichTextUserMention.md @@ -2,7 +2,7 @@ # Interface: RichTextUserMention -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:829 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:851 ## Description @@ -20,7 +20,7 @@ A user mention element for use in a rich text message. optional style: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:75 +Defined in: packages/types/dist/block-kit/extensions.d.ts:75 #### bold? @@ -62,6 +62,16 @@ optional strike: boolean; When `true`, strikes through the text in this element. Defaults to `false`. +#### underline? + +```ts +optional underline: boolean; +``` + +##### Description + +When `true`, underlines the text in this element. Defaults to `false`. + #### Description A limited style object for styling rich text `text` elements. @@ -78,7 +88,7 @@ A limited style object for styling rich text `text` elements. type: "user"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:833 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:855 #### Description @@ -92,7 +102,7 @@ The type of element. In this case `type` is always `user`. user_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:837 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:859 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextUsergroupMention.md b/docs/english/reference/web-api/interfaces/RichTextUsergroupMention.md index cbb5c96ee..6ba279c71 100644 --- a/docs/english/reference/web-api/interfaces/RichTextUsergroupMention.md +++ b/docs/english/reference/web-api/interfaces/RichTextUsergroupMention.md @@ -2,7 +2,7 @@ # Interface: RichTextUsergroupMention -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:842 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:864 ## Description @@ -20,7 +20,7 @@ A usergroup mention element for use in a rich text message. optional style: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:75 +Defined in: packages/types/dist/block-kit/extensions.d.ts:75 #### bold? @@ -62,6 +62,16 @@ optional strike: boolean; When `true`, strikes through the text in this element. Defaults to `false`. +#### underline? + +```ts +optional underline: boolean; +``` + +##### Description + +When `true`, underlines the text in this element. Defaults to `false`. + #### Description A limited style object for styling rich text `text` elements. @@ -78,7 +88,7 @@ A limited style object for styling rich text `text` elements. type: "usergroup"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:846 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:868 #### Description @@ -92,7 +102,7 @@ The type of element. In this case `type` is always `usergroup`. usergroup_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:850 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:872 #### Description diff --git a/docs/english/reference/web-api/interfaces/SectionBlock.md b/docs/english/reference/web-api/interfaces/SectionBlock.md index f4abc807d..16f734c03 100644 --- a/docs/english/reference/web-api/interfaces/SectionBlock.md +++ b/docs/english/reference/web-api/interfaces/SectionBlock.md @@ -2,7 +2,7 @@ # Interface: SectionBlock -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:241 +Defined in: packages/types/dist/block-kit/blocks.d.ts:242 ## Description @@ -26,7 +26,7 @@ combination with text fields, or side-by-side with certain optional accessory: SectionBlockAccessory; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:262 +Defined in: packages/types/dist/block-kit/blocks.d.ts:263 #### Description @@ -40,7 +40,7 @@ One of the compatible element objects. optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -62,7 +62,7 @@ a message. If a message is updated, use a new `block_id`. optional expand: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:266 +Defined in: packages/types/dist/block-kit/blocks.d.ts:267 Whether or not this section block's text should always expand when rendered. If false or not provided, it may be rendered with a 'see more' option to expand and show the full text. For AI Assistant apps, this allows the app to post long messages without users needing to click 'see more' to expand the message. @@ -74,7 +74,7 @@ Whether or not this section block's text should always expand when rendered. If optional fields: TextObject[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:258 +Defined in: packages/types/dist/block-kit/blocks.d.ts:259 #### Description @@ -91,7 +91,7 @@ Maximum length for the text in each item is 2000 characters. optional text: TextObject; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:251 +Defined in: packages/types/dist/block-kit/blocks.d.ts:252 #### Description @@ -107,7 +107,7 @@ is provided instead. type: "section"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:245 +Defined in: packages/types/dist/block-kit/blocks.d.ts:246 #### Description diff --git a/docs/english/reference/web-api/interfaces/SelectOption.md b/docs/english/reference/web-api/interfaces/SelectOption.md index b79fed673..16e2e73ad 100644 --- a/docs/english/reference/web-api/interfaces/SelectOption.md +++ b/docs/english/reference/web-api/interfaces/SelectOption.md @@ -2,7 +2,7 @@ # Interface: SelectOption -Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:32 +Defined in: packages/types/dist/dialog.d.ts:32 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:32 label: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:33 +Defined in: packages/types/dist/dialog.d.ts:33 *** @@ -22,4 +22,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:33 value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/dialog.d.ts:34 +Defined in: packages/types/dist/dialog.d.ts:34 diff --git a/docs/english/reference/web-api/interfaces/SharedChannelInviteAcceptedEvent.md b/docs/english/reference/web-api/interfaces/SharedChannelInviteAcceptedEvent.md index 0579fdcf1..33efb84d5 100644 --- a/docs/english/reference/web-api/interfaces/SharedChannelInviteAcceptedEvent.md +++ b/docs/english/reference/web-api/interfaces/SharedChannelInviteAcceptedEvent.md @@ -2,7 +2,7 @@ # Interface: SharedChannelInviteAcceptedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:45 +Defined in: packages/types/dist/events/shared-channel.d.ts:45 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann accepting_user: SharedChannelUserItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:51 +Defined in: packages/types/dist/events/shared-channel.d.ts:51 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann approval_required: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:47 +Defined in: packages/types/dist/events/shared-channel.d.ts:47 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann channel: SharedChannelItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:49 +Defined in: packages/types/dist/events/shared-channel.d.ts:49 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:52 +Defined in: packages/types/dist/events/shared-channel.d.ts:52 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann invite: SharedChannelInviteItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:48 +Defined in: packages/types/dist/events/shared-channel.d.ts:48 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann teams_in_channel: SharedChannelTeamItem[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:50 +Defined in: packages/types/dist/events/shared-channel.d.ts:50 *** @@ -72,4 +72,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann type: "shared_channel_invite_accepted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:46 +Defined in: packages/types/dist/events/shared-channel.d.ts:46 diff --git a/docs/english/reference/web-api/interfaces/SharedChannelInviteApprovedEvent.md b/docs/english/reference/web-api/interfaces/SharedChannelInviteApprovedEvent.md index b7289a4ed..0db5dc227 100644 --- a/docs/english/reference/web-api/interfaces/SharedChannelInviteApprovedEvent.md +++ b/docs/english/reference/web-api/interfaces/SharedChannelInviteApprovedEvent.md @@ -2,7 +2,7 @@ # Interface: SharedChannelInviteApprovedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:58 +Defined in: packages/types/dist/events/shared-channel.d.ts:58 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann approving_team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:62 +Defined in: packages/types/dist/events/shared-channel.d.ts:62 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann approving_user: SharedChannelUserItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:64 +Defined in: packages/types/dist/events/shared-channel.d.ts:64 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann channel: SharedChannelItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:61 +Defined in: packages/types/dist/events/shared-channel.d.ts:61 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:65 +Defined in: packages/types/dist/events/shared-channel.d.ts:65 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann invite: SharedChannelInviteItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:60 +Defined in: packages/types/dist/events/shared-channel.d.ts:60 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann teams_in_channel: SharedChannelTeamItem[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:63 +Defined in: packages/types/dist/events/shared-channel.d.ts:63 *** @@ -72,4 +72,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann type: "shared_channel_invite_approved"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:59 +Defined in: packages/types/dist/events/shared-channel.d.ts:59 diff --git a/docs/english/reference/web-api/interfaces/SharedChannelInviteDeclinedEvent.md b/docs/english/reference/web-api/interfaces/SharedChannelInviteDeclinedEvent.md index 06b9cbcee..a3e789a8b 100644 --- a/docs/english/reference/web-api/interfaces/SharedChannelInviteDeclinedEvent.md +++ b/docs/english/reference/web-api/interfaces/SharedChannelInviteDeclinedEvent.md @@ -2,7 +2,7 @@ # Interface: SharedChannelInviteDeclinedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:71 +Defined in: packages/types/dist/events/shared-channel.d.ts:71 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann channel: SharedChannelItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:74 +Defined in: packages/types/dist/events/shared-channel.d.ts:74 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann declining_team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:75 +Defined in: packages/types/dist/events/shared-channel.d.ts:75 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann declining_user: SharedChannelUserItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:77 +Defined in: packages/types/dist/events/shared-channel.d.ts:77 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:78 +Defined in: packages/types/dist/events/shared-channel.d.ts:78 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann invite: SharedChannelInviteItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:73 +Defined in: packages/types/dist/events/shared-channel.d.ts:73 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann teams_in_channel: SharedChannelTeamItem[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:76 +Defined in: packages/types/dist/events/shared-channel.d.ts:76 *** @@ -72,4 +72,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann type: "shared_channel_invite_declined"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:72 +Defined in: packages/types/dist/events/shared-channel.d.ts:72 diff --git a/docs/english/reference/web-api/interfaces/SharedChannelInviteReceivedEvent.md b/docs/english/reference/web-api/interfaces/SharedChannelInviteReceivedEvent.md index 26e43ba85..c545d737f 100644 --- a/docs/english/reference/web-api/interfaces/SharedChannelInviteReceivedEvent.md +++ b/docs/english/reference/web-api/interfaces/SharedChannelInviteReceivedEvent.md @@ -2,7 +2,7 @@ # Interface: SharedChannelInviteReceivedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:84 +Defined in: packages/types/dist/events/shared-channel.d.ts:84 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann channel: SharedChannelItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:87 +Defined in: packages/types/dist/events/shared-channel.d.ts:87 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:88 +Defined in: packages/types/dist/events/shared-channel.d.ts:88 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann invite: SharedChannelInviteItem; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:86 +Defined in: packages/types/dist/events/shared-channel.d.ts:86 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann type: "shared_channel_invite_received"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:85 +Defined in: packages/types/dist/events/shared-channel.d.ts:85 diff --git a/docs/english/reference/web-api/interfaces/SharedChannelInviteRequestedEvent.md b/docs/english/reference/web-api/interfaces/SharedChannelInviteRequestedEvent.md index 7762d0fae..acd6c12ac 100644 --- a/docs/english/reference/web-api/interfaces/SharedChannelInviteRequestedEvent.md +++ b/docs/english/reference/web-api/interfaces/SharedChannelInviteRequestedEvent.md @@ -2,7 +2,7 @@ # Interface: SharedChannelInviteRequestedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:94 +Defined in: packages/types/dist/events/shared-channel.d.ts:94 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann actor: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:96 +Defined in: packages/types/dist/events/shared-channel.d.ts:96 #### display\_name @@ -64,7 +64,7 @@ timezone: string; channel_date_created: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:129 +Defined in: packages/types/dist/events/shared-channel.d.ts:129 *** @@ -74,7 +74,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann channel_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:105 +Defined in: packages/types/dist/events/shared-channel.d.ts:105 *** @@ -84,7 +84,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann channel_message_latest_counted_timestamp: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:130 +Defined in: packages/types/dist/events/shared-channel.d.ts:130 *** @@ -94,7 +94,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann channel_name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:107 +Defined in: packages/types/dist/events/shared-channel.d.ts:107 *** @@ -104,7 +104,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann channel_type: "private" | "public"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:108 +Defined in: packages/types/dist/events/shared-channel.d.ts:108 *** @@ -114,7 +114,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:131 +Defined in: packages/types/dist/events/shared-channel.d.ts:131 *** @@ -124,7 +124,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann event_type: "slack#/events/shared_channel_invite_requested"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:106 +Defined in: packages/types/dist/events/shared-channel.d.ts:106 *** @@ -134,7 +134,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann is_external_limited: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:128 +Defined in: packages/types/dist/events/shared-channel.d.ts:128 *** @@ -147,7 +147,7 @@ target_users: [{ }]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:109 +Defined in: packages/types/dist/events/shared-channel.d.ts:109 *** @@ -169,7 +169,7 @@ teams_in_channel: [{ }]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:113 +Defined in: packages/types/dist/events/shared-channel.d.ts:113 *** @@ -179,4 +179,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-chann type: "shared_channel_invite_requested"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:95 +Defined in: packages/types/dist/events/shared-channel.d.ts:95 diff --git a/docs/english/reference/web-api/interfaces/SlackFileImageObject.md b/docs/english/reference/web-api/interfaces/SlackFileImageObject.md index 6a84e0e92..419a2ca2f 100644 --- a/docs/english/reference/web-api/interfaces/SlackFileImageObject.md +++ b/docs/english/reference/web-api/interfaces/SlackFileImageObject.md @@ -2,7 +2,7 @@ # Interface: SlackFileImageObject -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:196 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:210 ## Description @@ -16,7 +16,7 @@ Object for image which contains a slack_file. slack_file: SlackFile; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:200 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:214 #### Description diff --git a/docs/english/reference/web-api/interfaces/StarAddedEvent.md b/docs/english/reference/web-api/interfaces/StarAddedEvent.md index 5ffb7daa2..422a7a9d4 100644 --- a/docs/english/reference/web-api/interfaces/StarAddedEvent.md +++ b/docs/english/reference/web-api/interfaces/StarAddedEvent.md @@ -2,7 +2,7 @@ # Interface: StarAddedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:1 +Defined in: packages/types/dist/events/star.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:1 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:5 +Defined in: packages/types/dist/events/star.d.ts:5 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:5 item: Record; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:4 +Defined in: packages/types/dist/events/star.d.ts:4 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:4 type: "star_added"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:2 +Defined in: packages/types/dist/events/star.d.ts:2 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:2 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:3 +Defined in: packages/types/dist/events/star.d.ts:3 diff --git a/docs/english/reference/web-api/interfaces/StarRemovedEvent.md b/docs/english/reference/web-api/interfaces/StarRemovedEvent.md index fa7a0b116..30c32dae2 100644 --- a/docs/english/reference/web-api/interfaces/StarRemovedEvent.md +++ b/docs/english/reference/web-api/interfaces/StarRemovedEvent.md @@ -2,7 +2,7 @@ # Interface: StarRemovedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:7 +Defined in: packages/types/dist/events/star.d.ts:7 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:7 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:11 +Defined in: packages/types/dist/events/star.d.ts:11 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:11 item: Record; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:10 +Defined in: packages/types/dist/events/star.d.ts:10 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:10 type: "star_removed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:8 +Defined in: packages/types/dist/events/star.d.ts:8 *** @@ -42,4 +42,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:8 user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/star.d.ts:9 +Defined in: packages/types/dist/events/star.d.ts:9 diff --git a/docs/english/reference/web-api/interfaces/StaticSelect.md b/docs/english/reference/web-api/interfaces/StaticSelect.md index d77bb2f6f..66c7ab94e 100644 --- a/docs/english/reference/web-api/interfaces/StaticSelect.md +++ b/docs/english/reference/web-api/interfaces/StaticSelect.md @@ -2,7 +2,7 @@ # Interface: StaticSelect -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:288 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:292 ## Description @@ -26,7 +26,7 @@ element. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -44,7 +44,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -63,7 +63,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_option: PlainTextOption; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:297 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:301 #### Description @@ -98,7 +98,7 @@ This option will be selected when the menu initially loads. optional option_groups: object[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:307 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:311 #### label @@ -125,7 +125,7 @@ this field should not be. optional options: PlainTextOption[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:302 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:306 #### Description @@ -140,7 +140,7 @@ specified, this field should not be. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -159,7 +159,7 @@ length for the `text` field in this object is 150 characters. type: "static_select"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:292 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:296 #### Description diff --git a/docs/english/reference/web-api/interfaces/SubteamCreatedEvent.md b/docs/english/reference/web-api/interfaces/SubteamCreatedEvent.md index 0a1555dd1..218a7c02b 100644 --- a/docs/english/reference/web-api/interfaces/SubteamCreatedEvent.md +++ b/docs/english/reference/web-api/interfaces/SubteamCreatedEvent.md @@ -2,7 +2,7 @@ # Interface: SubteamCreatedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:25 +Defined in: packages/types/dist/events/subteam.d.ts:25 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:28 +Defined in: packages/types/dist/events/subteam.d.ts:28 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts subteam: Subteam; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:27 +Defined in: packages/types/dist/events/subteam.d.ts:27 *** @@ -32,4 +32,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts type: "subteam_created"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:26 +Defined in: packages/types/dist/events/subteam.d.ts:26 diff --git a/docs/english/reference/web-api/interfaces/SubteamMembersChangedEvent.md b/docs/english/reference/web-api/interfaces/SubteamMembersChangedEvent.md index 5c2194649..8e877d1a8 100644 --- a/docs/english/reference/web-api/interfaces/SubteamMembersChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/SubteamMembersChangedEvent.md @@ -2,7 +2,7 @@ # Interface: SubteamMembersChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:34 +Defined in: packages/types/dist/events/subteam.d.ts:34 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts optional added_users: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:40 +Defined in: packages/types/dist/events/subteam.d.ts:40 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts optional added_users_count: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:41 +Defined in: packages/types/dist/events/subteam.d.ts:41 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts date_previous_update: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:38 +Defined in: packages/types/dist/events/subteam.d.ts:38 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts date_update: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:39 +Defined in: packages/types/dist/events/subteam.d.ts:39 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:44 +Defined in: packages/types/dist/events/subteam.d.ts:44 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts optional removed_users: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:42 +Defined in: packages/types/dist/events/subteam.d.ts:42 *** @@ -72,7 +72,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts optional removed_users_count: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:43 +Defined in: packages/types/dist/events/subteam.d.ts:43 *** @@ -82,7 +82,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts subteam_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:36 +Defined in: packages/types/dist/events/subteam.d.ts:36 *** @@ -92,7 +92,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts team_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:37 +Defined in: packages/types/dist/events/subteam.d.ts:37 *** @@ -102,4 +102,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts type: "subteam_members_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:35 +Defined in: packages/types/dist/events/subteam.d.ts:35 diff --git a/docs/english/reference/web-api/interfaces/SubteamSelfAddedEvent.md b/docs/english/reference/web-api/interfaces/SubteamSelfAddedEvent.md index 3198eb58c..d195ae783 100644 --- a/docs/english/reference/web-api/interfaces/SubteamSelfAddedEvent.md +++ b/docs/english/reference/web-api/interfaces/SubteamSelfAddedEvent.md @@ -2,7 +2,7 @@ # Interface: SubteamSelfAddedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:50 +Defined in: packages/types/dist/events/subteam.d.ts:50 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:53 +Defined in: packages/types/dist/events/subteam.d.ts:53 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts subteam_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:52 +Defined in: packages/types/dist/events/subteam.d.ts:52 *** @@ -32,4 +32,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts type: "subteam_self_added"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:51 +Defined in: packages/types/dist/events/subteam.d.ts:51 diff --git a/docs/english/reference/web-api/interfaces/SubteamSelfRemovedEvent.md b/docs/english/reference/web-api/interfaces/SubteamSelfRemovedEvent.md index a405dd9c4..f37eca742 100644 --- a/docs/english/reference/web-api/interfaces/SubteamSelfRemovedEvent.md +++ b/docs/english/reference/web-api/interfaces/SubteamSelfRemovedEvent.md @@ -2,7 +2,7 @@ # Interface: SubteamSelfRemovedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:55 +Defined in: packages/types/dist/events/subteam.d.ts:55 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:58 +Defined in: packages/types/dist/events/subteam.d.ts:58 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts subteam_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:57 +Defined in: packages/types/dist/events/subteam.d.ts:57 *** @@ -32,4 +32,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts type: "subteam_self_removed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:56 +Defined in: packages/types/dist/events/subteam.d.ts:56 diff --git a/docs/english/reference/web-api/interfaces/SubteamUpdatedEvent.md b/docs/english/reference/web-api/interfaces/SubteamUpdatedEvent.md index 07f329570..08a9b2ec6 100644 --- a/docs/english/reference/web-api/interfaces/SubteamUpdatedEvent.md +++ b/docs/english/reference/web-api/interfaces/SubteamUpdatedEvent.md @@ -2,7 +2,7 @@ # Interface: SubteamUpdatedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:60 +Defined in: packages/types/dist/events/subteam.d.ts:60 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:63 +Defined in: packages/types/dist/events/subteam.d.ts:63 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts subteam: Subteam; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:62 +Defined in: packages/types/dist/events/subteam.d.ts:62 *** @@ -32,4 +32,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts type: "subteam_updated"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:61 +Defined in: packages/types/dist/events/subteam.d.ts:61 diff --git a/docs/english/reference/web-api/interfaces/TableBlock.md b/docs/english/reference/web-api/interfaces/TableBlock.md new file mode 100644 index 000000000..4c1131eff --- /dev/null +++ b/docs/english/reference/web-api/interfaces/TableBlock.md @@ -0,0 +1,87 @@ +[@slack/web-api](../index.md) / TableBlock + +# Interface: TableBlock + +Defined in: packages/types/dist/block-kit/blocks.d.ts:273 + +## Description + +Displays structured information in a table. + +## See + +[Table block reference](https://docs.slack.dev/reference/block-kit/blocks/table-block). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 + +#### 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://docs.slack.dev/interactivity/handling-user-interaction#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) + +*** + +### column\_settings? + +```ts +optional column_settings: TableBlockColumnSettings[]; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:285 + +#### Description + +An array describing column behavior. If there are fewer items in the column_settings array than there are columns in the table, then the items in the the column_settings array will describe the same number of columns in the table as there are in the array itself. Any additional columns will have the default behavior. Maximum 20 items. + +*** + +### rows + +```ts +rows: ( + | RichTextBlock + | RawTextElement)[][]; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:281 + +#### Description + +An array consisting of table rows. Maximum 100 rows. Each row object is an array with a max of 20 table cells. Table cells can have a type of raw_text or rich_text. + +*** + +### type + +```ts +type: "table"; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:277 + +#### Description + +The type of block. For a table block, `type` is always `table`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) diff --git a/docs/english/reference/web-api/interfaces/TaskCardBlock.md b/docs/english/reference/web-api/interfaces/TaskCardBlock.md new file mode 100644 index 000000000..cfb396caf --- /dev/null +++ b/docs/english/reference/web-api/interfaces/TaskCardBlock.md @@ -0,0 +1,141 @@ +[@slack/web-api](../index.md) / TaskCardBlock + +# Interface: TaskCardBlock + +Defined in: packages/types/dist/block-kit/blocks.d.ts:305 + +## Description + +A discrete task or tool call. + +## See + +https://docs.slack.dev/reference/block-kit/blocks/task-card-block/ + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id: string; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 + +#### 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://docs.slack.dev/interactivity/handling-user-interaction#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) + +*** + +### details? + +```ts +optional details: RichTextBlock; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:321 + +#### Description + +Details of the task in the form of a single "rich_text" entity. + +*** + +### output? + +```ts +optional output: RichTextBlock; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:325 + +#### Description + +Output of the task in the form of a single "rich_text" entity. + +*** + +### sources? + +```ts +optional sources: URLSourceElement[]; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:329 + +#### Description + +Array of URL source elements used to generate a response. + +*** + +### status + +```ts +status: "pending" | "in_progress" | "complete" | "error"; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:333 + +#### Description + +The state of a task. Can be "pending", "in_progress", "complete", or "error". + +*** + +### task\_id + +```ts +task_id: string; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:313 + +#### Description + +ID for the task. + +*** + +### title + +```ts +title: string; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:317 + +#### Description + +Title of the task in plain text. + +*** + +### type + +```ts +type: "task_card"; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:309 + +#### Description + +The type of block. For this block, type will always be `task_card`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) diff --git a/docs/english/reference/web-api/interfaces/TaskEntityFields.md b/docs/english/reference/web-api/interfaces/TaskEntityFields.md new file mode 100644 index 000000000..238d9e4b1 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/TaskEntityFields.md @@ -0,0 +1,85 @@ +[@slack/web-api](../index.md) / TaskEntityFields + +# Interface: TaskEntityFields + +Defined in: packages/types/dist/message-metadata.d.ts:135 + +## Properties + +### assignee? + +```ts +optional assignee: EntityTypedField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:140 + +*** + +### created\_by? + +```ts +optional created_by: EntityTypedField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:137 + +*** + +### date\_created? + +```ts +optional date_created: EntityTimestampField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:138 + +*** + +### date\_updated? + +```ts +optional date_updated: EntityTimestampField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:139 + +*** + +### description? + +```ts +optional description: EntityStringField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:136 + +*** + +### due\_date? + +```ts +optional due_date: EntityTypedField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:142 + +*** + +### priority? + +```ts +optional priority: EntityStringField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:143 + +*** + +### status? + +```ts +optional status: EntityStringField; +``` + +Defined in: packages/types/dist/message-metadata.d.ts:141 diff --git a/docs/english/reference/web-api/interfaces/TaskUpdateChunk.md b/docs/english/reference/web-api/interfaces/TaskUpdateChunk.md new file mode 100644 index 000000000..ab1223a2c --- /dev/null +++ b/docs/english/reference/web-api/interfaces/TaskUpdateChunk.md @@ -0,0 +1,86 @@ +[@slack/web-api](../index.md) / TaskUpdateChunk + +# Interface: TaskUpdateChunk + +Defined in: packages/types/dist/chunk.d.ts:29 + +Used for displaying task progress in a timeline-style UI. +https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming + +## Extends + +- [`Chunk`](Chunk.md) + +## Properties + +### details? + +```ts +optional details: string; +``` + +Defined in: packages/types/dist/chunk.d.ts:34 + +*** + +### id + +```ts +id: string; +``` + +Defined in: packages/types/dist/chunk.d.ts:31 + +*** + +### output? + +```ts +optional output: string; +``` + +Defined in: packages/types/dist/chunk.d.ts:35 + +*** + +### sources? + +```ts +optional sources: URLSourceElement[]; +``` + +Defined in: packages/types/dist/chunk.d.ts:36 + +*** + +### status + +```ts +status: "pending" | "in_progress" | "complete" | "error"; +``` + +Defined in: packages/types/dist/chunk.d.ts:33 + +*** + +### title + +```ts +title: string; +``` + +Defined in: packages/types/dist/chunk.d.ts:32 + +*** + +### type + +```ts +type: "task_update"; +``` + +Defined in: packages/types/dist/chunk.d.ts:30 + +#### Overrides + +[`Chunk`](Chunk.md).[`type`](Chunk.md#type) diff --git a/docs/english/reference/web-api/interfaces/TeamAccessGrantedEvent.md b/docs/english/reference/web-api/interfaces/TeamAccessGrantedEvent.md index 76eb830e2..50fc9d8ba 100644 --- a/docs/english/reference/web-api/interfaces/TeamAccessGrantedEvent.md +++ b/docs/english/reference/web-api/interfaces/TeamAccessGrantedEvent.md @@ -2,7 +2,7 @@ # Interface: TeamAccessGrantedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:2 +Defined in: packages/types/dist/events/team.d.ts:2 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:2 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:5 +Defined in: packages/types/dist/events/team.d.ts:5 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:5 team_ids: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:4 +Defined in: packages/types/dist/events/team.d.ts:4 *** @@ -32,4 +32,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:4 type: "team_access_granted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:3 +Defined in: packages/types/dist/events/team.d.ts:3 diff --git a/docs/english/reference/web-api/interfaces/TeamAccessRevokedEvent.md b/docs/english/reference/web-api/interfaces/TeamAccessRevokedEvent.md index be58dd0c1..e0d4a2124 100644 --- a/docs/english/reference/web-api/interfaces/TeamAccessRevokedEvent.md +++ b/docs/english/reference/web-api/interfaces/TeamAccessRevokedEvent.md @@ -2,7 +2,7 @@ # Interface: TeamAccessRevokedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:7 +Defined in: packages/types/dist/events/team.d.ts:7 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:7 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:10 +Defined in: packages/types/dist/events/team.d.ts:10 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:10 team_ids: string[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:9 +Defined in: packages/types/dist/events/team.d.ts:9 *** @@ -32,4 +32,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:9 type: "team_access_revoked"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:8 +Defined in: packages/types/dist/events/team.d.ts:8 diff --git a/docs/english/reference/web-api/interfaces/TeamDomainChangeEvent.md b/docs/english/reference/web-api/interfaces/TeamDomainChangeEvent.md index 6d11dc9d6..781abe363 100644 --- a/docs/english/reference/web-api/interfaces/TeamDomainChangeEvent.md +++ b/docs/english/reference/web-api/interfaces/TeamDomainChangeEvent.md @@ -2,7 +2,7 @@ # Interface: TeamDomainChangeEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:12 +Defined in: packages/types/dist/events/team.d.ts:12 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:12 domain: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:15 +Defined in: packages/types/dist/events/team.d.ts:15 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:15 type: "team_domain_change"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:13 +Defined in: packages/types/dist/events/team.d.ts:13 *** @@ -32,4 +32,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:13 url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:14 +Defined in: packages/types/dist/events/team.d.ts:14 diff --git a/docs/english/reference/web-api/interfaces/TeamJoinEvent.md b/docs/english/reference/web-api/interfaces/TeamJoinEvent.md index cf60b8484..fca1bd6e9 100644 --- a/docs/english/reference/web-api/interfaces/TeamJoinEvent.md +++ b/docs/english/reference/web-api/interfaces/TeamJoinEvent.md @@ -2,7 +2,7 @@ # Interface: TeamJoinEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:17 +Defined in: packages/types/dist/events/team.d.ts:17 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:17 cache_ts: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:92 +Defined in: packages/types/dist/events/team.d.ts:92 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:92 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:93 +Defined in: packages/types/dist/events/team.d.ts:93 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:93 type: "team_join"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:18 +Defined in: packages/types/dist/events/team.d.ts:18 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:18 user: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:19 +Defined in: packages/types/dist/events/team.d.ts:19 #### color diff --git a/docs/english/reference/web-api/interfaces/TeamRenameEvent.md b/docs/english/reference/web-api/interfaces/TeamRenameEvent.md index bf2649681..c629cbfda 100644 --- a/docs/english/reference/web-api/interfaces/TeamRenameEvent.md +++ b/docs/english/reference/web-api/interfaces/TeamRenameEvent.md @@ -2,7 +2,7 @@ # Interface: TeamRenameEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:95 +Defined in: packages/types/dist/events/team.d.ts:95 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:95 name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:97 +Defined in: packages/types/dist/events/team.d.ts:97 *** @@ -22,4 +22,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:97 type: "team_rename"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/team.d.ts:96 +Defined in: packages/types/dist/events/team.d.ts:96 diff --git a/docs/english/reference/web-api/interfaces/ThreadBroadcastMessageEvent.md b/docs/english/reference/web-api/interfaces/ThreadBroadcastMessageEvent.md index 435363b25..96e865213 100644 --- a/docs/english/reference/web-api/interfaces/ThreadBroadcastMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/ThreadBroadcastMessageEvent.md @@ -2,7 +2,7 @@ # Interface: ThreadBroadcastMessageEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:225 +Defined in: packages/types/dist/events/message.d.ts:225 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional attachments: MessageAttachment[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:230 +Defined in: packages/types/dist/events/message.d.ts:230 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional blocks: (Block | KnownBlock)[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:231 +Defined in: packages/types/dist/events/message.d.ts:231 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:243 +Defined in: packages/types/dist/events/message.d.ts:243 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts channel_type: ChannelTypes; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:244 +Defined in: packages/types/dist/events/message.d.ts:244 *** @@ -52,7 +52,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts client_msg_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:242 +Defined in: packages/types/dist/events/message.d.ts:242 *** @@ -62,7 +62,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:228 +Defined in: packages/types/dist/events/message.d.ts:228 *** @@ -74,7 +74,7 @@ root: | BotMessageEvent & object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:235 +Defined in: packages/types/dist/events/message.d.ts:235 #### Type Declaration @@ -116,7 +116,7 @@ thread_ts: string; subtype: "thread_broadcast"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:227 +Defined in: packages/types/dist/events/message.d.ts:227 *** @@ -126,7 +126,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:229 +Defined in: packages/types/dist/events/message.d.ts:229 *** @@ -136,7 +136,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts optional thread_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:234 +Defined in: packages/types/dist/events/message.d.ts:234 *** @@ -146,7 +146,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:233 +Defined in: packages/types/dist/events/message.d.ts:233 *** @@ -156,7 +156,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts type: "message"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:226 +Defined in: packages/types/dist/events/message.d.ts:226 *** @@ -166,4 +166,4 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:232 +Defined in: packages/types/dist/events/message.d.ts:232 diff --git a/docs/english/reference/web-api/interfaces/Timepicker.md b/docs/english/reference/web-api/interfaces/Timepicker.md index 238f550ad..c44f87e51 100644 --- a/docs/english/reference/web-api/interfaces/Timepicker.md +++ b/docs/english/reference/web-api/interfaces/Timepicker.md @@ -2,7 +2,7 @@ # Interface: Timepicker -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:582 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:586 ## Description @@ -27,7 +27,7 @@ native time picker UIs. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -45,7 +45,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -64,7 +64,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -84,7 +84,7 @@ Defaults to `false`. optional initial_time: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:592 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:596 #### Description @@ -100,7 +100,7 @@ for example 22:25 for 10:25pm. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -119,7 +119,7 @@ length for the `text` field in this object is 150 characters. optional timezone: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:597 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:601 #### Description @@ -134,7 +134,7 @@ text underneath the time picker. It is also passed to the app upon certain inter type: "timepicker"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:586 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:590 #### Description diff --git a/docs/english/reference/web-api/interfaces/TokensRevokedEvent.md b/docs/english/reference/web-api/interfaces/TokensRevokedEvent.md index 84d672ca8..b9ae195a8 100644 --- a/docs/english/reference/web-api/interfaces/TokensRevokedEvent.md +++ b/docs/english/reference/web-api/interfaces/TokensRevokedEvent.md @@ -2,7 +2,7 @@ # Interface: TokensRevokedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/token.d.ts:1 +Defined in: packages/types/dist/events/token.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/token.d.ts:1 tokens: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/token.d.ts:3 +Defined in: packages/types/dist/events/token.d.ts:3 #### bot? @@ -34,4 +34,4 @@ optional oauth: string[]; type: "tokens_revoked"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/token.d.ts:2 +Defined in: packages/types/dist/events/token.d.ts:2 diff --git a/docs/english/reference/web-api/interfaces/URLInput.md b/docs/english/reference/web-api/interfaces/URLInput.md index 632181a6c..cb157656f 100644 --- a/docs/english/reference/web-api/interfaces/URLInput.md +++ b/docs/english/reference/web-api/interfaces/URLInput.md @@ -2,7 +2,7 @@ # Interface: URLInput -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:604 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:608 ## Description @@ -25,7 +25,7 @@ Allows user to enter a URL into a single-line field. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -43,7 +43,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional dispatch_action_config: DispatchActionConfig; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:28 +Defined in: packages/types/dist/block-kit/extensions.d.ts:28 #### Description @@ -62,7 +62,7 @@ A [DispatchActionConfig](DispatchActionConfig.md) object that determines when du optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_value: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:612 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:616 #### Description @@ -96,7 +96,7 @@ The initial value in the URL input when it is loaded. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -115,7 +115,7 @@ length for the `text` field in this object is 150 characters. type: "url_text_input"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:608 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:612 #### Description diff --git a/docs/english/reference/web-api/interfaces/URLRespondable.md b/docs/english/reference/web-api/interfaces/URLRespondable.md index 3b36e4922..15ac4f4f1 100644 --- a/docs/english/reference/web-api/interfaces/URLRespondable.md +++ b/docs/english/reference/web-api/interfaces/URLRespondable.md @@ -2,7 +2,7 @@ # Interface: URLRespondable -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:51 +Defined in: packages/types/dist/block-kit/extensions.d.ts:51 ## Extended by @@ -17,7 +17,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extension optional response_url_enabled: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:58 +Defined in: packages/types/dist/block-kit/extensions.d.ts:58 #### Description diff --git a/docs/english/reference/web-api/interfaces/URLSourceElement.md b/docs/english/reference/web-api/interfaces/URLSourceElement.md new file mode 100644 index 000000000..68cdd38e0 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/URLSourceElement.md @@ -0,0 +1,55 @@ +[@slack/web-api](../index.md) / URLSourceElement + +# Interface: URLSourceElement + +Defined in: packages/types/dist/block-kit/block-elements.d.ts:622 + +## Description + +A URL source element that displays a URL source for referencing within a task card block. + +## See + +[https://docs.slack.dev/reference/block-kit/block-elements/url-source-element](https://docs.slack.dev/reference/block-kit/block-elements/url-source-element) + +## Properties + +### text + +```ts +text: string; +``` + +Defined in: packages/types/dist/block-kit/block-elements.d.ts:634 + +#### Description + +Display text for the URL. + +*** + +### type + +```ts +type: "url"; +``` + +Defined in: packages/types/dist/block-kit/block-elements.d.ts:626 + +#### Description + +The type of element. In this case `type` is always `url`. + +*** + +### url + +```ts +url: string; +``` + +Defined in: packages/types/dist/block-kit/block-elements.d.ts:630 + +#### Description + +The URL type source. diff --git a/docs/english/reference/web-api/interfaces/UrlImageObject.md b/docs/english/reference/web-api/interfaces/UrlImageObject.md index 71c6229a9..31418186f 100644 --- a/docs/english/reference/web-api/interfaces/UrlImageObject.md +++ b/docs/english/reference/web-api/interfaces/UrlImageObject.md @@ -2,7 +2,7 @@ # Interface: UrlImageObject -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:187 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:201 ## Description @@ -16,7 +16,7 @@ Object for image which contains a image_url. image_url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:191 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:205 #### Description diff --git a/docs/english/reference/web-api/interfaces/UserChangeEvent.md b/docs/english/reference/web-api/interfaces/UserChangeEvent.md index 72d88e560..524cf3137 100644 --- a/docs/english/reference/web-api/interfaces/UserChangeEvent.md +++ b/docs/english/reference/web-api/interfaces/UserChangeEvent.md @@ -2,7 +2,7 @@ # Interface: UserChangeEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:2 +Defined in: packages/types/dist/events/user.d.ts:2 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:2 cache_ts: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:77 +Defined in: packages/types/dist/events/user.d.ts:77 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:77 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:78 +Defined in: packages/types/dist/events/user.d.ts:78 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:78 type: "user_change"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:3 +Defined in: packages/types/dist/events/user.d.ts:3 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:3 user: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:4 +Defined in: packages/types/dist/events/user.d.ts:4 #### color diff --git a/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md b/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md index 7b6a4ab06..0f941fb3b 100644 --- a/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md @@ -2,7 +2,7 @@ # Interface: UserHuddleChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:80 +Defined in: packages/types/dist/events/user.d.ts:80 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:80 cache_ts: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:155 +Defined in: packages/types/dist/events/user.d.ts:156 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:15 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:156 +Defined in: packages/types/dist/events/user.d.ts:157 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:15 type: "user_huddle_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:81 +Defined in: packages/types/dist/events/user.d.ts:81 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:81 user: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:82 +Defined in: packages/types/dist/events/user.d.ts:82 #### color @@ -253,6 +253,12 @@ first_name: string; huddle_state: string; ``` +##### profile.huddle\_state\_call\_id? + +```ts +optional huddle_state_call_id: string; +``` + ##### profile.huddle\_state\_expiration\_ts ```ts diff --git a/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md b/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md index 775af5c84..69c035ebb 100644 --- a/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md @@ -2,7 +2,7 @@ # Interface: UserProfileChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:158 +Defined in: packages/types/dist/events/user.d.ts:159 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:15 cache_ts: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:233 +Defined in: packages/types/dist/events/user.d.ts:234 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:23 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:234 +Defined in: packages/types/dist/events/user.d.ts:235 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:23 type: "user_profile_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:159 +Defined in: packages/types/dist/events/user.d.ts:160 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:15 user: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:160 +Defined in: packages/types/dist/events/user.d.ts:161 #### color diff --git a/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md b/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md index 0b75de8a8..38e36817b 100644 --- a/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md @@ -2,7 +2,7 @@ # Interface: UserStatusChangedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:236 +Defined in: packages/types/dist/events/user.d.ts:237 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:23 cache_ts: number; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:309 +Defined in: packages/types/dist/events/user.d.ts:310 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:30 event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:310 +Defined in: packages/types/dist/events/user.d.ts:311 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:31 type: "user_status_changed"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:237 +Defined in: packages/types/dist/events/user.d.ts:238 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:23 user: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/user.d.ts:238 +Defined in: packages/types/dist/events/user.d.ts:239 #### color diff --git a/docs/english/reference/web-api/interfaces/UsersSelect.md b/docs/english/reference/web-api/interfaces/UsersSelect.md index b11faac99..94d57046e 100644 --- a/docs/english/reference/web-api/interfaces/UsersSelect.md +++ b/docs/english/reference/web-api/interfaces/UsersSelect.md @@ -2,7 +2,7 @@ # Interface: UsersSelect -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:256 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:260 ## Description @@ -26,7 +26,7 @@ active workspace. optional action_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:12 +Defined in: packages/types/dist/block-kit/extensions.d.ts:12 @description: An identifier for this action. You can use this when you receive an interaction payload to [identify the source of the action](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Should be unique @@ -44,7 +44,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -63,7 +63,7 @@ with. optional focus_on_load: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:36 +Defined in: packages/types/dist/block-kit/extensions.d.ts:36 #### Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_user: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:264 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:268 #### Description @@ -97,7 +97,7 @@ The user ID of any valid user to be pre-selected when the menu loads. optional placeholder: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:49 +Defined in: packages/types/dist/block-kit/extensions.d.ts:49 #### Description @@ -116,7 +116,7 @@ length for the `text` field in this object is 150 characters. type: "users_select"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:260 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:264 #### Description diff --git a/docs/english/reference/web-api/interfaces/VideoBlock.md b/docs/english/reference/web-api/interfaces/VideoBlock.md index 5472becc5..34d1d0486 100644 --- a/docs/english/reference/web-api/interfaces/VideoBlock.md +++ b/docs/english/reference/web-api/interfaces/VideoBlock.md @@ -2,7 +2,7 @@ # Interface: VideoBlock -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:274 +Defined in: packages/types/dist/block-kit/blocks.d.ts:359 ## Description @@ -26,7 +26,7 @@ must have the [\`links.embed:write\` scope](https://docs.slack.dev/reference/sco alt_text: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:292 +Defined in: packages/types/dist/block-kit/blocks.d.ts:377 #### Description @@ -40,7 +40,7 @@ A tooltip for the video. Required for accessibility. optional author_name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:305 +Defined in: packages/types/dist/block-kit/blocks.d.ts:390 #### Description @@ -54,7 +54,7 @@ Author name to be displayed. Must be less than 50 characters. optional block_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:15 +Defined in: packages/types/dist/block-kit/blocks.d.ts:15 #### Description @@ -76,7 +76,7 @@ a message. If a message is updated, use a new `block_id`. optional description: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:317 +Defined in: packages/types/dist/block-kit/blocks.d.ts:402 #### Description @@ -90,7 +90,7 @@ Description for video using a [PlainTextElement](PlainTextElement.md) object. optional provider_icon_url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:313 +Defined in: packages/types/dist/block-kit/blocks.d.ts:398 #### Description @@ -104,7 +104,7 @@ Icon for the video provider, e.g. YouTube icon. optional provider_name: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:309 +Defined in: packages/types/dist/block-kit/blocks.d.ts:394 #### Description @@ -118,7 +118,7 @@ The originating application or domain of the video, e.g. YouTube. thumbnail_url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:288 +Defined in: packages/types/dist/block-kit/blocks.d.ts:373 #### Description @@ -132,7 +132,7 @@ The thumbnail image URL. title: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:296 +Defined in: packages/types/dist/block-kit/blocks.d.ts:381 #### Description @@ -146,7 +146,7 @@ Video title as a [PlainTextElement](PlainTextElement.md) object. `text` within m optional title_url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:301 +Defined in: packages/types/dist/block-kit/blocks.d.ts:386 #### Description @@ -161,7 +161,7 @@ Must go to an HTTPS URL. type: "video"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:278 +Defined in: packages/types/dist/block-kit/blocks.d.ts:363 #### Description @@ -179,7 +179,7 @@ The type of block. For a video block, `type` is always `video`. video_url: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:284 +Defined in: packages/types/dist/block-kit/blocks.d.ts:369 #### Description diff --git a/docs/english/reference/web-api/interfaces/WebAPIHTTPError.md b/docs/english/reference/web-api/interfaces/WebAPIHTTPError.md index 8bd524bb5..c78536b97 100644 --- a/docs/english/reference/web-api/interfaces/WebAPIHTTPError.md +++ b/docs/english/reference/web-api/interfaces/WebAPIHTTPError.md @@ -42,7 +42,7 @@ Defined in: [packages/web-api/src/errors.ts:52](https://github.com/slackapi/node optional errno: number; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:102 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -94,7 +94,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 optional path: string; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:104 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -142,7 +142,7 @@ Defined in: [packages/web-api/src/errors.ts:54](https://github.com/slackapi/node optional syscall: string; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:105 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/web-api/interfaces/WebAPIPlatformError.md b/docs/english/reference/web-api/interfaces/WebAPIPlatformError.md index 81b0a5273..c818e27b7 100644 --- a/docs/english/reference/web-api/interfaces/WebAPIPlatformError.md +++ b/docs/english/reference/web-api/interfaces/WebAPIPlatformError.md @@ -50,7 +50,7 @@ error: string; optional errno: number; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:102 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -92,7 +92,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 optional path: string; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:104 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -120,7 +120,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 optional syscall: string; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:105 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/web-api/interfaces/WebAPIRateLimitedError.md b/docs/english/reference/web-api/interfaces/WebAPIRateLimitedError.md index eb5a346c8..94e559b6a 100644 --- a/docs/english/reference/web-api/interfaces/WebAPIRateLimitedError.md +++ b/docs/english/reference/web-api/interfaces/WebAPIRateLimitedError.md @@ -32,7 +32,7 @@ Defined in: [packages/web-api/src/errors.ts:61](https://github.com/slackapi/node optional errno: number; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:102 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -74,7 +74,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 optional path: string; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:104 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -112,7 +112,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 optional syscall: string; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:105 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/web-api/interfaces/WebAPIRequestError.md b/docs/english/reference/web-api/interfaces/WebAPIRequestError.md index 1830051aa..6b0d754ef 100644 --- a/docs/english/reference/web-api/interfaces/WebAPIRequestError.md +++ b/docs/english/reference/web-api/interfaces/WebAPIRequestError.md @@ -32,7 +32,7 @@ Defined in: [packages/web-api/src/errors.ts:47](https://github.com/slackapi/node optional errno: number; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:102 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -84,7 +84,7 @@ Defined in: [packages/web-api/src/errors.ts:48](https://github.com/slackapi/node optional path: string; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:104 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -112,7 +112,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 optional syscall: string; ``` -Defined in: packages/web-api/node\_modules/@types/node/globals.d.ts:105 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/web-api/interfaces/WorkflowButton.md b/docs/english/reference/web-api/interfaces/WorkflowButton.md index 0d13d5dd9..91d5b55fe 100644 --- a/docs/english/reference/web-api/interfaces/WorkflowButton.md +++ b/docs/english/reference/web-api/interfaces/WorkflowButton.md @@ -2,7 +2,7 @@ # Interface: WorkflowButton -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:618 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:640 ## Description @@ -24,7 +24,7 @@ Allows users to run a [link trigger](https://docs.slack.dev/tools/deno-slack-sdk optional accessibility_label: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:672 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:694 #### Description @@ -39,7 +39,7 @@ readers instead of the button `text` object. Maximum length for this field is 75 optional confirm: ConfirmationDialog; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/extensions.d.ts:21 +Defined in: packages/types/dist/block-kit/extensions.d.ts:21 #### Description @@ -58,7 +58,7 @@ with. optional style: ColorScheme; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:667 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:689 #### Description @@ -77,7 +77,7 @@ If you don't include this field, the default button style will be used. text: PlainTextElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:627 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:649 #### Description @@ -92,7 +92,7 @@ Maximum length for the `text` in this field is 75 characters. type: "workflow_button"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:622 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:644 #### Description @@ -106,7 +106,7 @@ The type of element. In this case `type` is always `workflow_button`. workflow: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:631 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:653 #### trigger diff --git a/docs/english/reference/web-api/interfaces/WorkflowDeletedEvent.md b/docs/english/reference/web-api/interfaces/WorkflowDeletedEvent.md index eea1a025f..01adb4647 100644 --- a/docs/english/reference/web-api/interfaces/WorkflowDeletedEvent.md +++ b/docs/english/reference/web-api/interfaces/WorkflowDeletedEvent.md @@ -2,7 +2,7 @@ # Interface: WorkflowDeletedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:1 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:1 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:12 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:12 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a type: "workflow_deleted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:2 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:2 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a workflow_draft_configuration: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:4 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:4 #### app\_steps @@ -54,4 +54,4 @@ version_id: string; workflow_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:3 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:3 diff --git a/docs/english/reference/web-api/interfaces/WorkflowPublishedEvent.md b/docs/english/reference/web-api/interfaces/WorkflowPublishedEvent.md index c58930da3..9ead189ce 100644 --- a/docs/english/reference/web-api/interfaces/WorkflowPublishedEvent.md +++ b/docs/english/reference/web-api/interfaces/WorkflowPublishedEvent.md @@ -2,7 +2,7 @@ # Interface: WorkflowPublishedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:14 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:14 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:25 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:25 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a type: "workflow_published"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:15 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:15 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a workflow_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:16 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:16 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a workflow_published_configuration: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:17 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:17 #### app\_steps diff --git a/docs/english/reference/web-api/interfaces/WorkflowStepDeletedEvent.md b/docs/english/reference/web-api/interfaces/WorkflowStepDeletedEvent.md index 09608dd9f..df62f7f65 100644 --- a/docs/english/reference/web-api/interfaces/WorkflowStepDeletedEvent.md +++ b/docs/english/reference/web-api/interfaces/WorkflowStepDeletedEvent.md @@ -2,7 +2,7 @@ # Interface: WorkflowStepDeletedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:40 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:40 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:59 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:59 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a type: "workflow_step_deleted"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:41 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:41 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a workflow_draft_configuration: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:43 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:43 #### app\_steps @@ -54,7 +54,7 @@ version_id: string; workflow_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:42 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:42 *** @@ -64,7 +64,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a optional workflow_published_configuration: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:51 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:51 #### app\_steps diff --git a/docs/english/reference/web-api/interfaces/WorkflowStepExecuteEvent.md b/docs/english/reference/web-api/interfaces/WorkflowStepExecuteEvent.md index 09d10713b..d109926d1 100644 --- a/docs/english/reference/web-api/interfaces/WorkflowStepExecuteEvent.md +++ b/docs/english/reference/web-api/interfaces/WorkflowStepExecuteEvent.md @@ -2,7 +2,7 @@ # Interface: WorkflowStepExecuteEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:61 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:61 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a callback_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:63 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:63 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:80 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:80 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a type: "workflow_step_execute"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:62 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:62 *** @@ -42,7 +42,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a workflow_step: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:64 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:64 #### inputs diff --git a/docs/english/reference/web-api/interfaces/WorkflowStepView.md b/docs/english/reference/web-api/interfaces/WorkflowStepView.md index c167cc907..1244115e3 100644 --- a/docs/english/reference/web-api/interfaces/WorkflowStepView.md +++ b/docs/english/reference/web-api/interfaces/WorkflowStepView.md @@ -2,7 +2,7 @@ # ~~Interface: WorkflowStepView~~ -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:61 +Defined in: packages/types/dist/views.d.ts:61 [modal](https://docs.slack.dev/legacy/legacy-steps-from-appsConfiguration) for [legacy Workflow Steps from Apps](https://docs.slack.dev/legacy/legacy-steps-from-apps). @@ -22,7 +22,7 @@ Steps from Apps are deprecated and will no longer be executed starting September blocks: AnyBlock[]; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:5 +Defined in: packages/types/dist/views.d.ts:5 #### Description @@ -42,7 +42,7 @@ BaseView.blocks optional callback_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:18 +Defined in: packages/types/dist/views.d.ts:18 #### Description @@ -67,7 +67,7 @@ BaseView.callback_id optional external_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:20 +Defined in: packages/types/dist/views.d.ts:20 #### Description @@ -87,7 +87,7 @@ BaseView.external_id optional private_metadata: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:12 +Defined in: packages/types/dist/views.d.ts:12 #### Description @@ -110,7 +110,7 @@ BaseView.private_metadata optional submit_disabled: boolean; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:67 +Defined in: packages/types/dist/views.d.ts:67 #### Description @@ -125,4 +125,4 @@ Defaults to `false`. type: "workflow_step"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:62 +Defined in: packages/types/dist/views.d.ts:62 diff --git a/docs/english/reference/web-api/interfaces/WorkflowUnpublishedEvent.md b/docs/english/reference/web-api/interfaces/WorkflowUnpublishedEvent.md index 01aec3934..5bc90f788 100644 --- a/docs/english/reference/web-api/interfaces/WorkflowUnpublishedEvent.md +++ b/docs/english/reference/web-api/interfaces/WorkflowUnpublishedEvent.md @@ -2,7 +2,7 @@ # Interface: WorkflowUnpublishedEvent -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:27 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:27 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a event_ts: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:38 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:38 *** @@ -22,7 +22,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a type: "workflow_unpublished"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:28 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:28 *** @@ -32,7 +32,7 @@ Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-a workflow_draft_configuration: object; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:30 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:30 #### app\_steps @@ -54,4 +54,4 @@ version_id: string; workflow_id: string; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/steps-from-apps.d.ts:29 +Defined in: packages/types/dist/events/steps-from-apps.d.ts:29 diff --git a/docs/english/reference/web-api/type-aliases/ActionsBlockElement.md b/docs/english/reference/web-api/type-aliases/ActionsBlockElement.md index a134eea78..3e5dee663 100644 --- a/docs/english/reference/web-api/type-aliases/ActionsBlockElement.md +++ b/docs/english/reference/web-api/type-aliases/ActionsBlockElement.md @@ -17,7 +17,7 @@ type ActionsBlockElement = | RichTextInput; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:31 +Defined in: packages/types/dist/block-kit/blocks.d.ts:31 A helper union type of all Block Elements that can be used in an [ActionsBlock](../interfaces/ActionsBlock.md). diff --git a/docs/english/reference/web-api/type-aliases/AllMessageEvents.md b/docs/english/reference/web-api/type-aliases/AllMessageEvents.md index b7fa58566..10acda080 100644 --- a/docs/english/reference/web-api/type-aliases/AllMessageEvents.md +++ b/docs/english/reference/web-api/type-aliases/AllMessageEvents.md @@ -23,4 +23,4 @@ type AllMessageEvents = | ThreadBroadcastMessageEvent; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:5 +Defined in: packages/types/dist/events/message.d.ts:5 diff --git a/docs/english/reference/web-api/type-aliases/AllMessageMetadataEvents.md b/docs/english/reference/web-api/type-aliases/AllMessageMetadataEvents.md index 1e19eeab1..c780657be 100644 --- a/docs/english/reference/web-api/type-aliases/AllMessageMetadataEvents.md +++ b/docs/english/reference/web-api/type-aliases/AllMessageMetadataEvents.md @@ -9,4 +9,4 @@ type AllMessageMetadataEvents = | MessageMetadataUpdatedEvent; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message-metadata.d.ts:2 +Defined in: packages/types/dist/events/message-metadata.d.ts:2 diff --git a/docs/english/reference/web-api/type-aliases/AnyBlock.md b/docs/english/reference/web-api/type-aliases/AnyBlock.md index 8a5b895f9..a7352b5e5 100644 --- a/docs/english/reference/web-api/type-aliases/AnyBlock.md +++ b/docs/english/reference/web-api/type-aliases/AnyBlock.md @@ -6,7 +6,7 @@ type AnyBlock = KnownBlock | Block; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:26 +Defined in: packages/types/dist/block-kit/blocks.d.ts:26 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://docs.slack.dev/reference/block-kit/blocks). diff --git a/docs/english/reference/web-api/type-aliases/AnyChunk.md b/docs/english/reference/web-api/type-aliases/AnyChunk.md new file mode 100644 index 000000000..4e1379a5e --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/AnyChunk.md @@ -0,0 +1,14 @@ +[@slack/web-api](../index.md) / AnyChunk + +# Type Alias: AnyChunk + +```ts +type AnyChunk = + | MarkdownTextChunk + | PlanUpdateChunk + | TaskUpdateChunk; +``` + +Defined in: packages/types/dist/chunk.d.ts:41 + +Union type of all possible chunk types diff --git a/docs/english/reference/web-api/type-aliases/AppsUserConnectionUpdateResponse.md b/docs/english/reference/web-api/type-aliases/AppsUserConnectionUpdateResponse.md new file mode 100644 index 000000000..1ee6119a6 --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/AppsUserConnectionUpdateResponse.md @@ -0,0 +1,41 @@ +[@slack/web-api](../index.md) / AppsUserConnectionUpdateResponse + +# Type Alias: AppsUserConnectionUpdateResponse + +```ts +type AppsUserConnectionUpdateResponse = WebAPICallResult & object; +``` + +Defined in: [packages/web-api/src/types/response/AppsUserConnectionUpdateResponse.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsUserConnectionUpdateResponse.ts#L11) + +## 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; +``` diff --git a/docs/english/reference/web-api/type-aliases/CallUser.md b/docs/english/reference/web-api/type-aliases/CallUser.md index 66780aa1c..ffceb2207 100644 --- a/docs/english/reference/web-api/type-aliases/CallUser.md +++ b/docs/english/reference/web-api/type-aliases/CallUser.md @@ -8,7 +8,7 @@ type CallUser = | CallUserExternal; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/calls.d.ts:4 +Defined in: packages/types/dist/calls.d.ts:4 ## Description diff --git a/docs/english/reference/web-api/type-aliases/CanvasesCreateArguments.md b/docs/english/reference/web-api/type-aliases/CanvasesCreateArguments.md index fb33a9c23..59752953c 100644 --- a/docs/english/reference/web-api/type-aliases/CanvasesCreateArguments.md +++ b/docs/english/reference/web-api/type-aliases/CanvasesCreateArguments.md @@ -3,7 +3,7 @@ # Type Alias: CanvasesCreateArguments ```ts -type CanvasesCreateArguments = OptionalArgument; +type CanvasesCreateArguments = OptionalArgument & object>; ``` Defined in: [packages/web-api/src/types/request/canvas.ts:67](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L67) diff --git a/docs/english/reference/web-api/type-aliases/ColorScheme.md b/docs/english/reference/web-api/type-aliases/ColorScheme.md index 290646458..8e1a7b276 100644 --- a/docs/english/reference/web-api/type-aliases/ColorScheme.md +++ b/docs/english/reference/web-api/type-aliases/ColorScheme.md @@ -6,7 +6,7 @@ type ColorScheme = "primary" | "danger"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:5 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:5 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). diff --git a/docs/english/reference/web-api/type-aliases/ContextActionsBlockElement.md b/docs/english/reference/web-api/type-aliases/ContextActionsBlockElement.md index 09e0f8c54..9afebc4cb 100644 --- a/docs/english/reference/web-api/type-aliases/ContextActionsBlockElement.md +++ b/docs/english/reference/web-api/type-aliases/ContextActionsBlockElement.md @@ -8,6 +8,6 @@ type ContextActionsBlockElement = | IconButton; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:70 +Defined in: packages/types/dist/block-kit/blocks.d.ts:70 A helper union type of all Block Elements that can be used in a [ContextActionsBlock](../interfaces/ContextActionsBlock.md). diff --git a/docs/english/reference/web-api/type-aliases/ContextBlockElement.md b/docs/english/reference/web-api/type-aliases/ContextBlockElement.md index 1e1abfadb..10d3bfcc5 100644 --- a/docs/english/reference/web-api/type-aliases/ContextBlockElement.md +++ b/docs/english/reference/web-api/type-aliases/ContextBlockElement.md @@ -6,7 +6,7 @@ type ContextBlockElement = ImageElement | TextObject; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:51 +Defined in: packages/types/dist/block-kit/blocks.d.ts:51 A helper union type of all Block Elements that can be used in a [ContextBlock](../interfaces/ContextBlock.md). diff --git a/docs/english/reference/web-api/type-aliases/ConversationFilter.md b/docs/english/reference/web-api/type-aliases/ConversationFilter.md index d6bbb36c2..650d8589d 100644 --- a/docs/english/reference/web-api/type-aliases/ConversationFilter.md +++ b/docs/english/reference/web-api/type-aliases/ConversationFilter.md @@ -9,7 +9,7 @@ type ConversationFilter = | BaseConversationFilter & Required>; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:183 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:197 ## Description diff --git a/docs/english/reference/web-api/type-aliases/ConversationType.md b/docs/english/reference/web-api/type-aliases/ConversationType.md index c0d3fc6d1..81a430a29 100644 --- a/docs/english/reference/web-api/type-aliases/ConversationType.md +++ b/docs/english/reference/web-api/type-aliases/ConversationType.md @@ -6,6 +6,6 @@ type ConversationType = "im" | "mpim" | "private" | "public"; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:7 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:7 The conversation type as available within the Slack UI. diff --git a/docs/english/reference/web-api/type-aliases/ImageBlock.md b/docs/english/reference/web-api/type-aliases/ImageBlock.md index cb8abb6b4..8ccf0a52e 100644 --- a/docs/english/reference/web-api/type-aliases/ImageBlock.md +++ b/docs/english/reference/web-api/type-aliases/ImageBlock.md @@ -8,7 +8,7 @@ type ImageBlock = object & Block & | SlackFileImageObject; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:136 +Defined in: packages/types/dist/block-kit/blocks.d.ts:137 ## Type Declaration diff --git a/docs/english/reference/web-api/type-aliases/ImageElement.md b/docs/english/reference/web-api/type-aliases/ImageElement.md index 564362ec0..fc6dcf165 100644 --- a/docs/english/reference/web-api/type-aliases/ImageElement.md +++ b/docs/english/reference/web-api/type-aliases/ImageElement.md @@ -8,7 +8,7 @@ type ImageElement = object & | SlackFileImageObject; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:219 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:223 ## Type Declaration diff --git a/docs/english/reference/web-api/type-aliases/InputBlockElement.md b/docs/english/reference/web-api/type-aliases/InputBlockElement.md index a0f06e508..8f81a6453 100644 --- a/docs/english/reference/web-api/type-aliases/InputBlockElement.md +++ b/docs/english/reference/web-api/type-aliases/InputBlockElement.md @@ -19,7 +19,7 @@ type InputBlockElement = | URLInput; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:156 +Defined in: packages/types/dist/block-kit/blocks.d.ts:157 A helper union type of all Block Elements that can be used in an [InputBlock](../interfaces/InputBlock.md). diff --git a/docs/english/reference/web-api/type-aliases/KnownBlock.md b/docs/english/reference/web-api/type-aliases/KnownBlock.md index c45e4024f..946e775ed 100644 --- a/docs/english/reference/web-api/type-aliases/KnownBlock.md +++ b/docs/english/reference/web-api/type-aliases/KnownBlock.md @@ -15,10 +15,13 @@ type KnownBlock = | MarkdownBlock | RichTextBlock | SectionBlock + | TableBlock + | TaskCardBlock + | PlanBlock | VideoBlock; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:21 +Defined in: packages/types/dist/block-kit/blocks.d.ts:21 A helper union type of all known Blocks, as listed out on the [Blocks reference](https://docs.slack.dev/reference/block-kit/blocks). diff --git a/docs/english/reference/web-api/type-aliases/MessageEvent.md b/docs/english/reference/web-api/type-aliases/MessageEvent.md index b80921548..b94400a1b 100644 --- a/docs/english/reference/web-api/type-aliases/MessageEvent.md +++ b/docs/english/reference/web-api/type-aliases/MessageEvent.md @@ -6,4 +6,4 @@ type MessageEvent = AllMessageEvents; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/message.d.ts:6 +Defined in: packages/types/dist/events/message.d.ts:6 diff --git a/docs/english/reference/web-api/type-aliases/Method.md b/docs/english/reference/web-api/type-aliases/Method.md index 2f34c1612..43b02ccf4 100644 --- a/docs/english/reference/web-api/type-aliases/Method.md +++ b/docs/english/reference/web-api/type-aliases/Method.md @@ -6,7 +6,7 @@ type Method = (options?) => Promise; ``` -Defined in: [packages/web-api/src/methods.ts:559](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L559) +Defined in: [packages/web-api/src/methods.ts:561](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L561) ## Type Parameters diff --git a/docs/english/reference/web-api/type-aliases/MultiSelect.md b/docs/english/reference/web-api/type-aliases/MultiSelect.md index 9481389f9..69cfe570c 100644 --- a/docs/english/reference/web-api/type-aliases/MultiSelect.md +++ b/docs/english/reference/web-api/type-aliases/MultiSelect.md @@ -11,7 +11,7 @@ type MultiSelect = | MultiExternalSelect; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:249 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:253 ## Description diff --git a/docs/english/reference/web-api/type-aliases/Option.md b/docs/english/reference/web-api/type-aliases/Option.md index 3a6ea20b1..313bca8e6 100644 --- a/docs/english/reference/web-api/type-aliases/Option.md +++ b/docs/english/reference/web-api/type-aliases/Option.md @@ -8,7 +8,7 @@ type Option = | PlainTextOption; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:99 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:99 ## Description diff --git a/docs/english/reference/web-api/type-aliases/RichTextBlockElement.md b/docs/english/reference/web-api/type-aliases/RichTextBlockElement.md index 2038ae51a..2ace9881e 100644 --- a/docs/english/reference/web-api/type-aliases/RichTextBlockElement.md +++ b/docs/english/reference/web-api/type-aliases/RichTextBlockElement.md @@ -10,7 +10,7 @@ type RichTextBlockElement = | RichTextPreformatted; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:213 +Defined in: packages/types/dist/block-kit/blocks.d.ts:214 A helper union type of all Block Elements that can be used in a [RichTextBlock](../interfaces/RichTextBlock.md). diff --git a/docs/english/reference/web-api/type-aliases/RichTextElement.md b/docs/english/reference/web-api/type-aliases/RichTextElement.md index 4307fc0b3..6d1a209a2 100644 --- a/docs/english/reference/web-api/type-aliases/RichTextElement.md +++ b/docs/english/reference/web-api/type-aliases/RichTextElement.md @@ -16,7 +16,7 @@ type RichTextElement = | RichTextUsergroupMention; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:855 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:877 ## Description diff --git a/docs/english/reference/web-api/type-aliases/SectionBlockAccessory.md b/docs/english/reference/web-api/type-aliases/SectionBlockAccessory.md index 20968594f..95f6b24c9 100644 --- a/docs/english/reference/web-api/type-aliases/SectionBlockAccessory.md +++ b/docs/english/reference/web-api/type-aliases/SectionBlockAccessory.md @@ -16,7 +16,7 @@ type SectionBlockAccessory = | WorkflowButton; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/blocks.d.ts:234 +Defined in: packages/types/dist/block-kit/blocks.d.ts:235 A helper union type of all Block Elements that can be used as an accessory in a [SectionBlock](../interfaces/SectionBlock.md). diff --git a/docs/english/reference/web-api/type-aliases/Select.md b/docs/english/reference/web-api/type-aliases/Select.md index f010bf290..a52abde36 100644 --- a/docs/english/reference/web-api/type-aliases/Select.md +++ b/docs/english/reference/web-api/type-aliases/Select.md @@ -11,7 +11,7 @@ type Select = | ExternalSelect; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/block-elements.d.ts:238 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:242 ## Description diff --git a/docs/english/reference/web-api/type-aliases/SharedChannelInviteAccepted.md b/docs/english/reference/web-api/type-aliases/SharedChannelInviteAccepted.md index fe6d20f11..13d54055a 100644 --- a/docs/english/reference/web-api/type-aliases/SharedChannelInviteAccepted.md +++ b/docs/english/reference/web-api/type-aliases/SharedChannelInviteAccepted.md @@ -6,7 +6,7 @@ type SharedChannelInviteAccepted = SharedChannelInviteAcceptedEvent; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:57 +Defined in: packages/types/dist/events/shared-channel.d.ts:57 ## Deprecated diff --git a/docs/english/reference/web-api/type-aliases/SharedChannelInviteApproved.md b/docs/english/reference/web-api/type-aliases/SharedChannelInviteApproved.md index 0e8edcfb0..25b4a03b7 100644 --- a/docs/english/reference/web-api/type-aliases/SharedChannelInviteApproved.md +++ b/docs/english/reference/web-api/type-aliases/SharedChannelInviteApproved.md @@ -6,7 +6,7 @@ type SharedChannelInviteApproved = SharedChannelInviteApprovedEvent; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:70 +Defined in: packages/types/dist/events/shared-channel.d.ts:70 ## Deprecated diff --git a/docs/english/reference/web-api/type-aliases/SharedChannelInviteDeclined.md b/docs/english/reference/web-api/type-aliases/SharedChannelInviteDeclined.md index 5f3ef5f02..9188fcfc4 100644 --- a/docs/english/reference/web-api/type-aliases/SharedChannelInviteDeclined.md +++ b/docs/english/reference/web-api/type-aliases/SharedChannelInviteDeclined.md @@ -6,7 +6,7 @@ type SharedChannelInviteDeclined = SharedChannelInviteDeclinedEvent; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:83 +Defined in: packages/types/dist/events/shared-channel.d.ts:83 ## Deprecated diff --git a/docs/english/reference/web-api/type-aliases/SharedChannelInviteReceived.md b/docs/english/reference/web-api/type-aliases/SharedChannelInviteReceived.md index 86928e2bb..960bcf52a 100644 --- a/docs/english/reference/web-api/type-aliases/SharedChannelInviteReceived.md +++ b/docs/english/reference/web-api/type-aliases/SharedChannelInviteReceived.md @@ -6,7 +6,7 @@ type SharedChannelInviteReceived = SharedChannelInviteReceivedEvent; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/shared-channel.d.ts:93 +Defined in: packages/types/dist/events/shared-channel.d.ts:93 ## Deprecated diff --git a/docs/english/reference/web-api/type-aliases/SlackEvent.md b/docs/english/reference/web-api/type-aliases/SlackEvent.md index d9bf521f8..5232c291a 100644 --- a/docs/english/reference/web-api/type-aliases/SlackEvent.md +++ b/docs/english/reference/web-api/type-aliases/SlackEvent.md @@ -29,6 +29,7 @@ type SlackEvent = | DNDUpdatedUserEvent | EmailDomainChangedEvent | EmojiChangedEvent + | EntityDetailsRequestedEvent | FileChangeEvent | FileCommentDeletedEvent | FileCreatedEvent @@ -90,7 +91,7 @@ type SlackEvent = | WorkflowStepExecuteEvent; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/index.d.ts:58 +Defined in: packages/types/dist/events/index.d.ts:59 All known event types in Slack's Events API Please refer to https://docs.slack.dev/reference/events for more details diff --git a/docs/english/reference/web-api/type-aliases/SlackFile.md b/docs/english/reference/web-api/type-aliases/SlackFile.md index 20a7662a8..7b53b3b4d 100644 --- a/docs/english/reference/web-api/type-aliases/SlackFile.md +++ b/docs/english/reference/web-api/type-aliases/SlackFile.md @@ -6,7 +6,7 @@ type SlackFile = SlackFileViaUrl | SlackFileViaId; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:221 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:235 ## Description diff --git a/docs/english/reference/web-api/type-aliases/SubteamCreated.md b/docs/english/reference/web-api/type-aliases/SubteamCreated.md index 045bdad33..77f47d455 100644 --- a/docs/english/reference/web-api/type-aliases/SubteamCreated.md +++ b/docs/english/reference/web-api/type-aliases/SubteamCreated.md @@ -6,7 +6,7 @@ type SubteamCreated = SubteamCreatedEvent; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:33 +Defined in: packages/types/dist/events/subteam.d.ts:33 ## Deprecated diff --git a/docs/english/reference/web-api/type-aliases/SubteamMembersChanged.md b/docs/english/reference/web-api/type-aliases/SubteamMembersChanged.md index 7e06075f4..8bf27b7ed 100644 --- a/docs/english/reference/web-api/type-aliases/SubteamMembersChanged.md +++ b/docs/english/reference/web-api/type-aliases/SubteamMembersChanged.md @@ -6,7 +6,7 @@ type SubteamMembersChanged = SubteamMembersChangedEvent; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/events/subteam.d.ts:49 +Defined in: packages/types/dist/events/subteam.d.ts:49 ## Deprecated diff --git a/docs/english/reference/web-api/type-aliases/TextObject.md b/docs/english/reference/web-api/type-aliases/TextObject.md index dc26b0cd5..e11f03418 100644 --- a/docs/english/reference/web-api/type-aliases/TextObject.md +++ b/docs/english/reference/web-api/type-aliases/TextObject.md @@ -8,7 +8,7 @@ type TextObject = | MrkdwnElement; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/block-kit/composition-objects.d.ts:120 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:120 ## Description diff --git a/docs/english/reference/web-api/type-aliases/View.md b/docs/english/reference/web-api/type-aliases/View.md index 67902d374..2e2a52c91 100644 --- a/docs/english/reference/web-api/type-aliases/View.md +++ b/docs/english/reference/web-api/type-aliases/View.md @@ -9,4 +9,4 @@ type View = | WorkflowStepView; ``` -Defined in: packages/web-api/node\_modules/@slack/types/dist/views.d.ts:69 +Defined in: packages/types/dist/views.d.ts:69 diff --git a/docs/english/reference/webhook/classes/IncomingWebhook.md b/docs/english/reference/webhook/classes/IncomingWebhook.md index 3a1a6b102..502b45229 100644 --- a/docs/english/reference/webhook/classes/IncomingWebhook.md +++ b/docs/english/reference/webhook/classes/IncomingWebhook.md @@ -11,7 +11,7 @@ A client for Slack's Incoming Webhooks ### Constructor ```ts -new IncomingWebhook(url, defaults): IncomingWebhook; +new IncomingWebhook(url, defaults?): IncomingWebhook; ``` Defined in: [packages/webhook/src/IncomingWebhook.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/IncomingWebhook.ts#L28) @@ -22,7 +22,7 @@ Defined in: [packages/webhook/src/IncomingWebhook.ts:28](https://github.com/slac `string` -##### defaults +##### defaults? [`IncomingWebhookDefaultArguments`](../interfaces/IncomingWebhookDefaultArguments.md) = `...` diff --git a/docs/english/reference/webhook/index.md b/docs/english/reference/webhook/index.md index 7db38d39d..373067588 100644 --- a/docs/english/reference/webhook/index.md +++ b/docs/english/reference/webhook/index.md @@ -1,4 +1,4 @@ -# @slack/webhook v7.0.6 +# @slack/webhook v7.0.8 ## Enumerations diff --git a/docs/english/reference/webhook/interfaces/CodedError.md b/docs/english/reference/webhook/interfaces/CodedError.md index e3502b711..cca1f83c0 100644 --- a/docs/english/reference/webhook/interfaces/CodedError.md +++ b/docs/english/reference/webhook/interfaces/CodedError.md @@ -39,7 +39,7 @@ NodeJS.ErrnoException.code optional errno: number; ``` -Defined in: packages/webhook/node\_modules/@types/node/globals.d.ts:196 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -87,7 +87,7 @@ NodeJS.ErrnoException.name optional path: string; ``` -Defined in: packages/webhook/node\_modules/@types/node/globals.d.ts:198 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -119,7 +119,7 @@ NodeJS.ErrnoException.stack optional syscall: string; ``` -Defined in: packages/webhook/node\_modules/@types/node/globals.d.ts:199 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/webhook/interfaces/IncomingWebhookHTTPError.md b/docs/english/reference/webhook/interfaces/IncomingWebhookHTTPError.md index 8ad710b57..e5517f2d3 100644 --- a/docs/english/reference/webhook/interfaces/IncomingWebhookHTTPError.md +++ b/docs/english/reference/webhook/interfaces/IncomingWebhookHTTPError.md @@ -32,7 +32,7 @@ Defined in: [packages/webhook/src/errors.ts:26](https://github.com/slackapi/node optional errno: number; ``` -Defined in: packages/webhook/node\_modules/@types/node/globals.d.ts:196 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -84,7 +84,7 @@ Defined in: [packages/webhook/src/errors.ts:27](https://github.com/slackapi/node optional path: string; ``` -Defined in: packages/webhook/node\_modules/@types/node/globals.d.ts:198 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -112,7 +112,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 optional syscall: string; ``` -Defined in: packages/webhook/node\_modules/@types/node/globals.d.ts:199 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/webhook/interfaces/IncomingWebhookRequestError.md b/docs/english/reference/webhook/interfaces/IncomingWebhookRequestError.md index 6db3707c6..6cf817c24 100644 --- a/docs/english/reference/webhook/interfaces/IncomingWebhookRequestError.md +++ b/docs/english/reference/webhook/interfaces/IncomingWebhookRequestError.md @@ -32,7 +32,7 @@ Defined in: [packages/webhook/src/errors.ts:21](https://github.com/slackapi/node optional errno: number; ``` -Defined in: packages/webhook/node\_modules/@types/node/globals.d.ts:196 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -84,7 +84,7 @@ Defined in: [packages/webhook/src/errors.ts:22](https://github.com/slackapi/node optional path: string; ``` -Defined in: packages/webhook/node\_modules/@types/node/globals.d.ts:198 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -112,7 +112,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 optional syscall: string; ``` -Defined in: packages/webhook/node\_modules/@types/node/globals.d.ts:199 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from From 86f937c8eb301cc331e2eac2b7c78c0216c46162 Mon Sep 17 00:00:00 2001 From: Eden Zimbelman Date: Thu, 12 Mar 2026 17:12:54 -0700 Subject: [PATCH 4/4] docs(maintainers): generate docs with releases --- .github/maintainers_guide.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/maintainers_guide.md b/.github/maintainers_guide.md index 400469624..c89be3480 100644 --- a/.github/maintainers_guide.md +++ b/.github/maintainers_guide.md @@ -11,6 +11,7 @@ Maintaining this project requires installing [Node.js](https://nodejs.org). All ### 🔧 Git hooks (optional) #### Pre-commit lint hook + We provide an opt-in Git hook that runs `npm run lint` from the repository root before a commit is created. Enable it once per clone: @@ -26,6 +27,7 @@ git config --unset core.hooksPath ``` Notes: + - The hook runs `npm run lint` from the repository root. - You can skip it with `git commit --no-verify` if needed. @@ -42,7 +44,6 @@ npm test --workspace packages/web-api This project has tests for individual packages as `*.test.ts` (or `*.test.js`) files inside of each package's `src` directory. Tests use `node:test` as the test runner and `node:assert/strict` for assertions. Also, for verifying the behavior with the real Slack server-side and developer experience with installed packages, you can run the tests and scripts under `prod-server-integration-tests`. Refer to the README file in the directory for details. These tests are supposed to be run in the project maintainers' manual execution. They are not part of CI builds for now. - Upon opening a PR, tests are executed by GitHub Actions, our continuous integration system. GitHub Actions runs several, more granular builds in order to report on success and failure in a more targeted way. - There is one build for each package on each supported version of Node, as well as one for the integration tests on each supported version of Node. @@ -115,7 +116,7 @@ New official package versions are published when the release PR created from cha 1. **Check GitHub Milestones**: Before merging the release PR please check the relevant [Milestones](https://github.com/slackapi/node-slack-sdk/milestones). If issues or pull requests are still open either decide to postpone the release or save those changes for a future update. -2. **Review the release PR**: Verify that version bumps match expectations, `CHANGELOG` entries are clear, and CI checks pass on the `main` branch. +2. **Review the release PR**: Verify that version bumps match expectations, `CHANGELOG` entries are clear, and CI checks pass on the `main` branch. Use `npm run docs` to generate documentation. 3. **Merge and approve**: Merge the release PR, then approve the [publish](https://github.com/slackapi/node-slack-sdk/actions/workflows/release.yml) workflow to release packages to npm.