From 42c1984227d6b9ebebddbe89c5b436ed56d59ead Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 10 Sep 2026 17:45:20 +0000 Subject: [PATCH] chore: release --- .changeset/add-container-block.md | 5 - .changeset/data-table-block.md | 5 - .changeset/table-raw-number-cell.md | 5 - .changeset/workflow-button-action-id.md | 5 - .../cli-test/classes/SlackCLIProcess.md | 3 +- .../oauth/classes/InstallProvider.md | 9 +- .../oauth/functions/defaultCallbackFailure.md | 3 +- .../oauth/functions/defaultCallbackSuccess.md | 3 +- .../reference/rtm-api/classes/RTMClient.md | 21 +- .../socket-mode/classes/SocketModeClient.md | 15 +- docs/english/reference/types/index.md | 5 +- .../reference/types/interfaces/Actionable.md | 1 + .../types/interfaces/ActionsBlock.md | 8 +- .../reference/types/interfaces/AlertBlock.md | 10 +- .../reference/types/interfaces/Block.md | 8 +- .../reference/types/interfaces/CardBlock.md | 18 +- .../types/interfaces/CarouselBlock.md | 8 +- .../types/interfaces/ContainerBlock.md | 197 ++++++++++++++++++ .../types/interfaces/ContextActionsBlock.md | 8 +- .../types/interfaces/ContextBlock.md | 8 +- .../types/interfaces/DataTableBlock.md | 116 +++++++++++ .../types/interfaces/DividerBlock.md | 6 +- .../reference/types/interfaces/FileBlock.md | 10 +- .../reference/types/interfaces/HeaderBlock.md | 8 +- .../reference/types/interfaces/InputBlock.md | 16 +- .../types/interfaces/MarkdownBlock.md | 8 +- .../reference/types/interfaces/PlanBlock.md | 10 +- .../types/interfaces/RawNumberElement.md | 51 +++++ .../types/interfaces/RawTextElement.md | 6 +- .../types/interfaces/RichTextBlock.md | 8 +- .../types/interfaces/SectionBlock.md | 14 +- .../types/interfaces/SlackFileImageObject.md | 4 +- .../reference/types/interfaces/TableBlock.md | 15 +- .../types/interfaces/TaskCardBlock.md | 18 +- .../types/interfaces/UrlImageObject.md | 4 +- .../reference/types/interfaces/VideoBlock.md | 24 +-- .../types/interfaces/WorkflowButton.md | 24 ++- .../types/type-aliases/ActionsBlockElement.md | 2 +- .../reference/types/type-aliases/AnyBlock.md | 2 +- .../ContextActionsBlockElement.md | 2 +- .../types/type-aliases/ContextBlockElement.md | 2 +- .../types/type-aliases/ConversationFilter.md | 2 +- .../types/type-aliases/ImageBlock.md | 2 +- .../types/type-aliases/InputBlockElement.md | 2 +- .../types/type-aliases/KnownBlock.md | 4 +- .../type-aliases/RichTextBlockElement.md | 2 +- .../type-aliases/SectionBlockAccessory.md | 2 +- .../reference/types/type-aliases/SlackFile.md | 2 +- .../reference/web-api/classes/ChatStreamer.md | 3 +- .../reference/web-api/classes/Methods.md | 15 +- .../web-api/classes/WebAPIHTTPError.md | 3 +- .../reference/web-api/classes/WebClient.md | 21 +- docs/english/reference/web-api/index.md | 3 + .../web-api/interfaces/Actionable.md | 1 + .../reference/web-api/interfaces/Block.md | 2 + .../web-api/interfaces/ContainerBlock.md | 197 ++++++++++++++++++ .../web-api/interfaces/ContextActionsBlock.md | 6 +- .../web-api/interfaces/ContextBlock.md | 6 +- .../web-api/interfaces/DataTableBlock.md | 116 +++++++++++ .../web-api/interfaces/DividerBlock.md | 4 +- .../reference/web-api/interfaces/FileBlock.md | 8 +- .../web-api/interfaces/HeaderBlock.md | 6 +- .../web-api/interfaces/InputBlock.md | 14 +- .../web-api/interfaces/MarkdownBlock.md | 6 +- .../reference/web-api/interfaces/PlanBlock.md | 8 +- .../web-api/interfaces/RawNumberElement.md | 51 +++++ .../web-api/interfaces/RawTextElement.md | 6 +- .../web-api/interfaces/RichTextBlock.md | 6 +- .../web-api/interfaces/SectionBlock.md | 12 +- .../interfaces/SlackFileImageObject.md | 4 +- .../web-api/interfaces/TableBlock.md | 13 +- .../web-api/interfaces/TaskCardBlock.md | 16 +- .../web-api/interfaces/UrlImageObject.md | 4 +- .../web-api/interfaces/VideoBlock.md | 22 +- .../web-api/interfaces/WorkflowButton.md | 24 ++- .../ContextActionsBlockElement.md | 2 +- .../type-aliases/ContextBlockElement.md | 2 +- .../type-aliases/ConversationFilter.md | 2 +- .../web-api/type-aliases/ImageBlock.md | 2 +- .../web-api/type-aliases/InputBlockElement.md | 2 +- .../web-api/type-aliases/KnownBlock.md | 2 + .../type-aliases/RichTextBlockElement.md | 2 +- .../type-aliases/SectionBlockAccessory.md | 2 +- .../web-api/type-aliases/SlackFile.md | 2 +- .../classes/IncomingWebhookHTTPError.md | 3 +- .../classes/WebhookTriggerHTTPError.md | 3 +- package-lock.json | 2 +- packages/types/CHANGELOG.md | 9 + packages/types/package.json | 2 +- 89 files changed, 1069 insertions(+), 256 deletions(-) delete mode 100644 .changeset/add-container-block.md delete mode 100644 .changeset/data-table-block.md delete mode 100644 .changeset/table-raw-number-cell.md delete mode 100644 .changeset/workflow-button-action-id.md create mode 100644 docs/english/reference/types/interfaces/ContainerBlock.md create mode 100644 docs/english/reference/types/interfaces/DataTableBlock.md create mode 100644 docs/english/reference/types/interfaces/RawNumberElement.md create mode 100644 docs/english/reference/web-api/interfaces/ContainerBlock.md create mode 100644 docs/english/reference/web-api/interfaces/DataTableBlock.md create mode 100644 docs/english/reference/web-api/interfaces/RawNumberElement.md diff --git a/.changeset/add-container-block.md b/.changeset/add-container-block.md deleted file mode 100644 index dbe4fa95a..000000000 --- a/.changeset/add-container-block.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/types": minor ---- - -feat(types): add [`ContainerBlock`](https://docs.slack.dev/reference/block-kit/blocks/container-block/) block interface diff --git a/.changeset/data-table-block.md b/.changeset/data-table-block.md deleted file mode 100644 index 7b6f6b733..000000000 --- a/.changeset/data-table-block.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/types": minor ---- - -feat: add the [`data_table`](https://docs.slack.dev/reference/block-kit/blocks/data-table-block) Block Kit block type (`DataTableBlock`) diff --git a/.changeset/table-raw-number-cell.md b/.changeset/table-raw-number-cell.md deleted file mode 100644 index e59e3d0fe..000000000 --- a/.changeset/table-raw-number-cell.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/types": minor ---- - -feat: allow `raw_number` cells in [`TableBlock`](https://docs.slack.dev/reference/block-kit/blocks/table-block) rows (adds `RawNumberElement`) diff --git a/.changeset/workflow-button-action-id.md b/.changeset/workflow-button-action-id.md deleted file mode 100644 index c753db68b..000000000 --- a/.changeset/workflow-button-action-id.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/types": minor ---- - -feat(types): add optional `action_id` property to the [`WorkflowButton`](https://docs.slack.dev/reference/block-kit/block-elements/workflow-button-element) block element diff --git a/docs/english/reference/cli-test/classes/SlackCLIProcess.md b/docs/english/reference/cli-test/classes/SlackCLIProcess.md index efdf55a97..416ed5958 100644 --- a/docs/english/reference/cli-test/classes/SlackCLIProcess.md +++ b/docs/english/reference/cli-test/classes/SlackCLIProcess.md @@ -12,7 +12,8 @@ Defined in: [cli/cli-process.ts:49](https://github.com/slackapi/node-slack-sdk/b new SlackCLIProcess( command, globalOptions?, - commandOptions?): SlackCLIProcess; + commandOptions? +): SlackCLIProcess; ``` Defined in: [cli/cli-process.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/cli-test/src/cli/cli-process.ts#L65) diff --git a/docs/english/reference/oauth/classes/InstallProvider.md b/docs/english/reference/oauth/classes/InstallProvider.md index 583056083..41364c0a9 100644 --- a/docs/english/reference/oauth/classes/InstallProvider.md +++ b/docs/english/reference/oauth/classes/InstallProvider.md @@ -76,7 +76,8 @@ Fetches data from the installationStore generateInstallUrl( options, stateVerification?, -state?): Promise; + state? +): Promise; ``` Defined in: [packages/oauth/src/install-provider.ts:415](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L415) @@ -111,7 +112,8 @@ handleCallback( req, res, options?, -installOptions?): Promise; + installOptions? +): Promise; ``` Defined in: [packages/oauth/src/install-provider.ts:485](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L485) @@ -155,7 +157,8 @@ handleInstallPath( req, res, options?, -installOptions?): Promise; + installOptions? +): Promise; ``` Defined in: [packages/oauth/src/install-provider.ts:330](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider.ts#L330) diff --git a/docs/english/reference/oauth/functions/defaultCallbackFailure.md b/docs/english/reference/oauth/functions/defaultCallbackFailure.md index 43d7708a5..f53a782f4 100644 --- a/docs/english/reference/oauth/functions/defaultCallbackFailure.md +++ b/docs/english/reference/oauth/functions/defaultCallbackFailure.md @@ -7,7 +7,8 @@ function defaultCallbackFailure( error, _options, _req, - res): void; + res +): void; ``` Defined in: [packages/oauth/src/callback-options.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L126) diff --git a/docs/english/reference/oauth/functions/defaultCallbackSuccess.md b/docs/english/reference/oauth/functions/defaultCallbackSuccess.md index 9f0de9c58..09316f7e0 100644 --- a/docs/english/reference/oauth/functions/defaultCallbackSuccess.md +++ b/docs/english/reference/oauth/functions/defaultCallbackSuccess.md @@ -7,7 +7,8 @@ function defaultCallbackSuccess( installation, _options, _req, - res): void; + res +): void; ``` Defined in: [packages/oauth/src/callback-options.ts:81](https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/callback-options.ts#L81) diff --git a/docs/english/reference/rtm-api/classes/RTMClient.md b/docs/english/reference/rtm-api/classes/RTMClient.md index 343445bb2..bdea26ba6 100644 --- a/docs/english/reference/rtm-api/classes/RTMClient.md +++ b/docs/english/reference/rtm-api/classes/RTMClient.md @@ -115,7 +115,8 @@ EventEmitter.prefixed addListener( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:45 @@ -160,7 +161,8 @@ EventEmitter.addListener addOutgoingEvent( awaitReply, type, -body?): Promise; + body? +): Promise; ``` Defined in: [packages/rtm-api/src/RTMClient.ts:525](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L525) @@ -208,7 +210,8 @@ the message body addOutgoingEvent( awaitReply, type, -body?): Promise; + body? +): Promise; ``` Defined in: [packages/rtm-api/src/RTMClient.ts:526](https://github.com/slackapi/node-slack-sdk/blob/main/packages/rtm-api/src/RTMClient.ts#L526) @@ -399,7 +402,8 @@ off( event, fn?, context?, - once?): this; + once? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:69 @@ -446,7 +450,8 @@ EventEmitter.off on( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:40 @@ -491,7 +496,8 @@ EventEmitter.on once( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:54 @@ -565,7 +571,8 @@ removeListener( event, fn?, context?, - once?): this; + once? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:63 diff --git a/docs/english/reference/socket-mode/classes/SocketModeClient.md b/docs/english/reference/socket-mode/classes/SocketModeClient.md index 8fc3d7c4b..fa35fbec1 100644 --- a/docs/english/reference/socket-mode/classes/SocketModeClient.md +++ b/docs/english/reference/socket-mode/classes/SocketModeClient.md @@ -73,7 +73,8 @@ EventEmitter.prefixed addListener( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:45 @@ -257,7 +258,8 @@ off( event, fn?, context?, - once?): this; + once? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:69 @@ -304,7 +306,8 @@ EventEmitter.off on( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:40 @@ -349,7 +352,8 @@ EventEmitter.on once( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:54 @@ -423,7 +427,8 @@ removeListener( event, fn?, context?, - once?): this; + once? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:63 diff --git a/docs/english/reference/types/index.md b/docs/english/reference/types/index.md index 32fcaa473..aeddb754a 100644 --- a/docs/english/reference/types/index.md +++ b/docs/english/reference/types/index.md @@ -1,4 +1,4 @@ -# @slack/types v3.1.0 +# @slack/types v3.2.0 ## Enumerations @@ -58,10 +58,12 @@ - [Confirmable](interfaces/Confirmable.md) - [Confirmation](interfaces/Confirmation.md) - [ConfirmationDialog](interfaces/ConfirmationDialog.md) +- [ContainerBlock](interfaces/ContainerBlock.md) - [ContentItemEntityFields](interfaces/ContentItemEntityFields.md) - [ContextActionsBlock](interfaces/ContextActionsBlock.md) - [ContextBlock](interfaces/ContextBlock.md) - [ConversationsSelect](interfaces/ConversationsSelect.md) +- [DataTableBlock](interfaces/DataTableBlock.md) - [Datepicker](interfaces/Datepicker.md) - [DateTimepicker](interfaces/DateTimepicker.md) - [~~Dialog~~](interfaces/Dialog.md) @@ -167,6 +169,7 @@ - [PlanBlock](interfaces/PlanBlock.md) - [PlanUpdateChunk](interfaces/PlanUpdateChunk.md) - [RadioButtons](interfaces/RadioButtons.md) +- [RawNumberElement](interfaces/RawNumberElement.md) - [RawTextElement](interfaces/RawTextElement.md) - [ReactionAddedEvent](interfaces/ReactionAddedEvent.md) - [ReactionRemovedEvent](interfaces/ReactionRemovedEvent.md) diff --git a/docs/english/reference/types/interfaces/Actionable.md b/docs/english/reference/types/interfaces/Actionable.md index 8a1cebde7..77cb1c777 100644 --- a/docs/english/reference/types/interfaces/Actionable.md +++ b/docs/english/reference/types/interfaces/Actionable.md @@ -38,6 +38,7 @@ Defined in: [block-kit/extensions.ts:18](https://github.com/slackapi/node-slack- - [`RadioButtons`](RadioButtons.md) - [`Timepicker`](Timepicker.md) - [`URLInput`](URLInput.md) +- [`WorkflowButton`](WorkflowButton.md) - [`RichTextInput`](RichTextInput.md) ## Properties diff --git a/docs/english/reference/types/interfaces/ActionsBlock.md b/docs/english/reference/types/interfaces/ActionsBlock.md index c4a683eb1..b9fde21eb 100644 --- a/docs/english/reference/types/interfaces/ActionsBlock.md +++ b/docs/english/reference/types/interfaces/ActionsBlock.md @@ -2,7 +2,7 @@ # Interface: ActionsBlock -Defined in: [block-kit/blocks.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L103) +Defined in: [block-kit/blocks.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L106) ## Description @@ -24,7 +24,7 @@ Holds multiple interactive elements. optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. elements: ActionsBlockElement[]; ``` -Defined in: [block-kit/blocks.ts:112](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L112) +Defined in: [block-kit/blocks.ts:115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L115) #### Description @@ -61,7 +61,7 @@ There is a maximum of 25 elements in each action block. type: "actions"; ``` -Defined in: [block-kit/blocks.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L107) +Defined in: [block-kit/blocks.ts:110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L110) #### Description diff --git a/docs/english/reference/types/interfaces/AlertBlock.md b/docs/english/reference/types/interfaces/AlertBlock.md index d8b4b13c8..3e20d316a 100644 --- a/docs/english/reference/types/interfaces/AlertBlock.md +++ b/docs/english/reference/types/interfaces/AlertBlock.md @@ -2,7 +2,7 @@ # Interface: AlertBlock -Defined in: [block-kit/blocks.ts:119](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L119) +Defined in: [block-kit/blocks.ts:122](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L122) ## Description @@ -24,7 +24,7 @@ Displays alerts, warnings, and informational messages. optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. optional level?: "default" | "info" | "warning" | "error" | "success"; ``` -Defined in: [block-kit/blocks.ts:131](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L131) +Defined in: [block-kit/blocks.ts:134](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L134) #### Description @@ -60,7 +60,7 @@ The severity level of the alert. Defaults to `"default"` if omitted. text: TextObject; ``` -Defined in: [block-kit/blocks.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L127) +Defined in: [block-kit/blocks.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L130) #### Description @@ -74,7 +74,7 @@ The alert message content in the form of a [TextObject](../type-aliases/TextObje type: "alert"; ``` -Defined in: [block-kit/blocks.ts:123](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L123) +Defined in: [block-kit/blocks.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L126) #### Description diff --git a/docs/english/reference/types/interfaces/Block.md b/docs/english/reference/types/interfaces/Block.md index b8ca6d98c..d65d41765 100644 --- a/docs/english/reference/types/interfaces/Block.md +++ b/docs/english/reference/types/interfaces/Block.md @@ -2,7 +2,7 @@ # Interface: Block -Defined in: [block-kit/blocks.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L37) +Defined in: [block-kit/blocks.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L38) ## Extended by @@ -10,8 +10,10 @@ Defined in: [block-kit/blocks.ts:37](https://github.com/slackapi/node-slack-sdk/ - [`AlertBlock`](AlertBlock.md) - [`CardBlock`](CardBlock.md) - [`CarouselBlock`](CarouselBlock.md) +- [`ContainerBlock`](ContainerBlock.md) - [`ContextBlock`](ContextBlock.md) - [`ContextActionsBlock`](ContextActionsBlock.md) +- [`DataTableBlock`](DataTableBlock.md) - [`DividerBlock`](DividerBlock.md) - [`FileBlock`](FileBlock.md) - [`HeaderBlock`](HeaderBlock.md) @@ -32,7 +34,7 @@ Defined in: [block-kit/blocks.ts:37](https://github.com/slackapi/node-slack-sdk/ optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -50,7 +52,7 @@ a message. If a message is updated, use a new `block_id`. type: string; ``` -Defined in: [block-kit/blocks.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L41) +Defined in: [block-kit/blocks.ts:42](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L42) #### Description diff --git a/docs/english/reference/types/interfaces/CardBlock.md b/docs/english/reference/types/interfaces/CardBlock.md index 1c4c9d5df..c2f465086 100644 --- a/docs/english/reference/types/interfaces/CardBlock.md +++ b/docs/english/reference/types/interfaces/CardBlock.md @@ -2,7 +2,7 @@ # Interface: CardBlock -Defined in: [block-kit/blocks.ts:138](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L138) +Defined in: [block-kit/blocks.ts:141](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L141) ## Description @@ -24,7 +24,7 @@ Displays content in a card. At least one of `hero_image`, `title`, `actions`, or optional actions?: Button[]; ``` -Defined in: [block-kit/blocks.ts:169](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L169) +Defined in: [block-kit/blocks.ts:172](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L172) #### Description @@ -38,7 +38,7 @@ An array of [Button](Button.md) elements displayed at the bottom of the card. optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -60,7 +60,7 @@ a message. If a message is updated, use a new `block_id`. optional body?: MrkdwnElement; ``` -Defined in: [block-kit/blocks.ts:165](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L165) +Defined in: [block-kit/blocks.ts:168](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L168) #### Description @@ -75,7 +75,7 @@ Maximum length for the text in this field is 200 characters. optional hero_image?: ImageElement; ``` -Defined in: [block-kit/blocks.ts:146](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L146) +Defined in: [block-kit/blocks.ts:149](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L149) #### Description @@ -89,7 +89,7 @@ A top banner image for the card in the form of an [ImageElement](../type-aliases optional icon?: ImageElement; ``` -Defined in: [block-kit/blocks.ts:150](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L150) +Defined in: [block-kit/blocks.ts:153](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L153) #### Description @@ -103,7 +103,7 @@ A small icon displayed next to the title and subtitle in the form of an [ImageEl optional subtitle?: MrkdwnElement; ``` -Defined in: [block-kit/blocks.ts:160](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L160) +Defined in: [block-kit/blocks.ts:163](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L163) #### Description @@ -118,7 +118,7 @@ Maximum length for the text in this field is 150 characters. optional title?: MrkdwnElement; ``` -Defined in: [block-kit/blocks.ts:155](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L155) +Defined in: [block-kit/blocks.ts:158](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L158) #### Description @@ -133,7 +133,7 @@ Maximum length for the text in this field is 150 characters. type: "card"; ``` -Defined in: [block-kit/blocks.ts:142](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L142) +Defined in: [block-kit/blocks.ts:145](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L145) #### Description diff --git a/docs/english/reference/types/interfaces/CarouselBlock.md b/docs/english/reference/types/interfaces/CarouselBlock.md index b81396d6e..76e6202a8 100644 --- a/docs/english/reference/types/interfaces/CarouselBlock.md +++ b/docs/english/reference/types/interfaces/CarouselBlock.md @@ -2,7 +2,7 @@ # Interface: CarouselBlock -Defined in: [block-kit/blocks.ts:176](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L176) +Defined in: [block-kit/blocks.ts:179](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L179) ## Description @@ -24,7 +24,7 @@ Displays related card blocks in a horizontally-scrolling container. optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. elements: CardBlock[]; ``` -Defined in: [block-kit/blocks.ts:184](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L184) +Defined in: [block-kit/blocks.ts:187](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L187) #### Description @@ -60,7 +60,7 @@ An array of [CardBlock](CardBlock.md) elements. Minimum 1, maximum 10 cards. type: "carousel"; ``` -Defined in: [block-kit/blocks.ts:180](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L180) +Defined in: [block-kit/blocks.ts:183](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L183) #### Description diff --git a/docs/english/reference/types/interfaces/ContainerBlock.md b/docs/english/reference/types/interfaces/ContainerBlock.md new file mode 100644 index 000000000..086cddd95 --- /dev/null +++ b/docs/english/reference/types/interfaces/ContainerBlock.md @@ -0,0 +1,197 @@ +[@slack/types](../index.md) / ContainerBlock + +# Interface: ContainerBlock + +Defined in: [block-kit/blocks.ts:194](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L194) + +## Description + +A general-purpose wrapper for grouping child blocks together, with a configurable size. + +## See + +[Container block reference](https://docs.slack.dev/reference/block-kit/blocks/container-block). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id?: string; +``` + +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) + +#### 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) + +*** + +### child\_blocks + +```ts +child_blocks: ( + | RichTextBlock + | ActionsBlock + | ContextBlock + | DividerBlock + | FileBlock + | HeaderBlock + | ImageBlock + | InputBlock + | SectionBlock + | TableBlock + | VideoBlock)[]; +``` + +Defined in: [block-kit/blocks.ts:216](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L216) + +#### Description + +An array of child blocks. Maximum 10 blocks. + +*** + +### default\_collapsed? + +```ts +optional default_collapsed?: boolean; +``` + +Defined in: [block-kit/blocks.ts:244](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L244) + +#### Description + +Whether the container is collapsed by default. Requires `is_collapsible` to be `true`. Defaults to `false`. + +*** + +### has\_header\_divider? + +```ts +optional has_header_divider?: boolean; +``` + +Defined in: [block-kit/blocks.ts:249](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L249) + +#### Description + +Whether to show a visible border separating header from content. +Only applies when `is_collapsible` is not `true`. Defaults to `false`. + +*** + +### icon? + +```ts +optional icon?: ImageElement; +``` + +Defined in: [block-kit/blocks.ts:236](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L236) + +#### Description + +An image element displayed alongside the title and subtitle. + +*** + +### is\_collapsible? + +```ts +optional is_collapsible?: boolean; +``` + +Defined in: [block-kit/blocks.ts:240](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L240) + +#### Description + +Whether the container can be collapsed. Defaults to `false`. + +*** + +### rich\_text\_title? + +```ts +optional rich_text_title?: RichTextBlock; +``` + +Defined in: [block-kit/blocks.ts:208](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L208) + +#### Description + +Rich text title for the container. Takes precedence over `title` if both are provided. +One of `title` or `rich_text_title` is required. + +*** + +### subtitle? + +```ts +optional subtitle?: TextObject; +``` + +Defined in: [block-kit/blocks.ts:212](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L212) + +#### Description + +Subtitle for the container in plain text or mrkdwn format. Maximum length is 150 characters. + +*** + +### title? + +```ts +optional title?: PlainTextElement; +``` + +Defined in: [block-kit/blocks.ts:203](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L203) + +#### Description + +Plain text title for the container. Maximum length is 150 characters. +One of `title` or `rich_text_title` is required. + +*** + +### type + +```ts +type: "container"; +``` + +Defined in: [block-kit/blocks.ts:198](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L198) + +#### Description + +The type of block. For a container block, `type` is always `container`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +*** + +### width? + +```ts +optional width?: "narrow" | "standard" | "wide" | "full"; +``` + +Defined in: [block-kit/blocks.ts:232](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L232) + +#### Description + +Controls the width of the container. Defaults to `"standard"`. diff --git a/docs/english/reference/types/interfaces/ContextActionsBlock.md b/docs/english/reference/types/interfaces/ContextActionsBlock.md index a952f4230..4125cc454 100644 --- a/docs/english/reference/types/interfaces/ContextActionsBlock.md +++ b/docs/english/reference/types/interfaces/ContextActionsBlock.md @@ -2,7 +2,7 @@ # Interface: ContextActionsBlock -Defined in: [block-kit/blocks.ts:218](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L218) +Defined in: [block-kit/blocks.ts:283](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L283) ## Description @@ -24,7 +24,7 @@ Displays actions as contextual info, which can include both feedback buttons and optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. elements: ContextActionsBlockElement[]; ``` -Defined in: [block-kit/blocks.ts:226](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L226) +Defined in: [block-kit/blocks.ts:291](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L291) #### Description @@ -60,7 +60,7 @@ An array of [FeedbackButtons](FeedbackButtons.md) or [IconButton](IconButton.md) type: "context_actions"; ``` -Defined in: [block-kit/blocks.ts:222](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L222) +Defined in: [block-kit/blocks.ts:287](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L287) #### Description diff --git a/docs/english/reference/types/interfaces/ContextBlock.md b/docs/english/reference/types/interfaces/ContextBlock.md index 841a897a4..4150ec0e2 100644 --- a/docs/english/reference/types/interfaces/ContextBlock.md +++ b/docs/english/reference/types/interfaces/ContextBlock.md @@ -2,7 +2,7 @@ # Interface: ContextBlock -Defined in: [block-kit/blocks.ts:197](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L197) +Defined in: [block-kit/blocks.ts:262](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L262) ## Description @@ -24,7 +24,7 @@ Displays contextual info, which can include both images and text. optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. elements: ContextBlockElement[]; ``` -Defined in: [block-kit/blocks.ts:206](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L206) +Defined in: [block-kit/blocks.ts:271](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L271) #### Description @@ -61,7 +61,7 @@ Maximum number of items is 10. type: "context"; ``` -Defined in: [block-kit/blocks.ts:201](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L201) +Defined in: [block-kit/blocks.ts:266](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L266) #### Description diff --git a/docs/english/reference/types/interfaces/DataTableBlock.md b/docs/english/reference/types/interfaces/DataTableBlock.md new file mode 100644 index 000000000..de434e426 --- /dev/null +++ b/docs/english/reference/types/interfaces/DataTableBlock.md @@ -0,0 +1,116 @@ +[@slack/types](../index.md) / DataTableBlock + +# Interface: DataTableBlock + +Defined in: [block-kit/blocks.ts:298](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L298) + +## Description + +Displays rich tables that support pagination, sorting, filtering, and interactivity. + +## See + +[Data table block reference](https://docs.slack.dev/reference/block-kit/blocks/data-table-block). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### block\_id? + +```ts +optional block_id?: string; +``` + +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) + +#### 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) + +*** + +### caption + +```ts +caption: string; +``` + +Defined in: [block-kit/blocks.ts:310](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L310) + +#### Description + +A caption for the table; used as the value for the HTML caption element. + +*** + +### page\_size? + +```ts +optional page_size?: number; +``` + +Defined in: [block-kit/blocks.ts:314](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L314) + +#### Description + +Number of rows per page. Min `1`, Max `100`. Defaults to `5` if omitted. + +*** + +### row\_header\_column\_index? + +```ts +optional row_header_column_index?: number; +``` + +Defined in: [block-kit/blocks.ts:318](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L318) + +#### Description + +The 0-based index of the column that uniquely identifies each row (the row header). This column is treated as the row's primary identifier for screen readers. Defaults to `0` if omitted. + +*** + +### rows + +```ts +rows: ( + | RichTextBlock + | RawTextElement + | RawNumberElement)[][]; +``` + +Defined in: [block-kit/blocks.ts:306](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L306) + +#### Description + +An array consisting of table rows. + +*** + +### type + +```ts +type: "data_table"; +``` + +Defined in: [block-kit/blocks.ts:302](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L302) + +#### Description + +The type of block. For a data table block, `type` is always `data_table`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) diff --git a/docs/english/reference/types/interfaces/DividerBlock.md b/docs/english/reference/types/interfaces/DividerBlock.md index a46eb0d35..52b202e23 100644 --- a/docs/english/reference/types/interfaces/DividerBlock.md +++ b/docs/english/reference/types/interfaces/DividerBlock.md @@ -2,7 +2,7 @@ # Interface: DividerBlock -Defined in: [block-kit/blocks.ts:234](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L234) +Defined in: [block-kit/blocks.ts:326](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L326) ## 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: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -47,7 +47,7 @@ a message. If a message is updated, use a new `block_id`. type: "divider"; ``` -Defined in: [block-kit/blocks.ts:238](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L238) +Defined in: [block-kit/blocks.ts:330](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L330) #### Description diff --git a/docs/english/reference/types/interfaces/FileBlock.md b/docs/english/reference/types/interfaces/FileBlock.md index 3ff7f9d28..064683cc5 100644 --- a/docs/english/reference/types/interfaces/FileBlock.md +++ b/docs/english/reference/types/interfaces/FileBlock.md @@ -2,7 +2,7 @@ # Interface: FileBlock -Defined in: [block-kit/blocks.ts:248](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L248) +Defined in: [block-kit/blocks.ts:340](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L340) ## Description @@ -27,7 +27,7 @@ that contain remote files. If you want to add remote files to messages, optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -49,7 +49,7 @@ a message. If a message is updated, use a new `block_id`. external_id: string; ``` -Defined in: [block-kit/blocks.ts:260](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L260) +Defined in: [block-kit/blocks.ts:352](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L352) #### Description @@ -63,7 +63,7 @@ The external unique ID for this file. source: string; ``` -Defined in: [block-kit/blocks.ts:256](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L256) +Defined in: [block-kit/blocks.ts:348](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L348) #### Description @@ -77,7 +77,7 @@ At the moment, source will always be `remote` for a remote file. type: "file"; ``` -Defined in: [block-kit/blocks.ts:252](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L252) +Defined in: [block-kit/blocks.ts:344](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L344) #### Description diff --git a/docs/english/reference/types/interfaces/HeaderBlock.md b/docs/english/reference/types/interfaces/HeaderBlock.md index 75a60db30..43f2ad950 100644 --- a/docs/english/reference/types/interfaces/HeaderBlock.md +++ b/docs/english/reference/types/interfaces/HeaderBlock.md @@ -2,7 +2,7 @@ # Interface: HeaderBlock -Defined in: [block-kit/blocks.ts:268](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L268) +Defined in: [block-kit/blocks.ts:360](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L360) ## 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: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -47,7 +47,7 @@ a message. If a message is updated, use a new `block_id`. text: PlainTextElement; ``` -Defined in: [block-kit/blocks.ts:277](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L277) +Defined in: [block-kit/blocks.ts:369](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L369) #### Description @@ -62,7 +62,7 @@ Maximum length for the text in this field is 150 characters. type: "header"; ``` -Defined in: [block-kit/blocks.ts:272](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L272) +Defined in: [block-kit/blocks.ts:364](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L364) #### Description diff --git a/docs/english/reference/types/interfaces/InputBlock.md b/docs/english/reference/types/interfaces/InputBlock.md index a49f5a0a7..e94df6b66 100644 --- a/docs/english/reference/types/interfaces/InputBlock.md +++ b/docs/english/reference/types/interfaces/InputBlock.md @@ -2,7 +2,7 @@ # Interface: InputBlock -Defined in: [block-kit/blocks.ts:327](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L327) +Defined in: [block-kit/blocks.ts:419](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L419) ## Description @@ -26,7 +26,7 @@ Collects information from users via block elements. optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -48,7 +48,7 @@ a message. If a message is updated, use a new `block_id`. optional dispatch_action?: boolean; ``` -Defined in: [block-kit/blocks.ts:355](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L355) +Defined in: [block-kit/blocks.ts:447](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L447) #### Description @@ -63,7 +63,7 @@ A boolean that indicates whether or not the use of elements in this block should element: InputBlockElement; ``` -Defined in: [block-kit/blocks.ts:350](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L350) +Defined in: [block-kit/blocks.ts:442](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L442) #### Description @@ -77,7 +77,7 @@ A block element. optional hint?: PlainTextElement; ``` -Defined in: [block-kit/blocks.ts:341](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L341) +Defined in: [block-kit/blocks.ts:433](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L433) #### Description @@ -92,7 +92,7 @@ An optional hint that appears below an input element in a lighter grey. It must label: PlainTextElement; ``` -Defined in: [block-kit/blocks.ts:336](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L336) +Defined in: [block-kit/blocks.ts:428](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L428) #### Description @@ -107,7 +107,7 @@ Maximum length for the text in this field is 2000 characters. optional optional?: boolean; ``` -Defined in: [block-kit/blocks.ts:346](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L346) +Defined in: [block-kit/blocks.ts:438](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L438) #### Description @@ -122,7 +122,7 @@ Defaults to `false`. type: "input"; ``` -Defined in: [block-kit/blocks.ts:331](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L331) +Defined in: [block-kit/blocks.ts:423](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L423) #### Description diff --git a/docs/english/reference/types/interfaces/MarkdownBlock.md b/docs/english/reference/types/interfaces/MarkdownBlock.md index 8b1a51df6..5f7ab3ab8 100644 --- a/docs/english/reference/types/interfaces/MarkdownBlock.md +++ b/docs/english/reference/types/interfaces/MarkdownBlock.md @@ -2,7 +2,7 @@ # Interface: MarkdownBlock -Defined in: [block-kit/blocks.ts:364](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L364) +Defined in: [block-kit/blocks.ts:456](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L456) ## 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: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -48,7 +48,7 @@ a message. If a message is updated, use a new `block_id`. text: string; ``` -Defined in: [block-kit/blocks.ts:372](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L372) +Defined in: [block-kit/blocks.ts:464](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L464) #### Description @@ -62,7 +62,7 @@ The standard markdown-formatted text. Limit 12,000 characters max. type: "markdown"; ``` -Defined in: [block-kit/blocks.ts:368](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L368) +Defined in: [block-kit/blocks.ts:460](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L460) #### Description diff --git a/docs/english/reference/types/interfaces/PlanBlock.md b/docs/english/reference/types/interfaces/PlanBlock.md index 8cb1dbc2c..040ec2078 100644 --- a/docs/english/reference/types/interfaces/PlanBlock.md +++ b/docs/english/reference/types/interfaces/PlanBlock.md @@ -2,7 +2,7 @@ # Interface: PlanBlock -Defined in: [block-kit/blocks.ts:529](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L529) +Defined in: [block-kit/blocks.ts:621](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L621) ## Description @@ -24,7 +24,7 @@ https://docs.slack.dev/reference/block-kit/blocks/plan-block/ optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. optional tasks?: (TaskCardBlock | Record)[]; ``` -Defined in: [block-kit/blocks.ts:543](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L543) +Defined in: [block-kit/blocks.ts:635](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L635) #### Description @@ -60,7 +60,7 @@ A sequence of task card blocks. Each task represents a single action within the title: string; ``` -Defined in: [block-kit/blocks.ts:538](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L538) +Defined in: [block-kit/blocks.ts:630](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L630) #### Description @@ -74,7 +74,7 @@ Title of the plan in plain text. type: "plan"; ``` -Defined in: [block-kit/blocks.ts:533](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L533) +Defined in: [block-kit/blocks.ts:625](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L625) #### Description diff --git a/docs/english/reference/types/interfaces/RawNumberElement.md b/docs/english/reference/types/interfaces/RawNumberElement.md new file mode 100644 index 000000000..ca01603ca --- /dev/null +++ b/docs/english/reference/types/interfaces/RawNumberElement.md @@ -0,0 +1,51 @@ +[@slack/types](../index.md) / RawNumberElement + +# Interface: RawNumberElement + +Defined in: [block-kit/composition-objects.ts:179](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L179) + +## Description + +Defines an object containing a numeric value. + +## Properties + +### text + +```ts +text: string; +``` + +Defined in: [block-kit/composition-objects.ts:191](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L191) + +#### Description + +The text used to display the value. The minimum length is 1 character. + +*** + +### type + +```ts +type: "raw_number"; +``` + +Defined in: [block-kit/composition-objects.ts:183](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L183) + +#### Description + +The formatting to use for this numeric object. + +*** + +### value + +```ts +value: number; +``` + +Defined in: [block-kit/composition-objects.ts:187](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L187) + +#### Description + +The numeric value. diff --git a/docs/english/reference/types/interfaces/RawTextElement.md b/docs/english/reference/types/interfaces/RawTextElement.md index ad4502791..d3ed50900 100644 --- a/docs/english/reference/types/interfaces/RawTextElement.md +++ b/docs/english/reference/types/interfaces/RawTextElement.md @@ -2,7 +2,7 @@ # Interface: RawTextElement -Defined in: [block-kit/composition-objects.ts:180](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L180) +Defined in: [block-kit/composition-objects.ts:198](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L198) ## Description @@ -20,7 +20,7 @@ Defines an object containing some text. text: string; ``` -Defined in: [block-kit/composition-objects.ts:188](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L188) +Defined in: [block-kit/composition-objects.ts:206](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L206) #### Description @@ -34,7 +34,7 @@ The text for the block. The minimum length is 1 character. type: "raw_text"; ``` -Defined in: [block-kit/composition-objects.ts:184](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L184) +Defined in: [block-kit/composition-objects.ts:202](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L202) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextBlock.md b/docs/english/reference/types/interfaces/RichTextBlock.md index 2b9aa06bb..72a887116 100644 --- a/docs/english/reference/types/interfaces/RichTextBlock.md +++ b/docs/english/reference/types/interfaces/RichTextBlock.md @@ -2,7 +2,7 @@ # Interface: RichTextBlock -Defined in: [block-kit/blocks.ts:390](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L390) +Defined in: [block-kit/blocks.ts:482](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L482) ## Description @@ -29,7 +29,7 @@ the [RichTextInput](RichTextInput.md). optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -51,7 +51,7 @@ a message. If a message is updated, use a new `block_id`. elements: RichTextBlockElement[]; ``` -Defined in: [block-kit/blocks.ts:395](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L395) +Defined in: [block-kit/blocks.ts:487](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L487) *** @@ -61,7 +61,7 @@ Defined in: [block-kit/blocks.ts:395](https://github.com/slackapi/node-slack-sdk type: "rich_text"; ``` -Defined in: [block-kit/blocks.ts:394](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L394) +Defined in: [block-kit/blocks.ts:486](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L486) #### Description diff --git a/docs/english/reference/types/interfaces/SectionBlock.md b/docs/english/reference/types/interfaces/SectionBlock.md index d04c3e274..c53080ce6 100644 --- a/docs/english/reference/types/interfaces/SectionBlock.md +++ b/docs/english/reference/types/interfaces/SectionBlock.md @@ -2,7 +2,7 @@ # Interface: SectionBlock -Defined in: [block-kit/blocks.ts:422](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L422) +Defined in: [block-kit/blocks.ts:514](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L514) ## Description @@ -26,7 +26,7 @@ combination with text fields, or side-by-side with certain optional accessory?: SectionBlockAccessory; ``` -Defined in: [block-kit/blocks.ts:443](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L443) +Defined in: [block-kit/blocks.ts:535](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L535) #### Description @@ -40,7 +40,7 @@ One of the compatible element objects. optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -62,7 +62,7 @@ a message. If a message is updated, use a new `block_id`. optional expand?: boolean; ``` -Defined in: [block-kit/blocks.ts:447](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L447) +Defined in: [block-kit/blocks.ts:539](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L539) 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: [block-kit/blocks.ts:439](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L439) +Defined in: [block-kit/blocks.ts:531](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L531) #### Description @@ -91,7 +91,7 @@ Maximum length for the text in each item is 2000 characters. optional text?: TextObject; ``` -Defined in: [block-kit/blocks.ts:432](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L432) +Defined in: [block-kit/blocks.ts:524](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L524) #### Description @@ -107,7 +107,7 @@ is provided instead. type: "section"; ``` -Defined in: [block-kit/blocks.ts:426](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L426) +Defined in: [block-kit/blocks.ts:518](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L518) #### Description diff --git a/docs/english/reference/types/interfaces/SlackFileImageObject.md b/docs/english/reference/types/interfaces/SlackFileImageObject.md index 123522d8b..fab6f4f4f 100644 --- a/docs/english/reference/types/interfaces/SlackFileImageObject.md +++ b/docs/english/reference/types/interfaces/SlackFileImageObject.md @@ -2,7 +2,7 @@ # Interface: SlackFileImageObject -Defined in: [block-kit/composition-objects.ts:231](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L231) +Defined in: [block-kit/composition-objects.ts:249](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L249) ## Description @@ -16,7 +16,7 @@ Object for image which contains a slack_file. slack_file: SlackFile; ``` -Defined in: [block-kit/composition-objects.ts:235](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L235) +Defined in: [block-kit/composition-objects.ts:253](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L253) #### Description diff --git a/docs/english/reference/types/interfaces/TableBlock.md b/docs/english/reference/types/interfaces/TableBlock.md index 5f46c1b1a..9c0bf08a9 100644 --- a/docs/english/reference/types/interfaces/TableBlock.md +++ b/docs/english/reference/types/interfaces/TableBlock.md @@ -2,7 +2,7 @@ # Interface: TableBlock -Defined in: [block-kit/blocks.ts:454](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L454) +Defined in: [block-kit/blocks.ts:546](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L546) ## Description @@ -24,7 +24,7 @@ Displays structured information in a table. optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. optional column_settings?: TableBlockColumnSettings[]; ``` -Defined in: [block-kit/blocks.ts:466](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L466) +Defined in: [block-kit/blocks.ts:558](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L558) #### Description @@ -59,14 +59,15 @@ An array describing column behavior. If there are fewer items in the column_sett ```ts rows: ( | RichTextBlock - | RawTextElement)[][]; + | RawTextElement + | RawNumberElement)[][]; ``` -Defined in: [block-kit/blocks.ts:462](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L462) +Defined in: [block-kit/blocks.ts:554](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L554) #### 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. +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 rich_text, raw_text, or raw_number. *** @@ -76,7 +77,7 @@ An array consisting of table rows. Maximum 100 rows. Each row object is an array type: "table"; ``` -Defined in: [block-kit/blocks.ts:458](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L458) +Defined in: [block-kit/blocks.ts:550](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L550) #### Description diff --git a/docs/english/reference/types/interfaces/TaskCardBlock.md b/docs/english/reference/types/interfaces/TaskCardBlock.md index ea2ccc111..4589d6c97 100644 --- a/docs/english/reference/types/interfaces/TaskCardBlock.md +++ b/docs/english/reference/types/interfaces/TaskCardBlock.md @@ -2,7 +2,7 @@ # Interface: TaskCardBlock -Defined in: [block-kit/blocks.ts:488](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L488) +Defined in: [block-kit/blocks.ts:580](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L580) ## Description @@ -24,7 +24,7 @@ https://docs.slack.dev/reference/block-kit/blocks/task-card-block/ optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. optional details?: RichTextBlock; ``` -Defined in: [block-kit/blocks.ts:507](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L507) +Defined in: [block-kit/blocks.ts:599](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L599) #### Description @@ -60,7 +60,7 @@ Details of the task in the form of a single "rich_text" entity. optional output?: RichTextBlock; ``` -Defined in: [block-kit/blocks.ts:512](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L512) +Defined in: [block-kit/blocks.ts:604](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L604) #### Description @@ -74,7 +74,7 @@ Output of the task in the form of a single "rich_text" entity. optional sources?: URLSourceElement[]; ``` -Defined in: [block-kit/blocks.ts:517](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L517) +Defined in: [block-kit/blocks.ts:609](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L609) #### Description @@ -88,7 +88,7 @@ Array of URL source elements used to generate a response. status: "error" | "pending" | "in_progress" | "complete"; ``` -Defined in: [block-kit/blocks.ts:522](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L522) +Defined in: [block-kit/blocks.ts:614](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L614) #### Description @@ -102,7 +102,7 @@ The state of a task. Can be "pending", "in_progress", "complete", or "error". task_id: string; ``` -Defined in: [block-kit/blocks.ts:497](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L497) +Defined in: [block-kit/blocks.ts:589](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L589) #### Description @@ -116,7 +116,7 @@ ID for the task. title: string; ``` -Defined in: [block-kit/blocks.ts:502](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L502) +Defined in: [block-kit/blocks.ts:594](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L594) #### Description @@ -130,7 +130,7 @@ Title of the task in plain text. type: "task_card"; ``` -Defined in: [block-kit/blocks.ts:492](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L492) +Defined in: [block-kit/blocks.ts:584](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L584) #### Description diff --git a/docs/english/reference/types/interfaces/UrlImageObject.md b/docs/english/reference/types/interfaces/UrlImageObject.md index 089ee1ab6..146e94609 100644 --- a/docs/english/reference/types/interfaces/UrlImageObject.md +++ b/docs/english/reference/types/interfaces/UrlImageObject.md @@ -2,7 +2,7 @@ # Interface: UrlImageObject -Defined in: [block-kit/composition-objects.ts:221](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L221) +Defined in: [block-kit/composition-objects.ts:239](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L239) ## Description @@ -16,7 +16,7 @@ Object for image which contains a image_url. image_url: string; ``` -Defined in: [block-kit/composition-objects.ts:225](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L225) +Defined in: [block-kit/composition-objects.ts:243](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L243) #### Description diff --git a/docs/english/reference/types/interfaces/VideoBlock.md b/docs/english/reference/types/interfaces/VideoBlock.md index 03ab5dbd2..02e1b85fa 100644 --- a/docs/english/reference/types/interfaces/VideoBlock.md +++ b/docs/english/reference/types/interfaces/VideoBlock.md @@ -2,7 +2,7 @@ # Interface: VideoBlock -Defined in: [block-kit/blocks.ts:552](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L552) +Defined in: [block-kit/blocks.ts:644](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L644) ## Description @@ -26,7 +26,7 @@ must have the [\`links.embed:write\` scope](https://docs.slack.dev/reference/sco alt_text: string; ``` -Defined in: [block-kit/blocks.ts:570](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L570) +Defined in: [block-kit/blocks.ts:662](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L662) #### Description @@ -40,7 +40,7 @@ A tooltip for the video. Required for accessibility. optional author_name?: string; ``` -Defined in: [block-kit/blocks.ts:583](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L583) +Defined in: [block-kit/blocks.ts:675](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L675) #### Description @@ -54,7 +54,7 @@ Author name to be displayed. Must be less than 50 characters. optional block_id?: string; ``` -Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49) +Defined in: [block-kit/blocks.ts:50](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L50) #### Description @@ -76,7 +76,7 @@ a message. If a message is updated, use a new `block_id`. optional description?: PlainTextElement; ``` -Defined in: [block-kit/blocks.ts:595](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L595) +Defined in: [block-kit/blocks.ts:687](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L687) #### Description @@ -90,7 +90,7 @@ Description for video using a [PlainTextElement](PlainTextElement.md) object. optional provider_icon_url?: string; ``` -Defined in: [block-kit/blocks.ts:591](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L591) +Defined in: [block-kit/blocks.ts:683](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L683) #### Description @@ -104,7 +104,7 @@ Icon for the video provider, e.g. YouTube icon. optional provider_name?: string; ``` -Defined in: [block-kit/blocks.ts:587](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L587) +Defined in: [block-kit/blocks.ts:679](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L679) #### Description @@ -118,7 +118,7 @@ The originating application or domain of the video, e.g. YouTube. thumbnail_url: string; ``` -Defined in: [block-kit/blocks.ts:566](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L566) +Defined in: [block-kit/blocks.ts:658](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L658) #### Description @@ -132,7 +132,7 @@ The thumbnail image URL. title: PlainTextElement; ``` -Defined in: [block-kit/blocks.ts:574](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L574) +Defined in: [block-kit/blocks.ts:666](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L666) #### Description @@ -146,7 +146,7 @@ Video title as a [PlainTextElement](PlainTextElement.md) object. `text` within m optional title_url?: string; ``` -Defined in: [block-kit/blocks.ts:579](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L579) +Defined in: [block-kit/blocks.ts:671](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L671) #### Description @@ -161,7 +161,7 @@ Must go to an HTTPS URL. type: "video"; ``` -Defined in: [block-kit/blocks.ts:556](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L556) +Defined in: [block-kit/blocks.ts:648](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L648) #### Description @@ -179,7 +179,7 @@ The type of block. For a video block, `type` is always `video`. video_url: string; ``` -Defined in: [block-kit/blocks.ts:562](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L562) +Defined in: [block-kit/blocks.ts:654](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L654) #### Description diff --git a/docs/english/reference/types/interfaces/WorkflowButton.md b/docs/english/reference/types/interfaces/WorkflowButton.md index 4867a0bc2..d08a5c8f1 100644 --- a/docs/english/reference/types/interfaces/WorkflowButton.md +++ b/docs/english/reference/types/interfaces/WorkflowButton.md @@ -14,7 +14,7 @@ Allows users to run a [link trigger](https://docs.slack.dev/tools/deno-slack-sdk ## Extends -- [`Confirmable`](Confirmable.md) +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md) ## Properties @@ -33,6 +33,24 @@ readers instead of the button `text` object. Maximum length for this field is 75 *** +### action\_id? + +```ts +optional action_id?: string; +``` + +Defined in: [block-kit/extensions.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/extensions.ts#L15) + +@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 +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +*** + ### confirm? ```ts @@ -98,6 +116,10 @@ Defined in: [block-kit/block-elements.ts:735](https://github.com/slackapi/node-s The type of element. In this case `type` is always `workflow_button`. +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + *** ### workflow diff --git a/docs/english/reference/types/type-aliases/ActionsBlockElement.md b/docs/english/reference/types/type-aliases/ActionsBlockElement.md index 8fbde7b4a..754e99830 100644 --- a/docs/english/reference/types/type-aliases/ActionsBlockElement.md +++ b/docs/english/reference/types/type-aliases/ActionsBlockElement.md @@ -17,7 +17,7 @@ type ActionsBlockElement = | RichTextInput; ``` -Defined in: [block-kit/blocks.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L86) +Defined in: [block-kit/blocks.ts:89](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L89) A helper union type of all Block Elements that can be used in an [ActionsBlock](../interfaces/ActionsBlock.md). diff --git a/docs/english/reference/types/type-aliases/AnyBlock.md b/docs/english/reference/types/type-aliases/AnyBlock.md index 71d026bdd..f41e788d2 100644 --- a/docs/english/reference/types/type-aliases/AnyBlock.md +++ b/docs/english/reference/types/type-aliases/AnyBlock.md @@ -6,7 +6,7 @@ type AnyBlock = KnownBlock | Block; ``` -Defined in: [block-kit/blocks.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L80) +Defined in: [block-kit/blocks.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L83) 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/types/type-aliases/ContextActionsBlockElement.md b/docs/english/reference/types/type-aliases/ContextActionsBlockElement.md index 4f6db8f89..e27fe23c3 100644 --- a/docs/english/reference/types/type-aliases/ContextActionsBlockElement.md +++ b/docs/english/reference/types/type-aliases/ContextActionsBlockElement.md @@ -8,6 +8,6 @@ type ContextActionsBlockElement = | IconButton; ``` -Defined in: [block-kit/blocks.ts:212](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L212) +Defined in: [block-kit/blocks.ts:277](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L277) A helper union type of all Block Elements that can be used in a [ContextActionsBlock](../interfaces/ContextActionsBlock.md). diff --git a/docs/english/reference/types/type-aliases/ContextBlockElement.md b/docs/english/reference/types/type-aliases/ContextBlockElement.md index 6b3eae418..6cfbaf809 100644 --- a/docs/english/reference/types/type-aliases/ContextBlockElement.md +++ b/docs/english/reference/types/type-aliases/ContextBlockElement.md @@ -6,7 +6,7 @@ type ContextBlockElement = ImageElement | TextObject; ``` -Defined in: [block-kit/blocks.ts:191](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L191) +Defined in: [block-kit/blocks.ts:256](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L256) A helper union type of all Block Elements that can be used in a [ContextBlock](../interfaces/ContextBlock.md). diff --git a/docs/english/reference/types/type-aliases/ConversationFilter.md b/docs/english/reference/types/type-aliases/ConversationFilter.md index a8d9ef067..19a97f919 100644 --- a/docs/english/reference/types/type-aliases/ConversationFilter.md +++ b/docs/english/reference/types/type-aliases/ConversationFilter.md @@ -9,7 +9,7 @@ type ConversationFilter = | BaseConversationFilter & Required>; ``` -Defined in: [block-kit/composition-objects.ts:214](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L214) +Defined in: [block-kit/composition-objects.ts:232](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L232) ## Description diff --git a/docs/english/reference/types/type-aliases/ImageBlock.md b/docs/english/reference/types/type-aliases/ImageBlock.md index 881f26d16..56bd3e762 100644 --- a/docs/english/reference/types/type-aliases/ImageBlock.md +++ b/docs/english/reference/types/type-aliases/ImageBlock.md @@ -8,7 +8,7 @@ type ImageBlock = object & Block & | SlackFileImageObject; ``` -Defined in: [block-kit/blocks.ts:284](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L284) +Defined in: [block-kit/blocks.ts:376](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L376) ## Type Declaration diff --git a/docs/english/reference/types/type-aliases/InputBlockElement.md b/docs/english/reference/types/type-aliases/InputBlockElement.md index 40faf03c8..61b1f7717 100644 --- a/docs/english/reference/types/type-aliases/InputBlockElement.md +++ b/docs/english/reference/types/type-aliases/InputBlockElement.md @@ -19,7 +19,7 @@ type InputBlockElement = | URLInput; ``` -Defined in: [block-kit/blocks.ts:306](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L306) +Defined in: [block-kit/blocks.ts:398](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L398) A helper union type of all Block Elements that can be used in an [InputBlock](../interfaces/InputBlock.md). diff --git a/docs/english/reference/types/type-aliases/KnownBlock.md b/docs/english/reference/types/type-aliases/KnownBlock.md index f487edc5c..19b77a8cd 100644 --- a/docs/english/reference/types/type-aliases/KnownBlock.md +++ b/docs/english/reference/types/type-aliases/KnownBlock.md @@ -8,8 +8,10 @@ type KnownBlock = | AlertBlock | CardBlock | CarouselBlock + | ContainerBlock | ContextBlock | ContextActionsBlock + | DataTableBlock | DividerBlock | FileBlock | HeaderBlock @@ -24,7 +26,7 @@ type KnownBlock = | VideoBlock; ``` -Defined in: [block-kit/blocks.ts:56](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L56) +Defined in: [block-kit/blocks.ts:57](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L57) 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/types/type-aliases/RichTextBlockElement.md b/docs/english/reference/types/type-aliases/RichTextBlockElement.md index eb4b5985c..ee5fb83d5 100644 --- a/docs/english/reference/types/type-aliases/RichTextBlockElement.md +++ b/docs/english/reference/types/type-aliases/RichTextBlockElement.md @@ -10,7 +10,7 @@ type RichTextBlockElement = | RichTextPreformatted; ``` -Defined in: [block-kit/blocks.ts:379](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L379) +Defined in: [block-kit/blocks.ts:471](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L471) A helper union type of all Block Elements that can be used in a [RichTextBlock](../interfaces/RichTextBlock.md). diff --git a/docs/english/reference/types/type-aliases/SectionBlockAccessory.md b/docs/english/reference/types/type-aliases/SectionBlockAccessory.md index 6123ae30c..10e3dad18 100644 --- a/docs/english/reference/types/type-aliases/SectionBlockAccessory.md +++ b/docs/english/reference/types/type-aliases/SectionBlockAccessory.md @@ -16,7 +16,7 @@ type SectionBlockAccessory = | WorkflowButton; ``` -Defined in: [block-kit/blocks.ts:402](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L402) +Defined in: [block-kit/blocks.ts:494](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L494) 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/types/type-aliases/SlackFile.md b/docs/english/reference/types/type-aliases/SlackFile.md index 1dd93fa68..ed20fe901 100644 --- a/docs/english/reference/types/type-aliases/SlackFile.md +++ b/docs/english/reference/types/type-aliases/SlackFile.md @@ -6,7 +6,7 @@ type SlackFile = SlackFileViaUrl | SlackFileViaId; ``` -Defined in: [block-kit/composition-objects.ts:259](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L259) +Defined in: [block-kit/composition-objects.ts:277](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/composition-objects.ts#L277) ## Description diff --git a/docs/english/reference/web-api/classes/ChatStreamer.md b/docs/english/reference/web-api/classes/ChatStreamer.md index 06e59ad4a..a91f92121 100644 --- a/docs/english/reference/web-api/classes/ChatStreamer.md +++ b/docs/english/reference/web-api/classes/ChatStreamer.md @@ -13,7 +13,8 @@ new ChatStreamer( client, logger, args, - options): ChatStreamer; + options +): ChatStreamer; ``` Defined in: [packages/web-api/src/chat-stream.ts:47](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/chat-stream.ts#L47) diff --git a/docs/english/reference/web-api/classes/Methods.md b/docs/english/reference/web-api/classes/Methods.md index f27a00650..8f006052e 100644 --- a/docs/english/reference/web-api/classes/Methods.md +++ b/docs/english/reference/web-api/classes/Methods.md @@ -4600,7 +4600,8 @@ EventEmitter.prefixed addListener( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:45 @@ -4811,7 +4812,8 @@ off( event, fn?, context?, - once?): this; + once? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:69 @@ -4858,7 +4860,8 @@ EventEmitter.off on( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:40 @@ -4903,7 +4906,8 @@ EventEmitter.on once( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:54 @@ -4977,7 +4981,8 @@ removeListener( event, fn?, context?, - once?): this; + once? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:63 diff --git a/docs/english/reference/web-api/classes/WebAPIHTTPError.md b/docs/english/reference/web-api/classes/WebAPIHTTPError.md index 0c5d28fde..a17279b9b 100644 --- a/docs/english/reference/web-api/classes/WebAPIHTTPError.md +++ b/docs/english/reference/web-api/classes/WebAPIHTTPError.md @@ -17,7 +17,8 @@ new WebAPIHTTPError( statusCode, statusMessage, headers, - body?): WebAPIHTTPError; + body? +): WebAPIHTTPError; ``` Defined in: [packages/web-api/src/errors.ts:66](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/errors.ts#L66) diff --git a/docs/english/reference/web-api/classes/WebClient.md b/docs/english/reference/web-api/classes/WebClient.md index 08df53315..36483a4c7 100644 --- a/docs/english/reference/web-api/classes/WebClient.md +++ b/docs/english/reference/web-api/classes/WebClient.md @@ -4794,7 +4794,8 @@ Defined in: node\_modules/eventemitter3/index.d.ts:9 addListener( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:45 @@ -5072,7 +5073,8 @@ off( event, fn?, context?, - once?): this; + once? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:69 @@ -5117,7 +5119,8 @@ Defined in: node\_modules/eventemitter3/index.d.ts:69 on( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:40 @@ -5160,7 +5163,8 @@ Add a listener for a given event. once( event, fn, - context?): this; + context? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:54 @@ -5245,7 +5249,8 @@ options paginate( method, options, -shouldStop): Promise; + shouldStop +): Promise; ``` Defined in: [packages/web-api/src/WebClient.ts:344](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L344) @@ -5295,7 +5300,8 @@ paginate( method, options, shouldStop, -reduce?): Promise; + reduce? +): Promise; ``` Defined in: [packages/web-api/src/WebClient.ts:345](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L345) @@ -5389,7 +5395,8 @@ removeListener( event, fn?, context?, - once?): this; + once? +): this; ``` Defined in: node\_modules/eventemitter3/index.d.ts:63 diff --git a/docs/english/reference/web-api/index.md b/docs/english/reference/web-api/index.md index 17e13212b..5b4ef66d5 100644 --- a/docs/english/reference/web-api/index.md +++ b/docs/english/reference/web-api/index.md @@ -189,6 +189,7 @@ - [Confirmable](interfaces/Confirmable.md) - [Confirmation](interfaces/Confirmation.md) - [ConfirmationDialog](interfaces/ConfirmationDialog.md) +- [ContainerBlock](interfaces/ContainerBlock.md) - [ContentItemEntityFields](interfaces/ContentItemEntityFields.md) - [ContextActionsBlock](interfaces/ContextActionsBlock.md) - [ContextBlock](interfaces/ContextBlock.md) @@ -215,6 +216,7 @@ - [ConversationsSetPurposeArguments](interfaces/ConversationsSetPurposeArguments.md) - [ConversationsSetTopicArguments](interfaces/ConversationsSetTopicArguments.md) - [ConversationsUnarchiveArguments](interfaces/ConversationsUnarchiveArguments.md) +- [DataTableBlock](interfaces/DataTableBlock.md) - [Datepicker](interfaces/Datepicker.md) - [DateTimepicker](interfaces/DateTimepicker.md) - [~~Dialog~~](interfaces/Dialog.md) @@ -343,6 +345,7 @@ - [PlanBlock](interfaces/PlanBlock.md) - [PlanUpdateChunk](interfaces/PlanUpdateChunk.md) - [RadioButtons](interfaces/RadioButtons.md) +- [RawNumberElement](interfaces/RawNumberElement.md) - [RawTextElement](interfaces/RawTextElement.md) - [ReactionAddedEvent](interfaces/ReactionAddedEvent.md) - [ReactionRemovedEvent](interfaces/ReactionRemovedEvent.md) diff --git a/docs/english/reference/web-api/interfaces/Actionable.md b/docs/english/reference/web-api/interfaces/Actionable.md index 470aabe3c..c38489c2c 100644 --- a/docs/english/reference/web-api/interfaces/Actionable.md +++ b/docs/english/reference/web-api/interfaces/Actionable.md @@ -38,6 +38,7 @@ Defined in: packages/types/dist/block-kit/extensions.d.ts:14 - [`RadioButtons`](RadioButtons.md) - [`Timepicker`](Timepicker.md) - [`URLInput`](URLInput.md) +- [`WorkflowButton`](WorkflowButton.md) - [`RichTextInput`](RichTextInput.md) ## Properties diff --git a/docs/english/reference/web-api/interfaces/Block.md b/docs/english/reference/web-api/interfaces/Block.md index 186c2b80c..9aaba4095 100644 --- a/docs/english/reference/web-api/interfaces/Block.md +++ b/docs/english/reference/web-api/interfaces/Block.md @@ -10,8 +10,10 @@ Defined in: packages/types/dist/block-kit/blocks.d.ts:3 - [`AlertBlock`](AlertBlock.md) - [`CardBlock`](CardBlock.md) - [`CarouselBlock`](CarouselBlock.md) +- [`ContainerBlock`](ContainerBlock.md) - [`ContextBlock`](ContextBlock.md) - [`ContextActionsBlock`](ContextActionsBlock.md) +- [`DataTableBlock`](DataTableBlock.md) - [`DividerBlock`](DividerBlock.md) - [`FileBlock`](FileBlock.md) - [`HeaderBlock`](HeaderBlock.md) diff --git a/docs/english/reference/web-api/interfaces/ContainerBlock.md b/docs/english/reference/web-api/interfaces/ContainerBlock.md new file mode 100644 index 000000000..dc02c9595 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/ContainerBlock.md @@ -0,0 +1,197 @@ +[@slack/web-api](../index.md) / ContainerBlock + +# Interface: ContainerBlock + +Defined in: packages/types/dist/block-kit/blocks.d.ts:120 + +## Description + +A general-purpose wrapper for grouping child blocks together, with a configurable size. + +## See + +[Container block reference](https://docs.slack.dev/reference/block-kit/blocks/container-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) + +*** + +### child\_blocks + +```ts +child_blocks: ( + | RichTextBlock + | ActionsBlock + | ContextBlock + | DividerBlock + | FileBlock + | HeaderBlock + | ImageBlock + | InputBlock + | SectionBlock + | TableBlock + | VideoBlock)[]; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:142 + +#### Description + +An array of child blocks. Maximum 10 blocks. + +*** + +### default\_collapsed? + +```ts +optional default_collapsed?: boolean; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:158 + +#### Description + +Whether the container is collapsed by default. Requires `is_collapsible` to be `true`. Defaults to `false`. + +*** + +### has\_header\_divider? + +```ts +optional has_header_divider?: boolean; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:163 + +#### Description + +Whether to show a visible border separating header from content. +Only applies when `is_collapsible` is not `true`. Defaults to `false`. + +*** + +### icon? + +```ts +optional icon?: ImageElement; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:150 + +#### Description + +An image element displayed alongside the title and subtitle. + +*** + +### is\_collapsible? + +```ts +optional is_collapsible?: boolean; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:154 + +#### Description + +Whether the container can be collapsed. Defaults to `false`. + +*** + +### rich\_text\_title? + +```ts +optional rich_text_title?: RichTextBlock; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:134 + +#### Description + +Rich text title for the container. Takes precedence over `title` if both are provided. +One of `title` or `rich_text_title` is required. + +*** + +### subtitle? + +```ts +optional subtitle?: TextObject; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:138 + +#### Description + +Subtitle for the container in plain text or mrkdwn format. Maximum length is 150 characters. + +*** + +### title? + +```ts +optional title?: PlainTextElement; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:129 + +#### Description + +Plain text title for the container. Maximum length is 150 characters. +One of `title` or `rich_text_title` is required. + +*** + +### type + +```ts +type: "container"; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:124 + +#### Description + +The type of block. For a container block, `type` is always `container`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +*** + +### width? + +```ts +optional width?: "narrow" | "standard" | "wide" | "full"; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:146 + +#### Description + +Controls the width of the container. Defaults to `"standard"`. diff --git a/docs/english/reference/web-api/interfaces/ContextActionsBlock.md b/docs/english/reference/web-api/interfaces/ContextActionsBlock.md index fbfb1635a..d1df9215c 100644 --- a/docs/english/reference/web-api/interfaces/ContextActionsBlock.md +++ b/docs/english/reference/web-api/interfaces/ContextActionsBlock.md @@ -2,7 +2,7 @@ # Interface: ContextActionsBlock -Defined in: packages/types/dist/block-kit/blocks.d.ts:144 +Defined in: packages/types/dist/block-kit/blocks.d.ts:193 ## Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. elements: ContextActionsBlockElement[]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:152 +Defined in: packages/types/dist/block-kit/blocks.d.ts:201 #### Description @@ -60,7 +60,7 @@ An array of [FeedbackButtons](FeedbackButtons.md) or [IconButton](IconButton.md) type: "context_actions"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:148 +Defined in: packages/types/dist/block-kit/blocks.d.ts:197 #### Description diff --git a/docs/english/reference/web-api/interfaces/ContextBlock.md b/docs/english/reference/web-api/interfaces/ContextBlock.md index 5bbd71741..e724d50f3 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/types/dist/block-kit/blocks.d.ts:125 +Defined in: packages/types/dist/block-kit/blocks.d.ts:174 ## Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. elements: ContextBlockElement[]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:134 +Defined in: packages/types/dist/block-kit/blocks.d.ts:183 #### Description @@ -61,7 +61,7 @@ Maximum number of items is 10. type: "context"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:129 +Defined in: packages/types/dist/block-kit/blocks.d.ts:178 #### Description diff --git a/docs/english/reference/web-api/interfaces/DataTableBlock.md b/docs/english/reference/web-api/interfaces/DataTableBlock.md new file mode 100644 index 000000000..7de5653c3 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/DataTableBlock.md @@ -0,0 +1,116 @@ +[@slack/web-api](../index.md) / DataTableBlock + +# Interface: DataTableBlock + +Defined in: packages/types/dist/block-kit/blocks.d.ts:207 + +## Description + +Displays rich tables that support pagination, sorting, filtering, and interactivity. + +## See + +[Data table block reference](https://docs.slack.dev/reference/block-kit/blocks/data-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) + +*** + +### caption + +```ts +caption: string; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:219 + +#### Description + +A caption for the table; used as the value for the HTML caption element. + +*** + +### page\_size? + +```ts +optional page_size?: number; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:223 + +#### Description + +Number of rows per page. Min `1`, Max `100`. Defaults to `5` if omitted. + +*** + +### row\_header\_column\_index? + +```ts +optional row_header_column_index?: number; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:227 + +#### Description + +The 0-based index of the column that uniquely identifies each row (the row header). This column is treated as the row's primary identifier for screen readers. Defaults to `0` if omitted. + +*** + +### rows + +```ts +rows: ( + | RichTextBlock + | RawTextElement + | RawNumberElement)[][]; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:215 + +#### Description + +An array consisting of table rows. + +*** + +### type + +```ts +type: "data_table"; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:211 + +#### Description + +The type of block. For a data table block, `type` is always `data_table`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) diff --git a/docs/english/reference/web-api/interfaces/DividerBlock.md b/docs/english/reference/web-api/interfaces/DividerBlock.md index b03b56dbb..6658e0a5e 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/types/dist/block-kit/blocks.d.ts:159 +Defined in: packages/types/dist/block-kit/blocks.d.ts:234 ## Description @@ -47,7 +47,7 @@ a message. If a message is updated, use a new `block_id`. type: "divider"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:163 +Defined in: packages/types/dist/block-kit/blocks.d.ts:238 #### Description diff --git a/docs/english/reference/web-api/interfaces/FileBlock.md b/docs/english/reference/web-api/interfaces/FileBlock.md index 0c39fe295..cc36956a3 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/types/dist/block-kit/blocks.d.ts:172 +Defined in: packages/types/dist/block-kit/blocks.d.ts:247 ## Description @@ -49,7 +49,7 @@ a message. If a message is updated, use a new `block_id`. external_id: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:184 +Defined in: packages/types/dist/block-kit/blocks.d.ts:259 #### Description @@ -63,7 +63,7 @@ The external unique ID for this file. source: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:180 +Defined in: packages/types/dist/block-kit/blocks.d.ts:255 #### Description @@ -77,7 +77,7 @@ At the moment, source will always be `remote` for a remote file. type: "file"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:176 +Defined in: packages/types/dist/block-kit/blocks.d.ts:251 #### Description diff --git a/docs/english/reference/web-api/interfaces/HeaderBlock.md b/docs/english/reference/web-api/interfaces/HeaderBlock.md index 0e53f1a09..768d99ea3 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/types/dist/block-kit/blocks.d.ts:191 +Defined in: packages/types/dist/block-kit/blocks.d.ts:266 ## Description @@ -47,7 +47,7 @@ a message. If a message is updated, use a new `block_id`. text: PlainTextElement; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:200 +Defined in: packages/types/dist/block-kit/blocks.d.ts:275 #### Description @@ -62,7 +62,7 @@ Maximum length for the text in this field is 150 characters. type: "header"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:195 +Defined in: packages/types/dist/block-kit/blocks.d.ts:270 #### Description diff --git a/docs/english/reference/web-api/interfaces/InputBlock.md b/docs/english/reference/web-api/interfaces/InputBlock.md index 6a1d09a1d..ad7cf9378 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/types/dist/block-kit/blocks.d.ts:233 +Defined in: packages/types/dist/block-kit/blocks.d.ts:308 ## Description @@ -48,7 +48,7 @@ a message. If a message is updated, use a new `block_id`. optional dispatch_action?: boolean; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:261 +Defined in: packages/types/dist/block-kit/blocks.d.ts:336 #### 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/types/dist/block-kit/blocks.d.ts:256 +Defined in: packages/types/dist/block-kit/blocks.d.ts:331 #### Description @@ -77,7 +77,7 @@ A block element. optional hint?: PlainTextElement; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:247 +Defined in: packages/types/dist/block-kit/blocks.d.ts:322 #### 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/types/dist/block-kit/blocks.d.ts:242 +Defined in: packages/types/dist/block-kit/blocks.d.ts:317 #### Description @@ -107,7 +107,7 @@ Maximum length for the text in this field is 2000 characters. optional optional?: boolean; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:252 +Defined in: packages/types/dist/block-kit/blocks.d.ts:327 #### Description @@ -122,7 +122,7 @@ Defaults to `false`. type: "input"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:237 +Defined in: packages/types/dist/block-kit/blocks.d.ts:312 #### Description diff --git a/docs/english/reference/web-api/interfaces/MarkdownBlock.md b/docs/english/reference/web-api/interfaces/MarkdownBlock.md index 38d9bd0f5..a54023ae7 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/types/dist/block-kit/blocks.d.ts:269 +Defined in: packages/types/dist/block-kit/blocks.d.ts:344 ## Description @@ -48,7 +48,7 @@ a message. If a message is updated, use a new `block_id`. text: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:277 +Defined in: packages/types/dist/block-kit/blocks.d.ts:352 #### Description @@ -62,7 +62,7 @@ The standard markdown-formatted text. Limit 12,000 characters max. type: "markdown"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:273 +Defined in: packages/types/dist/block-kit/blocks.d.ts:348 #### Description diff --git a/docs/english/reference/web-api/interfaces/PlanBlock.md b/docs/english/reference/web-api/interfaces/PlanBlock.md index f808933f5..735ceee8b 100644 --- a/docs/english/reference/web-api/interfaces/PlanBlock.md +++ b/docs/english/reference/web-api/interfaces/PlanBlock.md @@ -2,7 +2,7 @@ # Interface: PlanBlock -Defined in: packages/types/dist/block-kit/blocks.d.ts:408 +Defined in: packages/types/dist/block-kit/blocks.d.ts:483 ## Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. optional tasks?: (Record | TaskCardBlock)[]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:420 +Defined in: packages/types/dist/block-kit/blocks.d.ts:495 #### Description @@ -60,7 +60,7 @@ A sequence of task card blocks. Each task represents a single action within the title: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:416 +Defined in: packages/types/dist/block-kit/blocks.d.ts:491 #### Description @@ -74,7 +74,7 @@ Title of the plan in plain text. type: "plan"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:412 +Defined in: packages/types/dist/block-kit/blocks.d.ts:487 #### Description diff --git a/docs/english/reference/web-api/interfaces/RawNumberElement.md b/docs/english/reference/web-api/interfaces/RawNumberElement.md new file mode 100644 index 000000000..41232c98a --- /dev/null +++ b/docs/english/reference/web-api/interfaces/RawNumberElement.md @@ -0,0 +1,51 @@ +[@slack/web-api](../index.md) / RawNumberElement + +# Interface: RawNumberElement + +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:164 + +## Description + +Defines an object containing a numeric value. + +## Properties + +### text + +```ts +text: string; +``` + +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:176 + +#### Description + +The text used to display the value. The minimum length is 1 character. + +*** + +### type + +```ts +type: "raw_number"; +``` + +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:168 + +#### Description + +The formatting to use for this numeric object. + +*** + +### value + +```ts +value: number; +``` + +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:172 + +#### Description + +The numeric value. diff --git a/docs/english/reference/web-api/interfaces/RawTextElement.md b/docs/english/reference/web-api/interfaces/RawTextElement.md index 3de4c6c98..f84bc30c3 100644 --- a/docs/english/reference/web-api/interfaces/RawTextElement.md +++ b/docs/english/reference/web-api/interfaces/RawTextElement.md @@ -2,7 +2,7 @@ # Interface: RawTextElement -Defined in: packages/types/dist/block-kit/composition-objects.d.ts:165 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:182 ## Description @@ -20,7 +20,7 @@ Defines an object containing some text. text: string; ``` -Defined in: packages/types/dist/block-kit/composition-objects.d.ts:173 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:190 #### Description @@ -34,7 +34,7 @@ The text for the block. The minimum length is 1 character. type: "raw_text"; ``` -Defined in: packages/types/dist/block-kit/composition-objects.d.ts:169 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:186 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextBlock.md b/docs/english/reference/web-api/interfaces/RichTextBlock.md index 3df75091c..7f6449137 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/types/dist/block-kit/blocks.d.ts:293 +Defined in: packages/types/dist/block-kit/blocks.d.ts:368 ## Description @@ -51,7 +51,7 @@ a message. If a message is updated, use a new `block_id`. elements: RichTextBlockElement[]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:298 +Defined in: packages/types/dist/block-kit/blocks.d.ts:373 *** @@ -61,7 +61,7 @@ Defined in: packages/types/dist/block-kit/blocks.d.ts:298 type: "rich_text"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:297 +Defined in: packages/types/dist/block-kit/blocks.d.ts:372 #### Description diff --git a/docs/english/reference/web-api/interfaces/SectionBlock.md b/docs/english/reference/web-api/interfaces/SectionBlock.md index 875241914..3fbba7dbf 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/types/dist/block-kit/blocks.d.ts:311 +Defined in: packages/types/dist/block-kit/blocks.d.ts:386 ## Description @@ -26,7 +26,7 @@ combination with text fields, or side-by-side with certain optional accessory?: SectionBlockAccessory; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:332 +Defined in: packages/types/dist/block-kit/blocks.d.ts:407 #### Description @@ -62,7 +62,7 @@ a message. If a message is updated, use a new `block_id`. optional expand?: boolean; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:336 +Defined in: packages/types/dist/block-kit/blocks.d.ts:411 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/types/dist/block-kit/blocks.d.ts:328 +Defined in: packages/types/dist/block-kit/blocks.d.ts:403 #### Description @@ -91,7 +91,7 @@ Maximum length for the text in each item is 2000 characters. optional text?: TextObject; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:321 +Defined in: packages/types/dist/block-kit/blocks.d.ts:396 #### Description @@ -107,7 +107,7 @@ is provided instead. type: "section"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:315 +Defined in: packages/types/dist/block-kit/blocks.d.ts:390 #### Description diff --git a/docs/english/reference/web-api/interfaces/SlackFileImageObject.md b/docs/english/reference/web-api/interfaces/SlackFileImageObject.md index 419a2ca2f..fa278e586 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/types/dist/block-kit/composition-objects.d.ts:210 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:227 ## Description @@ -16,7 +16,7 @@ Object for image which contains a slack_file. slack_file: SlackFile; ``` -Defined in: packages/types/dist/block-kit/composition-objects.d.ts:214 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:231 #### Description diff --git a/docs/english/reference/web-api/interfaces/TableBlock.md b/docs/english/reference/web-api/interfaces/TableBlock.md index 8a1c3acf3..a5393d7c3 100644 --- a/docs/english/reference/web-api/interfaces/TableBlock.md +++ b/docs/english/reference/web-api/interfaces/TableBlock.md @@ -2,7 +2,7 @@ # Interface: TableBlock -Defined in: packages/types/dist/block-kit/blocks.d.ts:342 +Defined in: packages/types/dist/block-kit/blocks.d.ts:417 ## Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. optional column_settings?: TableBlockColumnSettings[]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:354 +Defined in: packages/types/dist/block-kit/blocks.d.ts:429 #### Description @@ -59,14 +59,15 @@ An array describing column behavior. If there are fewer items in the column_sett ```ts rows: ( | RichTextBlock - | RawTextElement)[][]; + | RawTextElement + | RawNumberElement)[][]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:350 +Defined in: packages/types/dist/block-kit/blocks.d.ts:425 #### 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. +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 rich_text, raw_text, or raw_number. *** @@ -76,7 +77,7 @@ An array consisting of table rows. Maximum 100 rows. Each row object is an array type: "table"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:346 +Defined in: packages/types/dist/block-kit/blocks.d.ts:421 #### Description diff --git a/docs/english/reference/web-api/interfaces/TaskCardBlock.md b/docs/english/reference/web-api/interfaces/TaskCardBlock.md index 6a7e43512..ee3a2a2b1 100644 --- a/docs/english/reference/web-api/interfaces/TaskCardBlock.md +++ b/docs/english/reference/web-api/interfaces/TaskCardBlock.md @@ -2,7 +2,7 @@ # Interface: TaskCardBlock -Defined in: packages/types/dist/block-kit/blocks.d.ts:374 +Defined in: packages/types/dist/block-kit/blocks.d.ts:449 ## Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. optional details?: RichTextBlock; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:390 +Defined in: packages/types/dist/block-kit/blocks.d.ts:465 #### Description @@ -60,7 +60,7 @@ Details of the task in the form of a single "rich_text" entity. optional output?: RichTextBlock; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:394 +Defined in: packages/types/dist/block-kit/blocks.d.ts:469 #### Description @@ -74,7 +74,7 @@ Output of the task in the form of a single "rich_text" entity. optional sources?: URLSourceElement[]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:398 +Defined in: packages/types/dist/block-kit/blocks.d.ts:473 #### Description @@ -88,7 +88,7 @@ Array of URL source elements used to generate a response. status: "error" | "pending" | "in_progress" | "complete"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:402 +Defined in: packages/types/dist/block-kit/blocks.d.ts:477 #### Description @@ -102,7 +102,7 @@ The state of a task. Can be "pending", "in_progress", "complete", or "error". task_id: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:382 +Defined in: packages/types/dist/block-kit/blocks.d.ts:457 #### Description @@ -116,7 +116,7 @@ ID for the task. title: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:386 +Defined in: packages/types/dist/block-kit/blocks.d.ts:461 #### Description @@ -130,7 +130,7 @@ Title of the task in plain text. type: "task_card"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:378 +Defined in: packages/types/dist/block-kit/blocks.d.ts:453 #### Description diff --git a/docs/english/reference/web-api/interfaces/UrlImageObject.md b/docs/english/reference/web-api/interfaces/UrlImageObject.md index 31418186f..161e41e0a 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/types/dist/block-kit/composition-objects.d.ts:201 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:218 ## Description @@ -16,7 +16,7 @@ Object for image which contains a image_url. image_url: string; ``` -Defined in: packages/types/dist/block-kit/composition-objects.d.ts:205 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:222 #### Description diff --git a/docs/english/reference/web-api/interfaces/VideoBlock.md b/docs/english/reference/web-api/interfaces/VideoBlock.md index 05a3df585..aa7e31145 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/types/dist/block-kit/blocks.d.ts:428 +Defined in: packages/types/dist/block-kit/blocks.d.ts:503 ## Description @@ -26,7 +26,7 @@ must have the [\`links.embed:write\` scope](https://docs.slack.dev/reference/sco alt_text: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:446 +Defined in: packages/types/dist/block-kit/blocks.d.ts:521 #### Description @@ -40,7 +40,7 @@ A tooltip for the video. Required for accessibility. optional author_name?: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:459 +Defined in: packages/types/dist/block-kit/blocks.d.ts:534 #### Description @@ -76,7 +76,7 @@ a message. If a message is updated, use a new `block_id`. optional description?: PlainTextElement; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:471 +Defined in: packages/types/dist/block-kit/blocks.d.ts:546 #### Description @@ -90,7 +90,7 @@ Description for video using a [PlainTextElement](PlainTextElement.md) object. optional provider_icon_url?: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:467 +Defined in: packages/types/dist/block-kit/blocks.d.ts:542 #### Description @@ -104,7 +104,7 @@ Icon for the video provider, e.g. YouTube icon. optional provider_name?: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:463 +Defined in: packages/types/dist/block-kit/blocks.d.ts:538 #### Description @@ -118,7 +118,7 @@ The originating application or domain of the video, e.g. YouTube. thumbnail_url: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:442 +Defined in: packages/types/dist/block-kit/blocks.d.ts:517 #### Description @@ -132,7 +132,7 @@ The thumbnail image URL. title: PlainTextElement; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:450 +Defined in: packages/types/dist/block-kit/blocks.d.ts:525 #### Description @@ -146,7 +146,7 @@ Video title as a [PlainTextElement](PlainTextElement.md) object. `text` within m optional title_url?: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:455 +Defined in: packages/types/dist/block-kit/blocks.d.ts:530 #### Description @@ -161,7 +161,7 @@ Must go to an HTTPS URL. type: "video"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:432 +Defined in: packages/types/dist/block-kit/blocks.d.ts:507 #### Description @@ -179,7 +179,7 @@ The type of block. For a video block, `type` is always `video`. video_url: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:438 +Defined in: packages/types/dist/block-kit/blocks.d.ts:513 #### Description diff --git a/docs/english/reference/web-api/interfaces/WorkflowButton.md b/docs/english/reference/web-api/interfaces/WorkflowButton.md index 6de5a634c..6bfcce482 100644 --- a/docs/english/reference/web-api/interfaces/WorkflowButton.md +++ b/docs/english/reference/web-api/interfaces/WorkflowButton.md @@ -14,7 +14,7 @@ Allows users to run a [link trigger](https://docs.slack.dev/tools/deno-slack-sdk ## Extends -- [`Confirmable`](Confirmable.md) +- [`Actionable`](Actionable.md).[`Confirmable`](Confirmable.md) ## Properties @@ -33,6 +33,24 @@ readers instead of the button `text` object. Maximum length for this field is 75 *** +### action\_id? + +```ts +optional action_id?: string; +``` + +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 +among all other `action_id`s in the containing block. Maximum length for this field is 255 characters. + +#### Inherited from + +[`Actionable`](Actionable.md).[`action_id`](Actionable.md#action_id) + +*** + ### confirm? ```ts @@ -98,6 +116,10 @@ Defined in: packages/types/dist/block-kit/block-elements.d.ts:644 The type of element. In this case `type` is always `workflow_button`. +#### Overrides + +[`Actionable`](Actionable.md).[`type`](Actionable.md#type) + *** ### workflow diff --git a/docs/english/reference/web-api/type-aliases/ContextActionsBlockElement.md b/docs/english/reference/web-api/type-aliases/ContextActionsBlockElement.md index 0b0b3e418..4448bb0ef 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/types/dist/block-kit/blocks.d.ts:139 +Defined in: packages/types/dist/block-kit/blocks.d.ts:188 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 9d580a88b..4941171bf 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/types/dist/block-kit/blocks.d.ts:120 +Defined in: packages/types/dist/block-kit/blocks.d.ts:169 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 650d8589d..f53fc7785 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/types/dist/block-kit/composition-objects.d.ts:197 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:214 ## Description diff --git a/docs/english/reference/web-api/type-aliases/ImageBlock.md b/docs/english/reference/web-api/type-aliases/ImageBlock.md index 0ff5b6470..16b4def54 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/types/dist/block-kit/blocks.d.ts:206 +Defined in: packages/types/dist/block-kit/blocks.d.ts:281 ## 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 6c4346e30..6008f4f17 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/types/dist/block-kit/blocks.d.ts:226 +Defined in: packages/types/dist/block-kit/blocks.d.ts:301 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 c28bd018c..57ba3a0a0 100644 --- a/docs/english/reference/web-api/type-aliases/KnownBlock.md +++ b/docs/english/reference/web-api/type-aliases/KnownBlock.md @@ -8,8 +8,10 @@ type KnownBlock = | AlertBlock | CardBlock | CarouselBlock + | ContainerBlock | ContextBlock | ContextActionsBlock + | DataTableBlock | DividerBlock | FileBlock | HeaderBlock diff --git a/docs/english/reference/web-api/type-aliases/RichTextBlockElement.md b/docs/english/reference/web-api/type-aliases/RichTextBlockElement.md index 9a4506e76..78b638256 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/types/dist/block-kit/blocks.d.ts:283 +Defined in: packages/types/dist/block-kit/blocks.d.ts:358 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/SectionBlockAccessory.md b/docs/english/reference/web-api/type-aliases/SectionBlockAccessory.md index 67ceee224..bc14b8ad2 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/types/dist/block-kit/blocks.d.ts:304 +Defined in: packages/types/dist/block-kit/blocks.d.ts:379 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/SlackFile.md b/docs/english/reference/web-api/type-aliases/SlackFile.md index 7b53b3b4d..3df2bd36a 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/types/dist/block-kit/composition-objects.d.ts:235 +Defined in: packages/types/dist/block-kit/composition-objects.d.ts:252 ## Description diff --git a/docs/english/reference/webhook/classes/IncomingWebhookHTTPError.md b/docs/english/reference/webhook/classes/IncomingWebhookHTTPError.md index 628f19f70..2bcf7fb79 100644 --- a/docs/english/reference/webhook/classes/IncomingWebhookHTTPError.md +++ b/docs/english/reference/webhook/classes/IncomingWebhookHTTPError.md @@ -16,7 +16,8 @@ Defined in: [packages/webhook/src/errors.ts:35](https://github.com/slackapi/node new IncomingWebhookHTTPError( statusCode, statusMessage, - body): IncomingWebhookHTTPError; + body +): IncomingWebhookHTTPError; ``` Defined in: [packages/webhook/src/errors.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L41) diff --git a/docs/english/reference/webhook/classes/WebhookTriggerHTTPError.md b/docs/english/reference/webhook/classes/WebhookTriggerHTTPError.md index cd357c93d..baf5ffc8f 100644 --- a/docs/english/reference/webhook/classes/WebhookTriggerHTTPError.md +++ b/docs/english/reference/webhook/classes/WebhookTriggerHTTPError.md @@ -16,7 +16,8 @@ Defined in: [packages/webhook/src/errors.ts:59](https://github.com/slackapi/node new WebhookTriggerHTTPError( statusCode, statusMessage, - body): WebhookTriggerHTTPError; + body +): WebhookTriggerHTTPError; ``` Defined in: [packages/webhook/src/errors.ts:65](https://github.com/slackapi/node-slack-sdk/blob/main/packages/webhook/src/errors.ts#L65) diff --git a/package-lock.json b/package-lock.json index b5ebd7093..67e66ed67 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5500,7 +5500,7 @@ }, "packages/types": { "name": "@slack/types", - "version": "3.1.0", + "version": "3.2.0", "license": "MIT", "devDependencies": { "tsd": "^0.33.0" diff --git a/packages/types/CHANGELOG.md b/packages/types/CHANGELOG.md index 310ab269b..7bfdf6eb9 100644 --- a/packages/types/CHANGELOG.md +++ b/packages/types/CHANGELOG.md @@ -1,5 +1,14 @@ # @slack/types +## 3.2.0 + +### Minor Changes + +- ca6f416: feat(types): add [`ContainerBlock`](https://docs.slack.dev/reference/block-kit/blocks/container-block/) block interface +- abf184e: feat: add the [`data_table`](https://docs.slack.dev/reference/block-kit/blocks/data-table-block) Block Kit block type (`DataTableBlock`) +- d420d00: feat: allow `raw_number` cells in [`TableBlock`](https://docs.slack.dev/reference/block-kit/blocks/table-block) rows (adds `RawNumberElement`) +- 52eeb05: feat(types): add optional `action_id` property to the [`WorkflowButton`](https://docs.slack.dev/reference/block-kit/block-elements/workflow-button-element) block element + ## 3.1.0 ### Minor Changes diff --git a/packages/types/package.json b/packages/types/package.json index dc10b4ac3..d213e67ad 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@slack/types", - "version": "3.1.0", + "version": "3.2.0", "description": "Shared type definitions for the Node Slack SDK", "author": "Slack Technologies, LLC", "license": "MIT",