diff --git a/.changeset/add-auth-provider-block.md b/.changeset/add-auth-provider-block.md deleted file mode 100644 index ab7517292..000000000 --- a/.changeset/add-auth-provider-block.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/types": minor ---- - -feat(types): add [`AuthProviderBlock`](https://docs.slack.dev/reference/block-kit/blocks/auth-provider-block) block interface diff --git a/.changeset/apps-user-connection-request-auth-bulk-update.md b/.changeset/apps-user-connection-request-auth-bulk-update.md deleted file mode 100644 index bef0b2362..000000000 --- a/.changeset/apps-user-connection-request-auth-bulk-update.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/web-api": minor ---- - -feat: add support for apps.user.connection.requestAuth and apps.user.connection.bulkUpdate diff --git a/.changeset/button-agent-prompt-fields.md b/.changeset/button-agent-prompt-fields.md deleted file mode 100644 index 79cc68c86..000000000 --- a/.changeset/button-agent-prompt-fields.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/types": patch ---- - -fix(types): add the `agent_prompt`, `agent_prompt_display`, and `visible_to_user_ids` fields to the [`Button`](https://docs.slack.dev/reference/block-kit/block-elements/button-element) block element diff --git a/.changeset/canvases-get-content.md b/.changeset/canvases-get-content.md deleted file mode 100644 index bdcdbe134..000000000 --- a/.changeset/canvases-get-content.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/web-api": minor ---- - -feat(web-api): add [`canvases.getContent`](https://docs.slack.dev/reference/methods/canvases.getContent) method diff --git a/.changeset/fix-upload-image-alt-text.md b/.changeset/fix-upload-image-alt-text.md deleted file mode 100644 index bc8545ae1..000000000 --- a/.changeset/fix-upload-image-alt-text.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/web-api": patch ---- - -fix: image alt text passed to `files.uploadV2` is now saved. Before, it was sent as `alt_text`, which Slack ignores. Add `alt_txt` to `files.uploadV2` and `files.getUploadURLExternal` arguments, and deprecate `alt_text` in both. A deprecated `alt_text` passed to `files.uploadV2` is still sent as `alt_txt` ([#2788](https://github.com/slackapi/node-slack-sdk/issues/2788)) diff --git a/.changeset/friendly-sockets-listen.md b/.changeset/friendly-sockets-listen.md deleted file mode 100644 index 8ac8cd14f..000000000 --- a/.changeset/friendly-sockets-listen.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@slack/socket-mode': patch ---- - -Fix Events API dispatch for payloads without an inner event, including app_rate_limited. Keep malformed payloads available to generic slack_event listeners for acknowledgement. diff --git a/.changeset/manifest-code-channels.md b/.changeset/manifest-code-channels.md deleted file mode 100644 index a41243c96..000000000 --- a/.changeset/manifest-code-channels.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/web-api": minor ---- - -feat: add the `code_channels` app manifest feature and the `code_channels:manage` bot scope to manifest types diff --git a/.changeset/manifest-user-connections.md b/.changeset/manifest-user-connections.md deleted file mode 100644 index 27ad8bedf..000000000 --- a/.changeset/manifest-user-connections.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/web-api": minor ---- - -feat: add the `user_connections` feature (`is_enabled`, `auth_hosts`) and the `user_connection` and `user_connection_status_requested` events to the app manifest types diff --git a/.changeset/socket-mode-close-handshake-timer.md b/.changeset/socket-mode-close-handshake-timer.md deleted file mode 100644 index 7675011fe..000000000 --- a/.changeset/socket-mode-close-handshake-timer.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -"@slack/socket-mode": patch ---- - -Fix an orphaned close-handshake timer ([#2771](https://github.com/slackapi/node-slack-sdk/issues/2771)). When the connection closed while a close frame was in flight, the 30s timer armed by `disconnect()` outlived the connection, then logged a false "Peer did not complete the close handshake" warning and emitted a second `close`, which could start a duplicate reconnect. - -- `disconnect()` on an already closed socket now cleans up immediately instead of sending a close frame and arming a second timer. This is the path when Slack drops the TCP connection after a `disconnect` message. -- `disconnect()` before the connection opens no longer leaves the timer behind: undici fails a connecting socket synchronously inside `close()`, so the timer is now armed before it. diff --git a/.changeset/team-info-slackbot-availability.md b/.changeset/team-info-slackbot-availability.md deleted file mode 100644 index 3326e7a26..000000000 --- a/.changeset/team-info-slackbot-availability.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/web-api": minor ---- - -Add the optional `include_slackbot_availability` argument and `team.slackbot_availability` response field to `team.info`. diff --git a/.changeset/thread-broadcast-file-fields.md b/.changeset/thread-broadcast-file-fields.md deleted file mode 100644 index aca9b7877..000000000 --- a/.changeset/thread-broadcast-file-fields.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/types": patch ---- - -fix: add the `files`, `upload`, `display_as_bot`, and `parent_user_id` fields to `ThreadBroadcastMessageEvent` diff --git a/.changeset/user-connection-status-requested-event.md b/.changeset/user-connection-status-requested-event.md deleted file mode 100644 index d442e1033..000000000 --- a/.changeset/user-connection-status-requested-event.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"@slack/types": minor ---- - -feat(types): add the [`user_connection`](https://docs.slack.dev/reference/events/user_connection) and [`user_connection_status_requested`](https://docs.slack.dev/reference/events/user_connection_status_requested) event interfaces diff --git a/docs/english/reference/socket-mode/index.md b/docs/english/reference/socket-mode/index.md index 53409cf66..7a4591160 100644 --- a/docs/english/reference/socket-mode/index.md +++ b/docs/english/reference/socket-mode/index.md @@ -1,4 +1,4 @@ -# @slack/socket-mode v3.1.0 +# @slack/socket-mode v3.1.1 ## Enumerations diff --git a/docs/english/reference/types/index.md b/docs/english/reference/types/index.md index aeddb754a..60d917049 100644 --- a/docs/english/reference/types/index.md +++ b/docs/english/reference/types/index.md @@ -1,4 +1,4 @@ -# @slack/types v3.2.0 +# @slack/types v3.3.0 ## Enumerations @@ -24,6 +24,7 @@ - [AppUninstalledTeamEvent](interfaces/AppUninstalledTeamEvent.md) - [AssistantThreadContextChangedEvent](interfaces/AssistantThreadContextChangedEvent.md) - [AssistantThreadStartedEvent](interfaces/AssistantThreadStartedEvent.md) +- [AuthProviderBlock](interfaces/AuthProviderBlock.md) - [Block](interfaces/Block.md) - [BlocksChunk](interfaces/BlocksChunk.md) - [BotMessageEvent](interfaces/BotMessageEvent.md) @@ -224,6 +225,9 @@ - [URLRespondable](interfaces/URLRespondable.md) - [URLSourceElement](interfaces/URLSourceElement.md) - [UserChangeEvent](interfaces/UserChangeEvent.md) +- [UserConnectionConnectEvent](interfaces/UserConnectionConnectEvent.md) +- [UserConnectionDisconnectEvent](interfaces/UserConnectionDisconnectEvent.md) +- [UserConnectionStatusRequestedEvent](interfaces/UserConnectionStatusRequestedEvent.md) - [UserHuddleChangedEvent](interfaces/UserHuddleChangedEvent.md) - [UserProfileChangedEvent](interfaces/UserProfileChangedEvent.md) - [UsersSelect](interfaces/UsersSelect.md) @@ -270,4 +274,5 @@ - [~~SubteamCreated~~](type-aliases/SubteamCreated.md) - [~~SubteamMembersChanged~~](type-aliases/SubteamMembersChanged.md) - [TextObject](type-aliases/TextObject.md) +- [UserConnectionEvent](type-aliases/UserConnectionEvent.md) - [View](type-aliases/View.md) diff --git a/docs/english/reference/types/interfaces/ActionsBlock.md b/docs/english/reference/types/interfaces/ActionsBlock.md index b9fde21eb..a900f7f6a 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:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L106) +Defined in: [block-kit/blocks.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L107) ## 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:115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L115) +Defined in: [block-kit/blocks.ts:116](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L116) #### Description @@ -61,7 +61,7 @@ There is a maximum of 25 elements in each action block. type: "actions"; ``` -Defined in: [block-kit/blocks.ts:110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L110) +Defined in: [block-kit/blocks.ts:111](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L111) #### Description diff --git a/docs/english/reference/types/interfaces/AlertBlock.md b/docs/english/reference/types/interfaces/AlertBlock.md index 3e20d316a..662667d35 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:122](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L122) +Defined in: [block-kit/blocks.ts:123](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L123) ## 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:134](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L134) +Defined in: [block-kit/blocks.ts:135](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L135) #### Description @@ -60,7 +60,7 @@ The severity level of the alert. Defaults to `"default"` if omitted. text: TextObject; ``` -Defined in: [block-kit/blocks.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L130) +Defined in: [block-kit/blocks.ts:131](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L131) #### 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:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L126) +Defined in: [block-kit/blocks.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L127) #### Description diff --git a/docs/english/reference/types/interfaces/AuthProviderBlock.md b/docs/english/reference/types/interfaces/AuthProviderBlock.md new file mode 100644 index 000000000..6060f9971 --- /dev/null +++ b/docs/english/reference/types/interfaces/AuthProviderBlock.md @@ -0,0 +1,221 @@ +[@slack/types](../index.md) / AuthProviderBlock + +# Interface: AuthProviderBlock + +Defined in: [block-kit/blocks.ts:142](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L142) + +## Description + +Displays authentication provider information, including its icon, name, and connection state. + +## See + +[Auth provider block reference](https://docs.slack.dev/reference/block-kit/blocks/auth-provider-block). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### accessory? + +```ts +optional accessory?: Overflow; +``` + +Defined in: [block-kit/blocks.ts:195](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L195) + +#### Description + +An [Overflow](Overflow.md) menu shown when connected, e.g. Disconnect or Re-authenticate. + +*** + +### auth\_url? + +```ts +optional auth_url?: string; +``` + +Defined in: [block-kit/blocks.ts:176](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L176) + +#### Description + +OAuth redirect URL opened when the user clicks Connect. Must be an HTTPS URL on a host listed in the +app manifest's `features.user_connections.auth_hosts`. Maximum length for this field is 3000 characters. + +*** + +### 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) + +*** + +### connected\_context? + +```ts +optional connected_context?: PlainTextElement; +``` + +Defined in: [block-kit/blocks.ts:191](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L191) + +#### Description + +Additional context about the connection in the form of a [PlainTextElement](PlainTextElement.md), e.g. the org or +workspace name. Maximum length for the text in this field is 75 characters. + +*** + +### connected\_identity? + +```ts +optional connected_identity?: PlainTextElement; +``` + +Defined in: [block-kit/blocks.ts:186](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L186) + +#### Description + +Display name of the connected account in the form of a [PlainTextElement](PlainTextElement.md), shown when +`is_connected` is `true`. Maximum length for the text in this field is 75 characters. + +*** + +### description? + +```ts +optional description?: PlainTextElement; +``` + +Defined in: [block-kit/blocks.ts:166](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L166) + +#### Description + +Brief description of what this connection enables in the form of a [PlainTextElement](PlainTextElement.md). +Maximum length for the text in this field is 150 characters. + +*** + +### disconnect\_url? + +```ts +optional disconnect_url?: string; +``` + +Defined in: [block-kit/blocks.ts:181](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L181) + +#### Description + +URL opened when the user clicks Disconnect. Must be an HTTPS URL on a host listed in the app +manifest's `features.user_connections.auth_hosts`. Maximum length for this field is 3000 characters. + +*** + +### fallback? + +```ts +optional fallback?: KnownBlock[]; +``` + +Defined in: [block-kit/blocks.ts:200](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L200) + +#### Description + +An array of stable [KnownBlock](../type-aliases/KnownBlock.md) objects rendered by clients that don't recognize +`auth_provider`, spliced into the parent blocks array. + +*** + +### icon\_url? + +```ts +optional icon_url?: string; +``` + +Defined in: [block-kit/blocks.ts:171](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L171) + +#### Description + +URL for the provider icon image. Must be an HTTPS URL. Falls back to the app's avatar when absent. +Maximum length for this field is 3000 characters. + +*** + +### is\_connected + +```ts +is_connected: boolean; +``` + +Defined in: [block-kit/blocks.ts:161](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L161) + +#### Description + +Whether this provider is currently connected. Slack records this state for the user. + +*** + +### name + +```ts +name: PlainTextElement; +``` + +Defined in: [block-kit/blocks.ts:157](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L157) + +#### Description + +Human-readable name of the provider in the form of a [PlainTextElement](PlainTextElement.md). +Maximum length for the text in this field is 75 characters. + +*** + +### type + +```ts +type: "auth_provider"; +``` + +Defined in: [block-kit/blocks.ts:146](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L146) + +#### Description + +The type of block. For an auth provider block, `type` is always `auth_provider`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +*** + +### value + +```ts +value: string; +``` + +Defined in: [block-kit/blocks.ts:152](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L152) + +#### Description + +Unique identifier for this provider within the app. Included in interaction payloads and used to +derive the connect button `action_id` (`auth_provider_connect_`). Maximum length for this field is 150 +characters. diff --git a/docs/english/reference/types/interfaces/Block.md b/docs/english/reference/types/interfaces/Block.md index d65d41765..9fcf1431a 100644 --- a/docs/english/reference/types/interfaces/Block.md +++ b/docs/english/reference/types/interfaces/Block.md @@ -8,6 +8,7 @@ Defined in: [block-kit/blocks.ts:38](https://github.com/slackapi/node-slack-sdk/ - [`ActionsBlock`](ActionsBlock.md) - [`AlertBlock`](AlertBlock.md) +- [`AuthProviderBlock`](AuthProviderBlock.md) - [`CardBlock`](CardBlock.md) - [`CarouselBlock`](CarouselBlock.md) - [`ContainerBlock`](ContainerBlock.md) diff --git a/docs/english/reference/types/interfaces/Button.md b/docs/english/reference/types/interfaces/Button.md index 2492347b4..44c7a1ab6 100644 --- a/docs/english/reference/types/interfaces/Button.md +++ b/docs/english/reference/types/interfaces/Button.md @@ -52,6 +52,36 @@ among all other `action_id`s in the containing block. Maximum length for this fi *** +### agent\_prompt? + +```ts +optional agent_prompt?: string; +``` + +Defined in: [block-kit/block-elements.ts:68](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L68) + +#### Description + +A prompt sent to Slackbot when the button is clicked, if Slackbot AI is available to the user. +Maximum length for this field is 4000 characters. + +*** + +### agent\_prompt\_display? + +```ts +optional agent_prompt_display?: string; +``` + +Defined in: [block-kit/block-elements.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L73) + +#### Description + +Short text shown instead of the full `agent_prompt` in the user's Slackbot message. Requires +`agent_prompt` and defaults to the button's `text`. + +*** + ### confirm? ```ts @@ -151,3 +181,17 @@ Defined in: [block-kit/block-elements.ts:43](https://github.com/slackapi/node-sl The value to send along with the [interaction payload](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Maximum length for this field is 2000 characters. + +*** + +### visible\_to\_user\_ids? + +```ts +optional visible_to_user_ids?: string[]; +``` + +Defined in: [block-kit/block-elements.ts:77](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L77) + +#### Description + +An array of user IDs for which the button appears. If not provided, the button is visible to all users. diff --git a/docs/english/reference/types/interfaces/CardBlock.md b/docs/english/reference/types/interfaces/CardBlock.md index c2f465086..96c3698bc 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:141](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L141) +Defined in: [block-kit/blocks.ts:207](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L207) ## 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:172](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L172) +Defined in: [block-kit/blocks.ts:238](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L238) #### 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:168](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L168) +Defined in: [block-kit/blocks.ts:234](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L234) #### 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:149](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L149) +Defined in: [block-kit/blocks.ts:215](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L215) #### 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:153](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L153) +Defined in: [block-kit/blocks.ts:219](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L219) #### 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:163](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L163) +Defined in: [block-kit/blocks.ts:229](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L229) #### 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:158](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L158) +Defined in: [block-kit/blocks.ts:224](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L224) #### Description @@ -133,7 +133,7 @@ Maximum length for the text in this field is 150 characters. type: "card"; ``` -Defined in: [block-kit/blocks.ts:145](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L145) +Defined in: [block-kit/blocks.ts:211](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L211) #### Description diff --git a/docs/english/reference/types/interfaces/CarouselBlock.md b/docs/english/reference/types/interfaces/CarouselBlock.md index 76e6202a8..de0eb2324 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:179](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L179) +Defined in: [block-kit/blocks.ts:245](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L245) ## 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:187](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L187) +Defined in: [block-kit/blocks.ts:253](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L253) #### 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:183](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L183) +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 diff --git a/docs/english/reference/types/interfaces/ChannelsSelect.md b/docs/english/reference/types/interfaces/ChannelsSelect.md index 83fa2d693..af08ab2f2 100644 --- a/docs/english/reference/types/interfaces/ChannelsSelect.md +++ b/docs/english/reference/types/interfaces/ChannelsSelect.md @@ -2,7 +2,7 @@ # Interface: ChannelsSelect -Defined in: [block-kit/block-elements.ts:481](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L481) +Defined in: [block-kit/block-elements.ts:495](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L495) ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_channel?: string; ``` -Defined in: [block-kit/block-elements.ts:489](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L489) +Defined in: [block-kit/block-elements.ts:503](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L503) #### Description @@ -137,7 +137,7 @@ for the message will be determined by the value of this select menu. type: "channels_select"; ``` -Defined in: [block-kit/block-elements.ts:485](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L485) +Defined in: [block-kit/block-elements.ts:499](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L499) #### Description diff --git a/docs/english/reference/types/interfaces/Checkboxes.md b/docs/english/reference/types/interfaces/Checkboxes.md index c742396c2..1f8519eca 100644 --- a/docs/english/reference/types/interfaces/Checkboxes.md +++ b/docs/english/reference/types/interfaces/Checkboxes.md @@ -2,7 +2,7 @@ # Interface: Checkboxes -Defined in: [block-kit/block-elements.ts:71](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L71) +Defined in: [block-kit/block-elements.ts:85](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L85) ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_options?: Option[]; ``` -Defined in: [block-kit/block-elements.ts:80](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L80) +Defined in: [block-kit/block-elements.ts:94](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L94) #### Description @@ -97,7 +97,7 @@ These options will be selected when the checkbox group initially loads. options: Option[]; ``` -Defined in: [block-kit/block-elements.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L84) +Defined in: [block-kit/block-elements.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L98) #### Description @@ -111,7 +111,7 @@ An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options type: "checkboxes"; ``` -Defined in: [block-kit/block-elements.ts:75](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L75) +Defined in: [block-kit/block-elements.ts:89](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L89) #### Description diff --git a/docs/english/reference/types/interfaces/ContainerBlock.md b/docs/english/reference/types/interfaces/ContainerBlock.md index 086cddd95..d71576522 100644 --- a/docs/english/reference/types/interfaces/ContainerBlock.md +++ b/docs/english/reference/types/interfaces/ContainerBlock.md @@ -2,7 +2,7 @@ # 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) +Defined in: [block-kit/blocks.ts:260](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L260) ## Description @@ -57,7 +57,7 @@ child_blocks: ( | 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) +Defined in: [block-kit/blocks.ts:282](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L282) #### Description @@ -71,7 +71,7 @@ An array of child blocks. Maximum 10 blocks. 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) +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 @@ -85,7 +85,7 @@ Whether the container is collapsed by default. Requires `is_collapsible` to be ` 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) +Defined in: [block-kit/blocks.ts:315](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L315) #### Description @@ -100,7 +100,7 @@ Only applies when `is_collapsible` is not `true`. Defaults to `false`. 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) +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 @@ -114,7 +114,7 @@ An image element displayed alongside the title and subtitle. 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) +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 @@ -128,7 +128,7 @@ Whether the container can be collapsed. Defaults to `false`. 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) +Defined in: [block-kit/blocks.ts:274](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L274) #### Description @@ -143,7 +143,7 @@ One of `title` or `rich_text_title` is required. 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) +Defined in: [block-kit/blocks.ts:278](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L278) #### Description @@ -157,7 +157,7 @@ Subtitle for the container in plain text or mrkdwn format. Maximum length is 150 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) +Defined in: [block-kit/blocks.ts:269](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L269) #### Description @@ -172,7 +172,7 @@ One of `title` or `rich_text_title` is required. 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) +Defined in: [block-kit/blocks.ts:264](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L264) #### Description @@ -190,7 +190,7 @@ The type of block. For a container block, `type` is always `container`. 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) +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 diff --git a/docs/english/reference/types/interfaces/ContextActionsBlock.md b/docs/english/reference/types/interfaces/ContextActionsBlock.md index 4125cc454..f16e8fc2b 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:283](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L283) +Defined in: [block-kit/blocks.ts:349](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L349) ## 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:291](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L291) +Defined in: [block-kit/blocks.ts:357](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L357) #### Description @@ -60,7 +60,7 @@ An array of [FeedbackButtons](FeedbackButtons.md) or [IconButton](IconButton.md) type: "context_actions"; ``` -Defined in: [block-kit/blocks.ts:287](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L287) +Defined in: [block-kit/blocks.ts:353](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L353) #### Description diff --git a/docs/english/reference/types/interfaces/ContextBlock.md b/docs/english/reference/types/interfaces/ContextBlock.md index 4150ec0e2..049329635 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:262](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L262) +Defined in: [block-kit/blocks.ts:328](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L328) ## 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:271](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L271) +Defined in: [block-kit/blocks.ts:337](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L337) #### Description @@ -61,7 +61,7 @@ Maximum number of items is 10. type: "context"; ``` -Defined in: [block-kit/blocks.ts:266](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L266) +Defined in: [block-kit/blocks.ts:332](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L332) #### Description diff --git a/docs/english/reference/types/interfaces/ConversationsSelect.md b/docs/english/reference/types/interfaces/ConversationsSelect.md index bd5684df0..1bf3362ae 100644 --- a/docs/english/reference/types/interfaces/ConversationsSelect.md +++ b/docs/english/reference/types/interfaces/ConversationsSelect.md @@ -2,7 +2,7 @@ # Interface: ConversationsSelect -Defined in: [block-kit/block-elements.ts:409](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L409) +Defined in: [block-kit/block-elements.ts:423](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L423) ## Description @@ -63,7 +63,7 @@ with. optional default_to_current_conversation?: boolean; ``` -Defined in: [block-kit/block-elements.ts:423](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L423) +Defined in: [block-kit/block-elements.ts:437](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L437) #### Description @@ -78,7 +78,7 @@ modal, if available. Default is `false`. optional filter?: object; ``` -Defined in: [block-kit/block-elements.ts:427](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L427) +Defined in: [block-kit/block-elements.ts:441](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L441) #### exclude\_bot\_users? @@ -130,7 +130,7 @@ Defaults to `false`. optional initial_conversation?: string; ``` -Defined in: [block-kit/block-elements.ts:418](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L418) +Defined in: [block-kit/block-elements.ts:432](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L432) #### Description @@ -185,7 +185,7 @@ for the message will be determined by the value of this select menu. type: "conversations_select"; ``` -Defined in: [block-kit/block-elements.ts:413](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L413) +Defined in: [block-kit/block-elements.ts:427](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L427) #### Description diff --git a/docs/english/reference/types/interfaces/DataTableBlock.md b/docs/english/reference/types/interfaces/DataTableBlock.md index de434e426..293428b4a 100644 --- a/docs/english/reference/types/interfaces/DataTableBlock.md +++ b/docs/english/reference/types/interfaces/DataTableBlock.md @@ -2,7 +2,7 @@ # 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) +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 @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. 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) +Defined in: [block-kit/blocks.ts:376](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L376) #### Description @@ -60,7 +60,7 @@ A caption for the table; used as the value for the HTML caption element. 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) +Defined in: [block-kit/blocks.ts:380](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L380) #### Description @@ -74,7 +74,7 @@ Number of rows per page. Min `1`, Max `100`. Defaults to `5` if omitted. 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) +Defined in: [block-kit/blocks.ts:384](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L384) #### Description @@ -91,7 +91,7 @@ rows: ( | 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) +Defined in: [block-kit/blocks.ts:372](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L372) #### Description @@ -105,7 +105,7 @@ An array consisting of table rows. 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) +Defined in: [block-kit/blocks.ts:368](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L368) #### Description diff --git a/docs/english/reference/types/interfaces/DateTimepicker.md b/docs/english/reference/types/interfaces/DateTimepicker.md index 855feb902..966d79c3a 100644 --- a/docs/english/reference/types/interfaces/DateTimepicker.md +++ b/docs/english/reference/types/interfaces/DateTimepicker.md @@ -2,7 +2,7 @@ # Interface: DateTimepicker -Defined in: [block-kit/block-elements.ts:112](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L112) +Defined in: [block-kit/block-elements.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L126) ## Description @@ -85,7 +85,7 @@ Defaults to `false`. optional initial_date_time?: number; ``` -Defined in: [block-kit/block-elements.ts:122](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L122) +Defined in: [block-kit/block-elements.ts:136](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L136) #### Description @@ -101,7 +101,7 @@ time August 10th, 2021 at 03:17pm PST. type: "datetimepicker"; ``` -Defined in: [block-kit/block-elements.ts:116](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L116) +Defined in: [block-kit/block-elements.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L130) #### Description diff --git a/docs/english/reference/types/interfaces/Datepicker.md b/docs/english/reference/types/interfaces/Datepicker.md index 1ab8c824e..f7a36471f 100644 --- a/docs/english/reference/types/interfaces/Datepicker.md +++ b/docs/english/reference/types/interfaces/Datepicker.md @@ -2,7 +2,7 @@ # Interface: Datepicker -Defined in: [block-kit/block-elements.ts:92](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L92) +Defined in: [block-kit/block-elements.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L106) ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_date?: string; ``` -Defined in: [block-kit/block-elements.ts:101](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L101) +Defined in: [block-kit/block-elements.ts:115](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L115) #### Description @@ -116,7 +116,7 @@ length for the `text` field in this object is 150 characters. type: "datepicker"; ``` -Defined in: [block-kit/block-elements.ts:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L96) +Defined in: [block-kit/block-elements.ts:110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L110) #### Description diff --git a/docs/english/reference/types/interfaces/DividerBlock.md b/docs/english/reference/types/interfaces/DividerBlock.md index 52b202e23..539ae8c09 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:326](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L326) +Defined in: [block-kit/blocks.ts:392](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L392) ## 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:330](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L330) +Defined in: [block-kit/blocks.ts:396](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L396) #### Description diff --git a/docs/english/reference/types/interfaces/EmailInput.md b/docs/english/reference/types/interfaces/EmailInput.md index 283b33d5f..ecac0ff95 100644 --- a/docs/english/reference/types/interfaces/EmailInput.md +++ b/docs/english/reference/types/interfaces/EmailInput.md @@ -2,7 +2,7 @@ # Interface: EmailInput -Defined in: [block-kit/block-elements.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L130) +Defined in: [block-kit/block-elements.ts:144](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L144) ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_value?: string; ``` -Defined in: [block-kit/block-elements.ts:138](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L138) +Defined in: [block-kit/block-elements.ts:152](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L152) #### Description @@ -115,7 +115,7 @@ length for the `text` field in this object is 150 characters. type: "email_text_input"; ``` -Defined in: [block-kit/block-elements.ts:134](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L134) +Defined in: [block-kit/block-elements.ts:148](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L148) #### Description diff --git a/docs/english/reference/types/interfaces/ExternalSelect.md b/docs/english/reference/types/interfaces/ExternalSelect.md index 986377262..257fa32a5 100644 --- a/docs/english/reference/types/interfaces/ExternalSelect.md +++ b/docs/english/reference/types/interfaces/ExternalSelect.md @@ -2,7 +2,7 @@ # Interface: ExternalSelect -Defined in: [block-kit/block-elements.ts:516](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L516) +Defined in: [block-kit/block-elements.ts:530](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L530) ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_option?: PlainTextOption; ``` -Defined in: [block-kit/block-elements.ts:525](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L525) +Defined in: [block-kit/block-elements.ts:539](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L539) #### Description @@ -97,7 +97,7 @@ A single option to be selected when the menu initially loads. optional min_query_length?: number; ``` -Defined in: [block-kit/block-elements.ts:531](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L531) +Defined in: [block-kit/block-elements.ts:545](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L545) #### Description @@ -132,7 +132,7 @@ length for the `text` field in this object is 150 characters. type: "external_select"; ``` -Defined in: [block-kit/block-elements.ts:520](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L520) +Defined in: [block-kit/block-elements.ts:534](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L534) #### Description diff --git a/docs/english/reference/types/interfaces/FeedbackButtons.md b/docs/english/reference/types/interfaces/FeedbackButtons.md index b22089572..3f1be3ab3 100644 --- a/docs/english/reference/types/interfaces/FeedbackButtons.md +++ b/docs/english/reference/types/interfaces/FeedbackButtons.md @@ -2,7 +2,7 @@ # Interface: FeedbackButtons -Defined in: [block-kit/block-elements.ts:144](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L144) +Defined in: [block-kit/block-elements.ts:158](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L158) ## Description @@ -38,7 +38,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi negative_button: object; ``` -Defined in: [block-kit/block-elements.ts:173](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L173) +Defined in: [block-kit/block-elements.ts:187](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L187) #### accessibility\_label? @@ -90,7 +90,7 @@ A button to indicate negative feedback. positive_button: object; ``` -Defined in: [block-kit/block-elements.ts:154](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L154) +Defined in: [block-kit/block-elements.ts:168](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L168) #### accessibility\_label? @@ -142,7 +142,7 @@ A button to indicate positive feedback. type: "feedback_buttons"; ``` -Defined in: [block-kit/block-elements.ts:149](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L149) +Defined in: [block-kit/block-elements.ts:163](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L163) #### Description diff --git a/docs/english/reference/types/interfaces/FileBlock.md b/docs/english/reference/types/interfaces/FileBlock.md index 064683cc5..50b47b02e 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:340](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L340) +Defined in: [block-kit/blocks.ts:406](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L406) ## 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:352](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L352) +Defined in: [block-kit/blocks.ts:418](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L418) #### Description @@ -63,7 +63,7 @@ The external unique ID for this file. source: string; ``` -Defined in: [block-kit/blocks.ts:348](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L348) +Defined in: [block-kit/blocks.ts:414](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L414) #### 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:344](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L344) +Defined in: [block-kit/blocks.ts:410](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L410) #### Description diff --git a/docs/english/reference/types/interfaces/FileInput.md b/docs/english/reference/types/interfaces/FileInput.md index 2d10b2eb5..4d57dc57b 100644 --- a/docs/english/reference/types/interfaces/FileInput.md +++ b/docs/english/reference/types/interfaces/FileInput.md @@ -2,7 +2,7 @@ # Interface: FileInput -Defined in: [block-kit/block-elements.ts:195](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L195) +Defined in: [block-kit/block-elements.ts:209](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L209) ## Description @@ -43,7 +43,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional filetypes?: string[]; ``` -Defined in: [block-kit/block-elements.ts:205](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L205) +Defined in: [block-kit/block-elements.ts:219](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L219) #### Description @@ -59,7 +59,7 @@ for convenience only, and you should perform your own file type validation based optional max_files?: number; ``` -Defined in: [block-kit/block-elements.ts:210](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L210) +Defined in: [block-kit/block-elements.ts:224](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L224) #### Description @@ -74,7 +74,7 @@ Maximum number of files that can be uploaded for this `file_input` element. Mini type: "file_input"; ``` -Defined in: [block-kit/block-elements.ts:199](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L199) +Defined in: [block-kit/block-elements.ts:213](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L213) #### Description diff --git a/docs/english/reference/types/interfaces/HeaderBlock.md b/docs/english/reference/types/interfaces/HeaderBlock.md index 43f2ad950..4225fca0b 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:360](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L360) +Defined in: [block-kit/blocks.ts:426](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L426) ## 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:369](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L369) +Defined in: [block-kit/blocks.ts:435](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L435) #### Description @@ -62,7 +62,7 @@ Maximum length for the text in this field is 150 characters. type: "header"; ``` -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:430](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L430) #### Description diff --git a/docs/english/reference/types/interfaces/IconButton.md b/docs/english/reference/types/interfaces/IconButton.md index 2405aa53d..3e034ce18 100644 --- a/docs/english/reference/types/interfaces/IconButton.md +++ b/docs/english/reference/types/interfaces/IconButton.md @@ -2,7 +2,7 @@ # Interface: IconButton -Defined in: [block-kit/block-elements.ts:217](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L217) +Defined in: [block-kit/block-elements.ts:231](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L231) ## Description @@ -24,7 +24,7 @@ An icon button to perform actions. optional accessibility_label?: string; ``` -Defined in: [block-kit/block-elements.ts:235](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L235) +Defined in: [block-kit/block-elements.ts:249](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L249) #### Description @@ -75,7 +75,7 @@ with. icon: string; ``` -Defined in: [block-kit/block-elements.ts:226](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L226) +Defined in: [block-kit/block-elements.ts:240](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L240) #### Description @@ -95,7 +95,7 @@ trash text: PlainTextElement; ``` -Defined in: [block-kit/block-elements.ts:231](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L231) +Defined in: [block-kit/block-elements.ts:245](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L245) #### Description @@ -113,7 +113,7 @@ Defines an object containing some text. type: "icon_button"; ``` -Defined in: [block-kit/block-elements.ts:221](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L221) +Defined in: [block-kit/block-elements.ts:235](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L235) #### Description @@ -131,7 +131,7 @@ The type of element. In this case `type` is always `icon_button`. optional value?: string; ``` -Defined in: [block-kit/block-elements.ts:239](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L239) +Defined in: [block-kit/block-elements.ts:253](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L253) #### Description @@ -145,7 +145,7 @@ The button value. optional visible_to_user_ids?: string[]; ``` -Defined in: [block-kit/block-elements.ts:243](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L243) +Defined in: [block-kit/block-elements.ts:257](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L257) #### Description diff --git a/docs/english/reference/types/interfaces/InputBlock.md b/docs/english/reference/types/interfaces/InputBlock.md index e94df6b66..a4561135d 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:419](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L419) +Defined in: [block-kit/blocks.ts:485](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L485) ## 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:447](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L447) +Defined in: [block-kit/blocks.ts:513](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L513) #### 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:442](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L442) +Defined in: [block-kit/blocks.ts:508](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L508) #### Description @@ -77,7 +77,7 @@ A block element. optional hint?: PlainTextElement; ``` -Defined in: [block-kit/blocks.ts:433](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L433) +Defined in: [block-kit/blocks.ts:499](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L499) #### 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:428](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L428) +Defined in: [block-kit/blocks.ts:494](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L494) #### 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:438](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L438) +Defined in: [block-kit/blocks.ts:504](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L504) #### Description @@ -122,7 +122,7 @@ Defaults to `false`. type: "input"; ``` -Defined in: [block-kit/blocks.ts:423](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L423) +Defined in: [block-kit/blocks.ts:489](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L489) #### Description diff --git a/docs/english/reference/types/interfaces/MarkdownBlock.md b/docs/english/reference/types/interfaces/MarkdownBlock.md index 5f7ab3ab8..f294f92bb 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:456](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L456) +Defined in: [block-kit/blocks.ts:522](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L522) ## 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:464](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L464) +Defined in: [block-kit/blocks.ts:530](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L530) #### Description @@ -62,7 +62,7 @@ The standard markdown-formatted text. Limit 12,000 characters max. type: "markdown"; ``` -Defined in: [block-kit/blocks.ts:460](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L460) +Defined in: [block-kit/blocks.ts:526](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L526) #### Description diff --git a/docs/english/reference/types/interfaces/MultiChannelsSelect.md b/docs/english/reference/types/interfaces/MultiChannelsSelect.md index adc250bbb..98d447cd3 100644 --- a/docs/english/reference/types/interfaces/MultiChannelsSelect.md +++ b/docs/english/reference/types/interfaces/MultiChannelsSelect.md @@ -2,7 +2,7 @@ # Interface: MultiChannelsSelect -Defined in: [block-kit/block-elements.ts:498](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L498) +Defined in: [block-kit/block-elements.ts:512](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L512) ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_channels?: string[]; ``` -Defined in: [block-kit/block-elements.ts:507](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L507) +Defined in: [block-kit/block-elements.ts:521](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L521) #### Description @@ -134,7 +134,7 @@ length for the `text` field in this object is 150 characters. type: "multi_channels_select"; ``` -Defined in: [block-kit/block-elements.ts:502](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L502) +Defined in: [block-kit/block-elements.ts:516](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L516) #### Description diff --git a/docs/english/reference/types/interfaces/MultiConversationsSelect.md b/docs/english/reference/types/interfaces/MultiConversationsSelect.md index dae9f9c6e..f35b634e3 100644 --- a/docs/english/reference/types/interfaces/MultiConversationsSelect.md +++ b/docs/english/reference/types/interfaces/MultiConversationsSelect.md @@ -2,7 +2,7 @@ # Interface: MultiConversationsSelect -Defined in: [block-kit/block-elements.ts:443](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L443) +Defined in: [block-kit/block-elements.ts:457](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L457) ## Description @@ -63,7 +63,7 @@ with. optional default_to_current_conversation?: boolean; ``` -Defined in: [block-kit/block-elements.ts:463](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L463) +Defined in: [block-kit/block-elements.ts:477](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L477) #### Description @@ -78,7 +78,7 @@ modal, if available. Default is `false`. optional filter?: object; ``` -Defined in: [block-kit/block-elements.ts:467](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L467) +Defined in: [block-kit/block-elements.ts:481](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L481) #### exclude\_bot\_users? @@ -130,7 +130,7 @@ Defaults to `false`. optional initial_conversations?: string[]; ``` -Defined in: [block-kit/block-elements.ts:458](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L458) +Defined in: [block-kit/block-elements.ts:472](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L472) #### Description @@ -182,7 +182,7 @@ length for the `text` field in this object is 150 characters. type: "multi_conversations_select"; ``` -Defined in: [block-kit/block-elements.ts:452](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L452) +Defined in: [block-kit/block-elements.ts:466](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L466) #### Description diff --git a/docs/english/reference/types/interfaces/MultiExternalSelect.md b/docs/english/reference/types/interfaces/MultiExternalSelect.md index cf2d616dd..01b133a0e 100644 --- a/docs/english/reference/types/interfaces/MultiExternalSelect.md +++ b/docs/english/reference/types/interfaces/MultiExternalSelect.md @@ -2,7 +2,7 @@ # Interface: MultiExternalSelect -Defined in: [block-kit/block-elements.ts:539](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L539) +Defined in: [block-kit/block-elements.ts:553](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L553) ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_options?: PlainTextOption[]; ``` -Defined in: [block-kit/block-elements.ts:548](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L548) +Defined in: [block-kit/block-elements.ts:562](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L562) #### Description @@ -114,7 +114,7 @@ Specifies the maximum number of items that can be selected. Minimum number is 1. optional min_query_length?: number; ``` -Defined in: [block-kit/block-elements.ts:554](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L554) +Defined in: [block-kit/block-elements.ts:568](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L568) #### Description @@ -149,7 +149,7 @@ length for the `text` field in this object is 150 characters. type: "multi_external_select"; ``` -Defined in: [block-kit/block-elements.ts:543](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L543) +Defined in: [block-kit/block-elements.ts:557](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L557) #### Description diff --git a/docs/english/reference/types/interfaces/MultiStaticSelect.md b/docs/english/reference/types/interfaces/MultiStaticSelect.md index 009097b37..f03cc107a 100644 --- a/docs/english/reference/types/interfaces/MultiStaticSelect.md +++ b/docs/english/reference/types/interfaces/MultiStaticSelect.md @@ -2,7 +2,7 @@ # Interface: MultiStaticSelect -Defined in: [block-kit/block-elements.ts:372](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L372) +Defined in: [block-kit/block-elements.ts:386](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L386) ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_options?: PlainTextOption[]; ``` -Defined in: [block-kit/block-elements.ts:382](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L382) +Defined in: [block-kit/block-elements.ts:396](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L396) #### Description @@ -116,7 +116,7 @@ Specifies the maximum number of items that can be selected. Minimum number is 1. optional option_groups?: object[]; ``` -Defined in: [block-kit/block-elements.ts:397](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L397) +Defined in: [block-kit/block-elements.ts:411](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L411) #### label @@ -143,7 +143,7 @@ this field should not be. optional options?: PlainTextOption[]; ``` -Defined in: [block-kit/block-elements.ts:389](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L389) +Defined in: [block-kit/block-elements.ts:403](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L403) #### Description @@ -177,7 +177,7 @@ length for the `text` field in this object is 150 characters. type: "multi_static_select"; ``` -Defined in: [block-kit/block-elements.ts:376](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L376) +Defined in: [block-kit/block-elements.ts:390](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L390) #### Description diff --git a/docs/english/reference/types/interfaces/MultiUsersSelect.md b/docs/english/reference/types/interfaces/MultiUsersSelect.md index 6ce506c14..40e37abfb 100644 --- a/docs/english/reference/types/interfaces/MultiUsersSelect.md +++ b/docs/english/reference/types/interfaces/MultiUsersSelect.md @@ -2,7 +2,7 @@ # Interface: MultiUsersSelect -Defined in: [block-kit/block-elements.ts:318](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L318) +Defined in: [block-kit/block-elements.ts:332](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L332) ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_users?: string[]; ``` -Defined in: [block-kit/block-elements.ts:326](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L326) +Defined in: [block-kit/block-elements.ts:340](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L340) #### Description @@ -134,7 +134,7 @@ length for the `text` field in this object is 150 characters. type: "multi_users_select"; ``` -Defined in: [block-kit/block-elements.ts:322](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L322) +Defined in: [block-kit/block-elements.ts:336](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L336) #### Description diff --git a/docs/english/reference/types/interfaces/NumberInput.md b/docs/english/reference/types/interfaces/NumberInput.md index b48d74a8d..63869620c 100644 --- a/docs/english/reference/types/interfaces/NumberInput.md +++ b/docs/english/reference/types/interfaces/NumberInput.md @@ -2,7 +2,7 @@ # Interface: NumberInput -Defined in: [block-kit/block-elements.ts:568](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L568) +Defined in: [block-kit/block-elements.ts:582](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L582) ## Description @@ -84,7 +84,7 @@ Defaults to `false`. optional initial_value?: string; ``` -Defined in: [block-kit/block-elements.ts:580](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L580) +Defined in: [block-kit/block-elements.ts:594](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L594) #### Description @@ -98,7 +98,7 @@ The initial value in the input when it is loaded. is_decimal_allowed: boolean; ``` -Defined in: [block-kit/block-elements.ts:576](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L576) +Defined in: [block-kit/block-elements.ts:590](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L590) #### Description @@ -112,7 +112,7 @@ Decimal numbers are allowed if this property is `true`, set the value to `false` optional max_value?: string; ``` -Defined in: [block-kit/block-elements.ts:588](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L588) +Defined in: [block-kit/block-elements.ts:602](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L602) #### Description @@ -126,7 +126,7 @@ The maximum value, cannot be less than `min_value`. optional min_value?: string; ``` -Defined in: [block-kit/block-elements.ts:584](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L584) +Defined in: [block-kit/block-elements.ts:598](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L598) #### Description @@ -159,7 +159,7 @@ length for the `text` field in this object is 150 characters. type: "number_input"; ``` -Defined in: [block-kit/block-elements.ts:572](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L572) +Defined in: [block-kit/block-elements.ts:586](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L586) #### Description diff --git a/docs/english/reference/types/interfaces/Overflow.md b/docs/english/reference/types/interfaces/Overflow.md index 4b4e30ce3..1b7ba6551 100644 --- a/docs/english/reference/types/interfaces/Overflow.md +++ b/docs/english/reference/types/interfaces/Overflow.md @@ -2,7 +2,7 @@ # Interface: Overflow -Defined in: [block-kit/block-elements.ts:600](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L600) +Defined in: [block-kit/block-elements.ts:614](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L614) ## Description @@ -66,7 +66,7 @@ with. options: PlainTextOption[]; ``` -Defined in: [block-kit/block-elements.ts:609](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L609) +Defined in: [block-kit/block-elements.ts:623](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L623) #### Description @@ -80,7 +80,7 @@ An array of up to 5 [PlainTextOption](PlainTextOption.md) to display in the menu type: "overflow"; ``` -Defined in: [block-kit/block-elements.ts:604](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L604) +Defined in: [block-kit/block-elements.ts:618](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L618) #### Description diff --git a/docs/english/reference/types/interfaces/PlainTextInput.md b/docs/english/reference/types/interfaces/PlainTextInput.md index 0aff6f7d2..fb8d1ed96 100644 --- a/docs/english/reference/types/interfaces/PlainTextInput.md +++ b/docs/english/reference/types/interfaces/PlainTextInput.md @@ -2,7 +2,7 @@ # Interface: PlainTextInput -Defined in: [block-kit/block-elements.ts:617](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L617) +Defined in: [block-kit/block-elements.ts:631](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L631) ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_value?: string; ``` -Defined in: [block-kit/block-elements.ts:625](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L625) +Defined in: [block-kit/block-elements.ts:639](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L639) #### Description @@ -96,7 +96,7 @@ The initial value in the plain-text input when it is loaded. optional max_length?: number; ``` -Defined in: [block-kit/block-elements.ts:640](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L640) +Defined in: [block-kit/block-elements.ts:654](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L654) #### Description @@ -111,7 +111,7 @@ they will receive an error. optional min_length?: number; ``` -Defined in: [block-kit/block-elements.ts:635](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L635) +Defined in: [block-kit/block-elements.ts:649](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L649) #### Description @@ -126,7 +126,7 @@ an error. Maximum value is 3000. optional multiline?: boolean; ``` -Defined in: [block-kit/block-elements.ts:630](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L630) +Defined in: [block-kit/block-elements.ts:644](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L644) #### Description @@ -160,7 +160,7 @@ length for the `text` field in this object is 150 characters. type: "plain_text_input"; ``` -Defined in: [block-kit/block-elements.ts:621](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L621) +Defined in: [block-kit/block-elements.ts:635](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L635) #### Description diff --git a/docs/english/reference/types/interfaces/PlanBlock.md b/docs/english/reference/types/interfaces/PlanBlock.md index 040ec2078..64ffd2cd1 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:621](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L621) +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 @@ -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:635](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L635) +Defined in: [block-kit/blocks.ts:701](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L701) #### 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:630](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L630) +Defined in: [block-kit/blocks.ts:696](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L696) #### Description @@ -74,7 +74,7 @@ Title of the plan in plain text. type: "plan"; ``` -Defined in: [block-kit/blocks.ts:625](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L625) +Defined in: [block-kit/blocks.ts:691](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L691) #### Description diff --git a/docs/english/reference/types/interfaces/RadioButtons.md b/docs/english/reference/types/interfaces/RadioButtons.md index ac26b2e4e..8ab337e04 100644 --- a/docs/english/reference/types/interfaces/RadioButtons.md +++ b/docs/english/reference/types/interfaces/RadioButtons.md @@ -2,7 +2,7 @@ # Interface: RadioButtons -Defined in: [block-kit/block-elements.ts:648](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L648) +Defined in: [block-kit/block-elements.ts:662](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L662) ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_option?: Option; ``` -Defined in: [block-kit/block-elements.ts:657](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L657) +Defined in: [block-kit/block-elements.ts:671](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L671) #### Description @@ -97,7 +97,7 @@ be selected when the radio button group initially loads. options: Option[]; ``` -Defined in: [block-kit/block-elements.ts:661](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L661) +Defined in: [block-kit/block-elements.ts:675](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L675) #### Description @@ -111,7 +111,7 @@ An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options type: "radio_buttons"; ``` -Defined in: [block-kit/block-elements.ts:652](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L652) +Defined in: [block-kit/block-elements.ts:666](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L666) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextBlock.md b/docs/english/reference/types/interfaces/RichTextBlock.md index 72a887116..6cb2ff7a0 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:482](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L482) +Defined in: [block-kit/blocks.ts:548](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L548) ## 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:487](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L487) +Defined in: [block-kit/blocks.ts:553](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L553) *** @@ -61,7 +61,7 @@ Defined in: [block-kit/blocks.ts:487](https://github.com/slackapi/node-slack-sdk type: "rich_text"; ``` -Defined in: [block-kit/blocks.ts:486](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L486) +Defined in: [block-kit/blocks.ts:552](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L552) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextBroadcastMention.md b/docs/english/reference/types/interfaces/RichTextBroadcastMention.md index 43b67f8eb..a84f70a6f 100644 --- a/docs/english/reference/types/interfaces/RichTextBroadcastMention.md +++ b/docs/english/reference/types/interfaces/RichTextBroadcastMention.md @@ -2,7 +2,7 @@ # Interface: RichTextBroadcastMention -Defined in: [block-kit/block-elements.ts:791](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L791) +Defined in: [block-kit/block-elements.ts:805](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L805) ## Description @@ -20,7 +20,7 @@ A broadcast mention element for use in a rich text message. range: "here" | "channel" | "everyone"; ``` -Defined in: [block-kit/block-elements.ts:799](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L799) +Defined in: [block-kit/block-elements.ts:813](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L813) #### Description @@ -102,7 +102,7 @@ A limited style object for styling rich text `text` elements. type: "broadcast"; ``` -Defined in: [block-kit/block-elements.ts:795](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L795) +Defined in: [block-kit/block-elements.ts:809](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L809) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextChannelMention.md b/docs/english/reference/types/interfaces/RichTextChannelMention.md index ab42bb0a1..d471e217e 100644 --- a/docs/english/reference/types/interfaces/RichTextChannelMention.md +++ b/docs/english/reference/types/interfaces/RichTextChannelMention.md @@ -2,7 +2,7 @@ # Interface: RichTextChannelMention -Defined in: [block-kit/block-elements.ts:819](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L819) +Defined in: [block-kit/block-elements.ts:833](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L833) ## Description @@ -20,7 +20,7 @@ A channel mention element for use in a rich text message. channel_id: string; ``` -Defined in: [block-kit/block-elements.ts:827](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L827) +Defined in: [block-kit/block-elements.ts:841](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L841) #### Description @@ -102,7 +102,7 @@ A limited style object for styling rich text `text` elements. type: "channel"; ``` -Defined in: [block-kit/block-elements.ts:823](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L823) +Defined in: [block-kit/block-elements.ts:837](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L837) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextColor.md b/docs/english/reference/types/interfaces/RichTextColor.md index 8120cc71f..9a86c0c15 100644 --- a/docs/english/reference/types/interfaces/RichTextColor.md +++ b/docs/english/reference/types/interfaces/RichTextColor.md @@ -2,7 +2,7 @@ # Interface: RichTextColor -Defined in: [block-kit/block-elements.ts:805](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L805) +Defined in: [block-kit/block-elements.ts:819](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L819) ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. type: "color"; ``` -Defined in: [block-kit/block-elements.ts:809](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L809) +Defined in: [block-kit/block-elements.ts:823](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L823) #### Description @@ -102,7 +102,7 @@ The type of element. In this case `type` is always `color`. value: string; ``` -Defined in: [block-kit/block-elements.ts:813](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L813) +Defined in: [block-kit/block-elements.ts:827](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L827) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextDate.md b/docs/english/reference/types/interfaces/RichTextDate.md index b88975c1c..3550c1df8 100644 --- a/docs/english/reference/types/interfaces/RichTextDate.md +++ b/docs/english/reference/types/interfaces/RichTextDate.md @@ -2,7 +2,7 @@ # Interface: RichTextDate -Defined in: [block-kit/block-elements.ts:833](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L833) +Defined in: [block-kit/block-elements.ts:847](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L847) ## Description @@ -20,7 +20,7 @@ A date element for use in a rich text message. optional fallback?: string; ``` -Defined in: [block-kit/block-elements.ts:873](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L873) +Defined in: [block-kit/block-elements.ts:887](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L887) #### Description @@ -34,7 +34,7 @@ Text to display in place of the date should parsing, formatting or displaying fa format: string; ``` -Defined in: [block-kit/block-elements.ts:865](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L865) +Defined in: [block-kit/block-elements.ts:879](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L879) #### Description @@ -136,7 +136,7 @@ A limited style object for styling rich text `text` elements. timestamp: number; ``` -Defined in: [block-kit/block-elements.ts:841](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L841) +Defined in: [block-kit/block-elements.ts:855](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L855) #### Description @@ -150,7 +150,7 @@ A UNIX timestamp for the date to be displayed in seconds. type: "date"; ``` -Defined in: [block-kit/block-elements.ts:837](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L837) +Defined in: [block-kit/block-elements.ts:851](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L851) #### Description @@ -164,7 +164,7 @@ The type of element. In this case `type` is always `date`. optional url?: string; ``` -Defined in: [block-kit/block-elements.ts:869](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L869) +Defined in: [block-kit/block-elements.ts:883](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L883) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextEmoji.md b/docs/english/reference/types/interfaces/RichTextEmoji.md index 5bd76c74b..50f876d5f 100644 --- a/docs/english/reference/types/interfaces/RichTextEmoji.md +++ b/docs/english/reference/types/interfaces/RichTextEmoji.md @@ -2,7 +2,7 @@ # Interface: RichTextEmoji -Defined in: [block-kit/block-elements.ts:879](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L879) +Defined in: [block-kit/block-elements.ts:893](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L893) ## Description @@ -20,7 +20,7 @@ An emoji element for use in a rich text message. name: string; ``` -Defined in: [block-kit/block-elements.ts:887](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L887) +Defined in: [block-kit/block-elements.ts:901](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L901) #### Description @@ -102,7 +102,7 @@ A limited style object for styling rich text `text` elements. type: "emoji"; ``` -Defined in: [block-kit/block-elements.ts:883](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L883) +Defined in: [block-kit/block-elements.ts:897](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L897) #### Description @@ -116,7 +116,7 @@ The type of element. In this case `type` is always `emoji`. optional unicode?: string; ``` -Defined in: [block-kit/block-elements.ts:891](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L891) +Defined in: [block-kit/block-elements.ts:905](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L905) #### Description @@ -130,7 +130,7 @@ Lowercase hexadecimal Unicode representation of a standard emoji (not for use wi optional url?: string; ``` -Defined in: [block-kit/block-elements.ts:895](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L895) +Defined in: [block-kit/block-elements.ts:909](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L909) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextInput.md b/docs/english/reference/types/interfaces/RichTextInput.md index 252e9f796..b922cea41 100644 --- a/docs/english/reference/types/interfaces/RichTextInput.md +++ b/docs/english/reference/types/interfaces/RichTextInput.md @@ -2,7 +2,7 @@ # Interface: RichTextInput -Defined in: [block-kit/block-elements.ts:1060](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1060) +Defined in: [block-kit/block-elements.ts:1074](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1074) ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_value?: RichTextBlock; ``` -Defined in: [block-kit/block-elements.ts:1068](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1068) +Defined in: [block-kit/block-elements.ts:1082](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1082) #### Description @@ -97,7 +97,7 @@ Initial contents of the input when it is loaded. optional max_lines?: number; ``` -Defined in: [block-kit/block-elements.ts:1077](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1077) +Defined in: [block-kit/block-elements.ts:1091](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1091) #### Description @@ -112,7 +112,7 @@ Defaults to `8` when not specified. optional min_lines?: number; ``` -Defined in: [block-kit/block-elements.ts:1072](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1072) +Defined in: [block-kit/block-elements.ts:1086](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1086) #### Description @@ -145,7 +145,7 @@ length for the `text` field in this object is 150 characters. type: "rich_text_input"; ``` -Defined in: [block-kit/block-elements.ts:1064](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1064) +Defined in: [block-kit/block-elements.ts:1078](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1078) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextLink.md b/docs/english/reference/types/interfaces/RichTextLink.md index 120122682..7d1fc9405 100644 --- a/docs/english/reference/types/interfaces/RichTextLink.md +++ b/docs/english/reference/types/interfaces/RichTextLink.md @@ -2,7 +2,7 @@ # Interface: RichTextLink -Defined in: [block-kit/block-elements.ts:901](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L901) +Defined in: [block-kit/block-elements.ts:915](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L915) ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. optional text?: string; ``` -Defined in: [block-kit/block-elements.ts:909](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L909) +Defined in: [block-kit/block-elements.ts:923](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L923) #### Description @@ -102,7 +102,7 @@ The text to link. type: "link"; ``` -Defined in: [block-kit/block-elements.ts:905](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L905) +Defined in: [block-kit/block-elements.ts:919](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L919) #### Description @@ -116,7 +116,7 @@ The type of element. In this case `type` is always `link`. optional unsafe?: boolean; ``` -Defined in: [block-kit/block-elements.ts:913](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L913) +Defined in: [block-kit/block-elements.ts:927](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L927) #### Description @@ -130,7 +130,7 @@ TODO: ? url: string; ``` -Defined in: [block-kit/block-elements.ts:917](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L917) +Defined in: [block-kit/block-elements.ts:931](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L931) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextList.md b/docs/english/reference/types/interfaces/RichTextList.md index 11e9e6eb1..704b873a2 100644 --- a/docs/english/reference/types/interfaces/RichTextList.md +++ b/docs/english/reference/types/interfaces/RichTextList.md @@ -2,7 +2,7 @@ # Interface: RichTextList -Defined in: [block-kit/block-elements.ts:1005](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1005) +Defined in: [block-kit/block-elements.ts:1019](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1019) ## Description @@ -39,7 +39,7 @@ while `1` renders a border. elements: RichTextSection[]; ``` -Defined in: [block-kit/block-elements.ts:1013](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1013) +Defined in: [block-kit/block-elements.ts:1027](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1027) #### Description @@ -53,7 +53,7 @@ An array of [RichTextSection](RichTextSection.md) elements comprising each list optional indent?: number; ``` -Defined in: [block-kit/block-elements.ts:1023](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1023) +Defined in: [block-kit/block-elements.ts:1037](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1037) #### Description @@ -68,7 +68,7 @@ or characters rendered as the list points. Also affected by the `style` property style: "bullet" | "ordered"; ``` -Defined in: [block-kit/block-elements.ts:1018](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1018) +Defined in: [block-kit/block-elements.ts:1032](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1032) #### Description @@ -83,7 +83,7 @@ The type of list. Can be either `bullet` (the list points are all rendered the s type: "rich_text_list"; ``` -Defined in: [block-kit/block-elements.ts:1009](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1009) +Defined in: [block-kit/block-elements.ts:1023](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1023) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextPreformatted.md b/docs/english/reference/types/interfaces/RichTextPreformatted.md index c4749f21f..290b13845 100644 --- a/docs/english/reference/types/interfaces/RichTextPreformatted.md +++ b/docs/english/reference/types/interfaces/RichTextPreformatted.md @@ -2,7 +2,7 @@ # Interface: RichTextPreformatted -Defined in: [block-kit/block-elements.ts:1043](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1043) +Defined in: [block-kit/block-elements.ts:1057](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1057) ## Description @@ -39,7 +39,7 @@ while `1` renders a border. elements: (RichTextLink | RichTextText)[]; ``` -Defined in: [block-kit/block-elements.ts:1051](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1051) +Defined in: [block-kit/block-elements.ts:1065](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1065) #### Description @@ -53,7 +53,7 @@ An array of either [RichTextLink](RichTextLink.md) or [RichTextText](RichTextTex type: "rich_text_preformatted"; ``` -Defined in: [block-kit/block-elements.ts:1047](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1047) +Defined in: [block-kit/block-elements.ts:1061](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1061) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextQuote.md b/docs/english/reference/types/interfaces/RichTextQuote.md index c82fb45aa..d5ed9f389 100644 --- a/docs/english/reference/types/interfaces/RichTextQuote.md +++ b/docs/english/reference/types/interfaces/RichTextQuote.md @@ -2,7 +2,7 @@ # Interface: RichTextQuote -Defined in: [block-kit/block-elements.ts:1029](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1029) +Defined in: [block-kit/block-elements.ts:1043](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1043) ## Description @@ -39,7 +39,7 @@ while `1` renders a border. elements: RichTextElement[]; ``` -Defined in: [block-kit/block-elements.ts:1037](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1037) +Defined in: [block-kit/block-elements.ts:1051](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1051) #### Description @@ -53,7 +53,7 @@ An array of [RichTextElement](../type-aliases/RichTextElement.md) comprising the type: "rich_text_quote"; ``` -Defined in: [block-kit/block-elements.ts:1033](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1033) +Defined in: [block-kit/block-elements.ts:1047](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1047) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextSection.md b/docs/english/reference/types/interfaces/RichTextSection.md index 66fc537b4..1f7a407e6 100644 --- a/docs/english/reference/types/interfaces/RichTextSection.md +++ b/docs/english/reference/types/interfaces/RichTextSection.md @@ -2,7 +2,7 @@ # Interface: RichTextSection -Defined in: [block-kit/block-elements.ts:994](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L994) +Defined in: [block-kit/block-elements.ts:1008](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1008) ## Description @@ -16,7 +16,7 @@ A section block within a rich text field. elements: RichTextElement[]; ``` -Defined in: [block-kit/block-elements.ts:999](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L999) +Defined in: [block-kit/block-elements.ts:1013](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1013) *** @@ -26,7 +26,7 @@ Defined in: [block-kit/block-elements.ts:999](https://github.com/slackapi/node-s type: "rich_text_section"; ``` -Defined in: [block-kit/block-elements.ts:998](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L998) +Defined in: [block-kit/block-elements.ts:1012](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L1012) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextTeamMention.md b/docs/english/reference/types/interfaces/RichTextTeamMention.md index 6d71ca35d..4a9aa93c0 100644 --- a/docs/english/reference/types/interfaces/RichTextTeamMention.md +++ b/docs/english/reference/types/interfaces/RichTextTeamMention.md @@ -2,7 +2,7 @@ # Interface: RichTextTeamMention -Defined in: [block-kit/block-elements.ts:923](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L923) +Defined in: [block-kit/block-elements.ts:937](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L937) ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. team_id: string; ``` -Defined in: [block-kit/block-elements.ts:931](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L931) +Defined in: [block-kit/block-elements.ts:945](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L945) #### Description @@ -102,7 +102,7 @@ The encoded team ID, e.g. T1234ABCD. type: "team"; ``` -Defined in: [block-kit/block-elements.ts:927](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L927) +Defined in: [block-kit/block-elements.ts:941](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L941) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextText.md b/docs/english/reference/types/interfaces/RichTextText.md index ea4fce2a4..5316822d6 100644 --- a/docs/english/reference/types/interfaces/RichTextText.md +++ b/docs/english/reference/types/interfaces/RichTextText.md @@ -2,7 +2,7 @@ # Interface: RichTextText -Defined in: [block-kit/block-elements.ts:937](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L937) +Defined in: [block-kit/block-elements.ts:951](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L951) ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. text: string; ``` -Defined in: [block-kit/block-elements.ts:945](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L945) +Defined in: [block-kit/block-elements.ts:959](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L959) #### Description @@ -102,7 +102,7 @@ The text to render. type: "text"; ``` -Defined in: [block-kit/block-elements.ts:941](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L941) +Defined in: [block-kit/block-elements.ts:955](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L955) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextUserMention.md b/docs/english/reference/types/interfaces/RichTextUserMention.md index 2b72af771..8264e85b8 100644 --- a/docs/english/reference/types/interfaces/RichTextUserMention.md +++ b/docs/english/reference/types/interfaces/RichTextUserMention.md @@ -2,7 +2,7 @@ # Interface: RichTextUserMention -Defined in: [block-kit/block-elements.ts:951](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L951) +Defined in: [block-kit/block-elements.ts:965](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L965) ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. type: "user"; ``` -Defined in: [block-kit/block-elements.ts:955](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L955) +Defined in: [block-kit/block-elements.ts:969](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L969) #### Description @@ -102,7 +102,7 @@ The type of element. In this case `type` is always `user`. user_id: string; ``` -Defined in: [block-kit/block-elements.ts:959](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L959) +Defined in: [block-kit/block-elements.ts:973](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L973) #### Description diff --git a/docs/english/reference/types/interfaces/RichTextUsergroupMention.md b/docs/english/reference/types/interfaces/RichTextUsergroupMention.md index d7e5338f5..b951d3da8 100644 --- a/docs/english/reference/types/interfaces/RichTextUsergroupMention.md +++ b/docs/english/reference/types/interfaces/RichTextUsergroupMention.md @@ -2,7 +2,7 @@ # Interface: RichTextUsergroupMention -Defined in: [block-kit/block-elements.ts:965](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L965) +Defined in: [block-kit/block-elements.ts:979](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L979) ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. type: "usergroup"; ``` -Defined in: [block-kit/block-elements.ts:969](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L969) +Defined in: [block-kit/block-elements.ts:983](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L983) #### Description @@ -102,7 +102,7 @@ The type of element. In this case `type` is always `usergroup`. usergroup_id: string; ``` -Defined in: [block-kit/block-elements.ts:973](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L973) +Defined in: [block-kit/block-elements.ts:987](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L987) #### Description diff --git a/docs/english/reference/types/interfaces/SectionBlock.md b/docs/english/reference/types/interfaces/SectionBlock.md index c53080ce6..cb6f5fca0 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:514](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L514) +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 @@ -26,7 +26,7 @@ combination with text fields, or side-by-side with certain optional accessory?: SectionBlockAccessory; ``` -Defined in: [block-kit/blocks.ts:535](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L535) +Defined in: [block-kit/blocks.ts:601](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L601) #### 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:539](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L539) +Defined in: [block-kit/blocks.ts:605](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L605) 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:531](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L531) +Defined in: [block-kit/blocks.ts:597](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L597) #### 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:524](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L524) +Defined in: [block-kit/blocks.ts:590](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L590) #### Description @@ -107,7 +107,7 @@ is provided instead. type: "section"; ``` -Defined in: [block-kit/blocks.ts:518](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L518) +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/StaticSelect.md b/docs/english/reference/types/interfaces/StaticSelect.md index 252a0a2ef..d78bf73a7 100644 --- a/docs/english/reference/types/interfaces/StaticSelect.md +++ b/docs/english/reference/types/interfaces/StaticSelect.md @@ -2,7 +2,7 @@ # Interface: StaticSelect -Defined in: [block-kit/block-elements.ts:335](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L335) +Defined in: [block-kit/block-elements.ts:349](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L349) ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_option?: PlainTextOption; ``` -Defined in: [block-kit/block-elements.ts:345](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L345) +Defined in: [block-kit/block-elements.ts:359](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L359) #### Description @@ -98,7 +98,7 @@ This option will be selected when the menu initially loads. optional option_groups?: object[]; ``` -Defined in: [block-kit/block-elements.ts:360](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L360) +Defined in: [block-kit/block-elements.ts:374](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L374) #### label @@ -125,7 +125,7 @@ this field should not be. optional options?: PlainTextOption[]; ``` -Defined in: [block-kit/block-elements.ts:352](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L352) +Defined in: [block-kit/block-elements.ts:366](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L366) #### Description @@ -159,7 +159,7 @@ length for the `text` field in this object is 150 characters. type: "static_select"; ``` -Defined in: [block-kit/block-elements.ts:339](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L339) +Defined in: [block-kit/block-elements.ts:353](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L353) #### Description diff --git a/docs/english/reference/types/interfaces/TableBlock.md b/docs/english/reference/types/interfaces/TableBlock.md index 9c0bf08a9..7241a11ab 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:546](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L546) +Defined in: [block-kit/blocks.ts:612](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L612) ## 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:558](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L558) +Defined in: [block-kit/blocks.ts:624](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L624) #### Description @@ -63,7 +63,7 @@ rows: ( | RawNumberElement)[][]; ``` -Defined in: [block-kit/blocks.ts:554](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L554) +Defined in: [block-kit/blocks.ts:620](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L620) #### Description @@ -77,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:550](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L550) +Defined in: [block-kit/blocks.ts:616](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L616) #### Description diff --git a/docs/english/reference/types/interfaces/TaskCardBlock.md b/docs/english/reference/types/interfaces/TaskCardBlock.md index 4589d6c97..135251a95 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:580](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L580) +Defined in: [block-kit/blocks.ts:646](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L646) ## 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:599](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L599) +Defined in: [block-kit/blocks.ts:665](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L665) #### 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:604](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L604) +Defined in: [block-kit/blocks.ts:670](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L670) #### 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:609](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L609) +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 @@ -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:614](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L614) +Defined in: [block-kit/blocks.ts:680](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L680) #### 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:589](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L589) +Defined in: [block-kit/blocks.ts:655](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L655) #### Description @@ -116,7 +116,7 @@ ID for the task. title: string; ``` -Defined in: [block-kit/blocks.ts:594](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L594) +Defined in: [block-kit/blocks.ts:660](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L660) #### Description @@ -130,7 +130,7 @@ Title of the task in plain text. type: "task_card"; ``` -Defined in: [block-kit/blocks.ts:584](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L584) +Defined in: [block-kit/blocks.ts:650](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L650) #### Description diff --git a/docs/english/reference/types/interfaces/ThreadBroadcastMessageEvent.md b/docs/english/reference/types/interfaces/ThreadBroadcastMessageEvent.md index e8fafcbab..6d4ba0451 100644 --- a/docs/english/reference/types/interfaces/ThreadBroadcastMessageEvent.md +++ b/docs/english/reference/types/interfaces/ThreadBroadcastMessageEvent.md @@ -32,7 +32,7 @@ Defined in: [events/message.ts:282](https://github.com/slackapi/node-slack-sdk/b channel: string; ``` -Defined in: [events/message.ts:294](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L294) +Defined in: [events/message.ts:298](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L298) *** @@ -42,7 +42,7 @@ Defined in: [events/message.ts:294](https://github.com/slackapi/node-slack-sdk/b channel_type: ChannelTypes; ``` -Defined in: [events/message.ts:295](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L295) +Defined in: [events/message.ts:299](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L299) *** @@ -52,7 +52,17 @@ Defined in: [events/message.ts:295](https://github.com/slackapi/node-slack-sdk/b client_msg_id: string; ``` -Defined in: [events/message.ts:293](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L293) +Defined in: [events/message.ts:297](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L297) + +*** + +### display\_as\_bot? + +```ts +optional display_as_bot?: boolean; +``` + +Defined in: [events/message.ts:285](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L285) *** @@ -66,6 +76,26 @@ Defined in: [events/message.ts:279](https://github.com/slackapi/node-slack-sdk/b *** +### files? + +```ts +optional files?: File[]; +``` + +Defined in: [events/message.ts:283](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L283) + +*** + +### parent\_user\_id? + +```ts +optional parent_user_id?: string; +``` + +Defined in: [events/message.ts:287](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L287) + +*** + ### root ```ts @@ -74,7 +104,7 @@ root: | BotMessageEvent & object; ``` -Defined in: [events/message.ts:286](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L286) +Defined in: [events/message.ts:290](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L290) #### Type Declaration @@ -136,7 +166,7 @@ Defined in: [events/message.ts:280](https://github.com/slackapi/node-slack-sdk/b optional thread_ts?: string; ``` -Defined in: [events/message.ts:285](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L285) +Defined in: [events/message.ts:289](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L289) *** @@ -146,7 +176,7 @@ Defined in: [events/message.ts:285](https://github.com/slackapi/node-slack-sdk/b ts: string; ``` -Defined in: [events/message.ts:284](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L284) +Defined in: [events/message.ts:288](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L288) *** @@ -160,10 +190,20 @@ Defined in: [events/message.ts:277](https://github.com/slackapi/node-slack-sdk/b *** +### upload? + +```ts +optional upload?: boolean; +``` + +Defined in: [events/message.ts:284](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L284) + +*** + ### user ```ts user: string; ``` -Defined in: [events/message.ts:283](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L283) +Defined in: [events/message.ts:286](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/message.ts#L286) diff --git a/docs/english/reference/types/interfaces/Timepicker.md b/docs/english/reference/types/interfaces/Timepicker.md index 6dd8e5312..cbfbd83ee 100644 --- a/docs/english/reference/types/interfaces/Timepicker.md +++ b/docs/english/reference/types/interfaces/Timepicker.md @@ -2,7 +2,7 @@ # Interface: Timepicker -Defined in: [block-kit/block-elements.ts:671](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L671) +Defined in: [block-kit/block-elements.ts:685](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L685) ## Description @@ -84,7 +84,7 @@ Defaults to `false`. optional initial_time?: string; ``` -Defined in: [block-kit/block-elements.ts:681](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L681) +Defined in: [block-kit/block-elements.ts:695](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L695) #### Description @@ -119,7 +119,7 @@ length for the `text` field in this object is 150 characters. optional timezone?: string; ``` -Defined in: [block-kit/block-elements.ts:686](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L686) +Defined in: [block-kit/block-elements.ts:700](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L700) #### Description @@ -134,7 +134,7 @@ text underneath the time picker. It is also passed to the app upon certain inter type: "timepicker"; ``` -Defined in: [block-kit/block-elements.ts:675](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L675) +Defined in: [block-kit/block-elements.ts:689](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L689) #### Description diff --git a/docs/english/reference/types/interfaces/URLInput.md b/docs/english/reference/types/interfaces/URLInput.md index 978a3aaed..647ea8dad 100644 --- a/docs/english/reference/types/interfaces/URLInput.md +++ b/docs/english/reference/types/interfaces/URLInput.md @@ -2,7 +2,7 @@ # Interface: URLInput -Defined in: [block-kit/block-elements.ts:694](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L694) +Defined in: [block-kit/block-elements.ts:708](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L708) ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_value?: string; ``` -Defined in: [block-kit/block-elements.ts:702](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L702) +Defined in: [block-kit/block-elements.ts:716](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L716) #### Description @@ -115,7 +115,7 @@ length for the `text` field in this object is 150 characters. type: "url_text_input"; ``` -Defined in: [block-kit/block-elements.ts:698](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L698) +Defined in: [block-kit/block-elements.ts:712](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L712) #### Description diff --git a/docs/english/reference/types/interfaces/URLSourceElement.md b/docs/english/reference/types/interfaces/URLSourceElement.md index 5d8edaca7..806beecac 100644 --- a/docs/english/reference/types/interfaces/URLSourceElement.md +++ b/docs/english/reference/types/interfaces/URLSourceElement.md @@ -2,7 +2,7 @@ # Interface: URLSourceElement -Defined in: [block-kit/block-elements.ts:710](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L710) +Defined in: [block-kit/block-elements.ts:724](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L724) ## Description @@ -20,7 +20,7 @@ A URL source element that displays a URL source for referencing within a task ca text: string; ``` -Defined in: [block-kit/block-elements.ts:724](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L724) +Defined in: [block-kit/block-elements.ts:738](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L738) #### Description @@ -34,7 +34,7 @@ Display text for the URL. type: "url"; ``` -Defined in: [block-kit/block-elements.ts:714](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L714) +Defined in: [block-kit/block-elements.ts:728](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L728) #### Description @@ -48,7 +48,7 @@ The type of element. In this case `type` is always `url`. url: string; ``` -Defined in: [block-kit/block-elements.ts:719](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L719) +Defined in: [block-kit/block-elements.ts:733](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L733) #### Description diff --git a/docs/english/reference/types/interfaces/UserConnectionConnectEvent.md b/docs/english/reference/types/interfaces/UserConnectionConnectEvent.md new file mode 100644 index 000000000..09b375e5b --- /dev/null +++ b/docs/english/reference/types/interfaces/UserConnectionConnectEvent.md @@ -0,0 +1,55 @@ +[@slack/types](../index.md) / UserConnectionConnectEvent + +# Interface: UserConnectionConnectEvent + +Defined in: [events/user.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L87) + +## Properties + +### event\_ts + +```ts +event_ts: string; +``` + +Defined in: [events/user.ts:92](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L92) + +*** + +### subtype + +```ts +subtype: "connect"; +``` + +Defined in: [events/user.ts:89](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L89) + +*** + +### trigger\_id + +```ts +trigger_id: string; +``` + +Defined in: [events/user.ts:91](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L91) + +*** + +### type + +```ts +type: "user_connection"; +``` + +Defined in: [events/user.ts:88](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L88) + +*** + +### user + +```ts +user: string; +``` + +Defined in: [events/user.ts:90](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L90) diff --git a/docs/english/reference/types/interfaces/UserConnectionDisconnectEvent.md b/docs/english/reference/types/interfaces/UserConnectionDisconnectEvent.md new file mode 100644 index 000000000..6f43cd62b --- /dev/null +++ b/docs/english/reference/types/interfaces/UserConnectionDisconnectEvent.md @@ -0,0 +1,55 @@ +[@slack/types](../index.md) / UserConnectionDisconnectEvent + +# Interface: UserConnectionDisconnectEvent + +Defined in: [events/user.ts:95](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L95) + +## Properties + +### enterprise\_id? + +```ts +optional enterprise_id?: string; +``` + +Defined in: [events/user.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L99) + +*** + +### event\_ts + +```ts +event_ts: string; +``` + +Defined in: [events/user.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L100) + +*** + +### subtype + +```ts +subtype: "disconnect"; +``` + +Defined in: [events/user.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L97) + +*** + +### type + +```ts +type: "user_connection"; +``` + +Defined in: [events/user.ts:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L96) + +*** + +### user + +```ts +user: string; +``` + +Defined in: [events/user.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L98) diff --git a/docs/english/reference/types/interfaces/UserConnectionStatusRequestedEvent.md b/docs/english/reference/types/interfaces/UserConnectionStatusRequestedEvent.md new file mode 100644 index 000000000..d2d0e4fcf --- /dev/null +++ b/docs/english/reference/types/interfaces/UserConnectionStatusRequestedEvent.md @@ -0,0 +1,35 @@ +[@slack/types](../index.md) / UserConnectionStatusRequestedEvent + +# Interface: UserConnectionStatusRequestedEvent + +Defined in: [events/user.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L103) + +## Properties + +### event\_ts + +```ts +event_ts: string; +``` + +Defined in: [events/user.ts:106](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L106) + +*** + +### type + +```ts +type: "user_connection_status_requested"; +``` + +Defined in: [events/user.ts:104](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L104) + +*** + +### user + +```ts +user: string; +``` + +Defined in: [events/user.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L105) diff --git a/docs/english/reference/types/interfaces/UserHuddleChangedEvent.md b/docs/english/reference/types/interfaces/UserHuddleChangedEvent.md index 2e4584150..fac0e2af4 100644 --- a/docs/english/reference/types/interfaces/UserHuddleChangedEvent.md +++ b/docs/english/reference/types/interfaces/UserHuddleChangedEvent.md @@ -2,7 +2,7 @@ # Interface: UserHuddleChangedEvent -Defined in: [events/user.ts:85](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L85) +Defined in: [events/user.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L109) ## Properties @@ -12,7 +12,7 @@ Defined in: [events/user.ts:85](https://github.com/slackapi/node-slack-sdk/blob/ cache_ts: number; ``` -Defined in: [events/user.ts:164](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L164) +Defined in: [events/user.ts:188](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L188) *** @@ -22,7 +22,7 @@ Defined in: [events/user.ts:164](https://github.com/slackapi/node-slack-sdk/blob event_ts: string; ``` -Defined in: [events/user.ts:165](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L165) +Defined in: [events/user.ts:189](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L189) *** @@ -32,7 +32,7 @@ Defined in: [events/user.ts:165](https://github.com/slackapi/node-slack-sdk/blob type: "user_huddle_changed"; ``` -Defined in: [events/user.ts:86](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L86) +Defined in: [events/user.ts:110](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L110) *** @@ -42,7 +42,7 @@ Defined in: [events/user.ts:86](https://github.com/slackapi/node-slack-sdk/blob/ user: object; ``` -Defined in: [events/user.ts:87](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L87) +Defined in: [events/user.ts:111](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L111) #### color diff --git a/docs/english/reference/types/interfaces/UserProfileChangedEvent.md b/docs/english/reference/types/interfaces/UserProfileChangedEvent.md index 87ab359ef..66118ce75 100644 --- a/docs/english/reference/types/interfaces/UserProfileChangedEvent.md +++ b/docs/english/reference/types/interfaces/UserProfileChangedEvent.md @@ -2,7 +2,7 @@ # Interface: UserProfileChangedEvent -Defined in: [events/user.ts:168](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L168) +Defined in: [events/user.ts:192](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L192) ## Properties @@ -12,7 +12,7 @@ Defined in: [events/user.ts:168](https://github.com/slackapi/node-slack-sdk/blob cache_ts: number; ``` -Defined in: [events/user.ts:246](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L246) +Defined in: [events/user.ts:270](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L270) *** @@ -22,7 +22,7 @@ Defined in: [events/user.ts:246](https://github.com/slackapi/node-slack-sdk/blob event_ts: string; ``` -Defined in: [events/user.ts:247](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L247) +Defined in: [events/user.ts:271](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L271) *** @@ -32,7 +32,7 @@ Defined in: [events/user.ts:247](https://github.com/slackapi/node-slack-sdk/blob type: "user_profile_changed"; ``` -Defined in: [events/user.ts:169](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L169) +Defined in: [events/user.ts:193](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L193) *** @@ -42,7 +42,7 @@ Defined in: [events/user.ts:169](https://github.com/slackapi/node-slack-sdk/blob user: object; ``` -Defined in: [events/user.ts:170](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L170) +Defined in: [events/user.ts:194](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L194) #### color diff --git a/docs/english/reference/types/interfaces/UserStatusChangedEvent.md b/docs/english/reference/types/interfaces/UserStatusChangedEvent.md index cea083b78..bd8b37691 100644 --- a/docs/english/reference/types/interfaces/UserStatusChangedEvent.md +++ b/docs/english/reference/types/interfaces/UserStatusChangedEvent.md @@ -2,7 +2,7 @@ # Interface: UserStatusChangedEvent -Defined in: [events/user.ts:250](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L250) +Defined in: [events/user.ts:274](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L274) ## Properties @@ -12,7 +12,7 @@ Defined in: [events/user.ts:250](https://github.com/slackapi/node-slack-sdk/blob cache_ts: number; ``` -Defined in: [events/user.ts:326](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L326) +Defined in: [events/user.ts:350](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L350) *** @@ -22,7 +22,7 @@ Defined in: [events/user.ts:326](https://github.com/slackapi/node-slack-sdk/blob event_ts: string; ``` -Defined in: [events/user.ts:327](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L327) +Defined in: [events/user.ts:351](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L351) *** @@ -32,7 +32,7 @@ Defined in: [events/user.ts:327](https://github.com/slackapi/node-slack-sdk/blob type: "user_status_changed"; ``` -Defined in: [events/user.ts:251](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L251) +Defined in: [events/user.ts:275](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L275) *** @@ -42,7 +42,7 @@ Defined in: [events/user.ts:251](https://github.com/slackapi/node-slack-sdk/blob user: object; ``` -Defined in: [events/user.ts:252](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L252) +Defined in: [events/user.ts:276](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L276) #### color diff --git a/docs/english/reference/types/interfaces/UsersSelect.md b/docs/english/reference/types/interfaces/UsersSelect.md index ede3fbfb4..077b7f8ae 100644 --- a/docs/english/reference/types/interfaces/UsersSelect.md +++ b/docs/english/reference/types/interfaces/UsersSelect.md @@ -2,7 +2,7 @@ # Interface: UsersSelect -Defined in: [block-kit/block-elements.ts:301](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L301) +Defined in: [block-kit/block-elements.ts:315](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L315) ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_user?: string; ``` -Defined in: [block-kit/block-elements.ts:309](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L309) +Defined in: [block-kit/block-elements.ts:323](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L323) #### Description @@ -116,7 +116,7 @@ length for the `text` field in this object is 150 characters. type: "users_select"; ``` -Defined in: [block-kit/block-elements.ts:305](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L305) +Defined in: [block-kit/block-elements.ts:319](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L319) #### Description diff --git a/docs/english/reference/types/interfaces/VideoBlock.md b/docs/english/reference/types/interfaces/VideoBlock.md index 02e1b85fa..e27ba4f28 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:644](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L644) +Defined in: [block-kit/blocks.ts:710](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L710) ## 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:662](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L662) +Defined in: [block-kit/blocks.ts:728](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L728) #### Description @@ -40,7 +40,7 @@ A tooltip for the video. Required for accessibility. optional author_name?: string; ``` -Defined in: [block-kit/blocks.ts:675](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L675) +Defined in: [block-kit/blocks.ts:741](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L741) #### 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:687](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L687) +Defined in: [block-kit/blocks.ts:753](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L753) #### 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:683](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L683) +Defined in: [block-kit/blocks.ts:749](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L749) #### Description @@ -104,7 +104,7 @@ Icon for the video provider, e.g. YouTube icon. optional provider_name?: string; ``` -Defined in: [block-kit/blocks.ts:679](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L679) +Defined in: [block-kit/blocks.ts:745](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L745) #### 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:658](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L658) +Defined in: [block-kit/blocks.ts:724](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L724) #### Description @@ -132,7 +132,7 @@ The thumbnail image URL. title: PlainTextElement; ``` -Defined in: [block-kit/blocks.ts:666](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L666) +Defined in: [block-kit/blocks.ts:732](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L732) #### 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:671](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L671) +Defined in: [block-kit/blocks.ts:737](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L737) #### Description @@ -161,7 +161,7 @@ Must go to an HTTPS URL. type: "video"; ``` -Defined in: [block-kit/blocks.ts:648](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L648) +Defined in: [block-kit/blocks.ts:714](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L714) #### 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:654](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L654) +Defined in: [block-kit/blocks.ts:720](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L720) #### Description diff --git a/docs/english/reference/types/interfaces/WorkflowButton.md b/docs/english/reference/types/interfaces/WorkflowButton.md index d08a5c8f1..49f0c7604 100644 --- a/docs/english/reference/types/interfaces/WorkflowButton.md +++ b/docs/english/reference/types/interfaces/WorkflowButton.md @@ -2,7 +2,7 @@ # Interface: WorkflowButton -Defined in: [block-kit/block-elements.ts:731](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L731) +Defined in: [block-kit/block-elements.ts:745](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L745) ## Description @@ -24,7 +24,7 @@ Allows users to run a [link trigger](https://docs.slack.dev/tools/deno-slack-sdk optional accessibility_label?: string; ``` -Defined in: [block-kit/block-elements.ts:785](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L785) +Defined in: [block-kit/block-elements.ts:799](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L799) #### Description @@ -76,7 +76,7 @@ with. optional style?: ColorScheme; ``` -Defined in: [block-kit/block-elements.ts:780](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L780) +Defined in: [block-kit/block-elements.ts:794](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L794) #### Description @@ -95,7 +95,7 @@ If you don't include this field, the default button style will be used. text: PlainTextElement; ``` -Defined in: [block-kit/block-elements.ts:740](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L740) +Defined in: [block-kit/block-elements.ts:754](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L754) #### Description @@ -110,7 +110,7 @@ Maximum length for the `text` in this field is 75 characters. type: "workflow_button"; ``` -Defined in: [block-kit/block-elements.ts:735](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L735) +Defined in: [block-kit/block-elements.ts:749](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L749) #### Description @@ -128,7 +128,7 @@ The type of element. In this case `type` is always `workflow_button`. workflow: object; ``` -Defined in: [block-kit/block-elements.ts:744](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L744) +Defined in: [block-kit/block-elements.ts:758](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L758) #### trigger diff --git a/docs/english/reference/types/type-aliases/ActionsBlockElement.md b/docs/english/reference/types/type-aliases/ActionsBlockElement.md index 754e99830..fabb35582 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:89](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L89) +Defined in: [block-kit/blocks.ts:90](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L90) 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 f41e788d2..8ca198159 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:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L83) +Defined in: [block-kit/blocks.ts:84](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L84) 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 e27fe23c3..4cd4abb37 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:277](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L277) +Defined in: [block-kit/blocks.ts:343](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L343) 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 6cfbaf809..02fcb1a39 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:256](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L256) +Defined in: [block-kit/blocks.ts:322](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L322) 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/ImageBlock.md b/docs/english/reference/types/type-aliases/ImageBlock.md index 56bd3e762..cf6f8e114 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:376](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L376) +Defined in: [block-kit/blocks.ts:442](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L442) ## Type Declaration diff --git a/docs/english/reference/types/type-aliases/ImageElement.md b/docs/english/reference/types/type-aliases/ImageElement.md index bd2a2e071..28f8e87fb 100644 --- a/docs/english/reference/types/type-aliases/ImageElement.md +++ b/docs/english/reference/types/type-aliases/ImageElement.md @@ -8,7 +8,7 @@ type ImageElement = object & | SlackFileImageObject; ``` -Defined in: [block-kit/block-elements.ts:251](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L251) +Defined in: [block-kit/block-elements.ts:265](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L265) ## Type Declaration diff --git a/docs/english/reference/types/type-aliases/InputBlockElement.md b/docs/english/reference/types/type-aliases/InputBlockElement.md index 61b1f7717..a5134c506 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:398](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L398) +Defined in: [block-kit/blocks.ts:464](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L464) 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 19b77a8cd..d13cd1cf5 100644 --- a/docs/english/reference/types/type-aliases/KnownBlock.md +++ b/docs/english/reference/types/type-aliases/KnownBlock.md @@ -6,6 +6,7 @@ type KnownBlock = | ActionsBlock | AlertBlock + | AuthProviderBlock | CardBlock | CarouselBlock | ContainerBlock diff --git a/docs/english/reference/types/type-aliases/MultiSelect.md b/docs/english/reference/types/type-aliases/MultiSelect.md index ef5c01c8d..8de91d672 100644 --- a/docs/english/reference/types/type-aliases/MultiSelect.md +++ b/docs/english/reference/types/type-aliases/MultiSelect.md @@ -11,7 +11,7 @@ type MultiSelect = | MultiExternalSelect; ``` -Defined in: [block-kit/block-elements.ts:288](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L288) +Defined in: [block-kit/block-elements.ts:302](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L302) ## Description diff --git a/docs/english/reference/types/type-aliases/RichTextBlockElement.md b/docs/english/reference/types/type-aliases/RichTextBlockElement.md index ee5fb83d5..66b0be2c4 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:471](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L471) +Defined in: [block-kit/blocks.ts:537](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L537) 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/RichTextElement.md b/docs/english/reference/types/type-aliases/RichTextElement.md index e57010d22..6e25bac93 100644 --- a/docs/english/reference/types/type-aliases/RichTextElement.md +++ b/docs/english/reference/types/type-aliases/RichTextElement.md @@ -16,7 +16,7 @@ type RichTextElement = | RichTextUsergroupMention; ``` -Defined in: [block-kit/block-elements.ts:979](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L979) +Defined in: [block-kit/block-elements.ts:993](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L993) ## Description diff --git a/docs/english/reference/types/type-aliases/SectionBlockAccessory.md b/docs/english/reference/types/type-aliases/SectionBlockAccessory.md index 10e3dad18..347d4ec28 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:494](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L494) +Defined in: [block-kit/blocks.ts:560](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L560) 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/Select.md b/docs/english/reference/types/type-aliases/Select.md index e851be5ab..0cb93ce18 100644 --- a/docs/english/reference/types/type-aliases/Select.md +++ b/docs/english/reference/types/type-aliases/Select.md @@ -11,7 +11,7 @@ type Select = | ExternalSelect; ``` -Defined in: [block-kit/block-elements.ts:276](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L276) +Defined in: [block-kit/block-elements.ts:290](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/block-elements.ts#L290) ## Description diff --git a/docs/english/reference/types/type-aliases/SlackEvent.md b/docs/english/reference/types/type-aliases/SlackEvent.md index 416cf3400..30816c47b 100644 --- a/docs/english/reference/types/type-aliases/SlackEvent.md +++ b/docs/english/reference/types/type-aliases/SlackEvent.md @@ -84,6 +84,8 @@ type SlackEvent = | TeamRenameEvent | TokensRevokedEvent | UserChangeEvent + | UserConnectionEvent + | UserConnectionStatusRequestedEvent | UserHuddleChangedEvent | UserProfileChangedEvent | UserStatusChangedEvent @@ -94,7 +96,7 @@ type SlackEvent = | WorkflowStepExecuteEvent; ``` -Defined in: [events/index.ts:125](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/index.ts#L125) +Defined in: [events/index.ts:132](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/index.ts#L132) All known event types in Slack's Events API Please refer to https://docs.slack.dev/reference/events for more details diff --git a/docs/english/reference/types/type-aliases/UserConnectionEvent.md b/docs/english/reference/types/type-aliases/UserConnectionEvent.md new file mode 100644 index 000000000..168f22ac1 --- /dev/null +++ b/docs/english/reference/types/type-aliases/UserConnectionEvent.md @@ -0,0 +1,11 @@ +[@slack/types](../index.md) / UserConnectionEvent + +# Type Alias: UserConnectionEvent + +```ts +type UserConnectionEvent = + | UserConnectionConnectEvent + | UserConnectionDisconnectEvent; +``` + +Defined in: [events/user.ts:85](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L85) diff --git a/docs/english/reference/web-api/classes/Methods.md b/docs/english/reference/web-api/classes/Methods.md index f34063e2b..abac3a2b4 100644 --- a/docs/english/reference/web-api/classes/Methods.md +++ b/docs/english/reference/web-api/classes/Methods.md @@ -2,7 +2,7 @@ # Abstract Class: Methods -Defined in: [packages/web-api/src/methods.ts:615](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L615) +Defined in: [packages/web-api/src/methods.ts:621](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L621) A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the `apiCall` class method. @@ -23,7 +23,7 @@ A class that defines all Web API methods, their arguments type, their response t readonly admin: object; ``` -Defined in: [packages/web-api/src/methods.ts:628](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L628) +Defined in: [packages/web-api/src/methods.ts:634](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L634) #### analytics @@ -1572,7 +1572,7 @@ Unpublish workflows within the team or enterprise. readonly agents: object; ``` -Defined in: [packages/web-api/src/methods.ts:1401](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1401) +Defined in: [packages/web-api/src/methods.ts:1407](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1407) #### conversations @@ -1748,7 +1748,7 @@ Set an agent session's lifecycle status, creating the session if needed. readonly api: object; ``` -Defined in: [packages/web-api/src/methods.ts:1493](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1493) +Defined in: [packages/web-api/src/methods.ts:1499](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1499) #### test @@ -1772,7 +1772,7 @@ Checks API calling code. readonly apps: object; ``` -Defined in: [packages/web-api/src/methods.ts:1530](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1530) +Defined in: [packages/web-api/src/methods.ts:1536](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1536) #### connections @@ -1924,6 +1924,34 @@ user: object; connection: object; ``` +##### user.connection.bulkUpdate + +```ts +bulkUpdate: MethodWithRequiredArgument; +``` + +###### Description + +Updates the connection status between an app and many users in one call, for backfilling an existing user base. + +###### See + +[\`apps.user.connection.bulkUpdate\` API reference](https://docs.slack.dev/reference/methods/apps.user.connection.bulkUpdate). + +##### user.connection.requestAuth + +```ts +requestAuth: MethodWithRequiredArgument; +``` + +###### Description + +Opens or updates a standardized authentication modal for the calling app. + +###### See + +[\`apps.user.connection.requestAuth\` API reference](https://docs.slack.dev/reference/methods/apps.user.connection.requestAuth). + ##### user.connection.update ```ts @@ -1946,7 +1974,7 @@ Updates the connection status between a user and an app. readonly assistant: object; ``` -Defined in: [packages/web-api/src/methods.ts:1501](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1501) +Defined in: [packages/web-api/src/methods.ts:1507](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1507) #### threads @@ -2004,7 +2032,7 @@ Set the title of the thread. This is shown when a user views the app's chat hist readonly auth: object; ``` -Defined in: [packages/web-api/src/methods.ts:1604](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1604) +Defined in: [packages/web-api/src/methods.ts:1626](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1626) #### revoke @@ -2054,7 +2082,7 @@ test: Method; readonly blocks: object; ``` -Defined in: [packages/web-api/src/methods.ts:1643](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1643) +Defined in: [packages/web-api/src/methods.ts:1665](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1665) #### validate @@ -2078,7 +2106,7 @@ Validates blocks, messages, and views Block Kit JSON payloads. readonly bookmarks: object; ``` -Defined in: [packages/web-api/src/methods.ts:1620](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1620) +Defined in: [packages/web-api/src/methods.ts:1642](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1642) #### add @@ -2144,7 +2172,7 @@ Remove bookmark from a channel. readonly bots: object; ``` -Defined in: [packages/web-api/src/methods.ts:1651](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1651) +Defined in: [packages/web-api/src/methods.ts:1673](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1673) #### info @@ -2168,7 +2196,7 @@ Gets information about a bot user. readonly calls: object; ``` -Defined in: [packages/web-api/src/methods.ts:1659](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1659) +Defined in: [packages/web-api/src/methods.ts:1681](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1681) #### add @@ -2260,7 +2288,7 @@ Updates information about a Call. readonly canvases: object; ``` -Defined in: [packages/web-api/src/methods.ts:1693](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1693) +Defined in: [packages/web-api/src/methods.ts:1715](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1715) #### access @@ -2338,6 +2366,20 @@ Update an existing canvas. [\`canvases.edit\` API reference](https://docs.slack.dev/reference/methods/canvases.edit). +#### getContent + +```ts +getContent: MethodWithRequiredArgument; +``` + +##### Description + +Get the content of a canvas as markdown (default) or HTML. + +##### See + +[\`canvases.getContent\` API reference](https://docs.slack.dev/reference/methods/canvases.getContent). + #### sections ```ts @@ -2366,7 +2408,7 @@ Find sections matching the provided criteria. readonly chat: object; ``` -Defined in: [packages/web-api/src/methods.ts:1733](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1733) +Defined in: [packages/web-api/src/methods.ts:1760](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1760) #### appendStream @@ -2564,7 +2606,7 @@ Updates a message. readonly conversations: object; ``` -Defined in: [packages/web-api/src/methods.ts:1812](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1812) +Defined in: [packages/web-api/src/methods.ts:1839](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1839) #### acceptSharedInvite @@ -2986,7 +3028,7 @@ Reverses conversation archival. readonly dialog: object; ``` -Defined in: [packages/web-api/src/methods.ts:2005](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2005) +Defined in: [packages/web-api/src/methods.ts:2032](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2032) #### open @@ -3010,7 +3052,7 @@ Open a dialog with a user. readonly dnd: object; ``` -Defined in: [packages/web-api/src/methods.ts:2013](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2013) +Defined in: [packages/web-api/src/methods.ts:2040](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2040) #### endDnd @@ -3090,7 +3132,7 @@ Retrieves the Do Not Disturb status for up to 50 users on a team. readonly emoji: object; ``` -Defined in: [packages/web-api/src/methods.ts:2041](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2041) +Defined in: [packages/web-api/src/methods.ts:2068](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2068) #### list @@ -3114,7 +3156,7 @@ Lists custom emoji for a team. readonly entity: object; ``` -Defined in: [packages/web-api/src/methods.ts:2049](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2049) +Defined in: [packages/web-api/src/methods.ts:2076](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2076) #### presentDetails @@ -3138,7 +3180,7 @@ Provide information about the entity to be displayed in the flexpane. readonly files: object; ``` -Defined in: [packages/web-api/src/methods.ts:2060](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2060) +Defined in: [packages/web-api/src/methods.ts:2087](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2087) #### comments @@ -3360,7 +3402,7 @@ Custom method to support a new way of uploading files to Slack. Supports a single file upload Supply: - (required) single file or content -- (optional) channel, alt_text, snippet_type, +- (optional) channel, alt_txt, snippet_type, Supports multiple file uploads Supply: - multiple upload_files @@ -3379,7 +3421,7 @@ as multiple file uploads property. readonly functions: object; ``` -Defined in: [packages/web-api/src/methods.ts:2163](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2163) +Defined in: [packages/web-api/src/methods.ts:2190](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2190) #### completeError @@ -3417,7 +3459,7 @@ Signal the successful completion of a Custom Function. readonly migration: object; ``` -Defined in: [packages/web-api/src/methods.ts:2182](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2182) +Defined in: [packages/web-api/src/methods.ts:2209](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2209) #### exchange @@ -3441,7 +3483,7 @@ For Enterprise Grid workspaces, map local user IDs to global user IDs. readonly oauth: object; ``` -Defined in: [packages/web-api/src/methods.ts:2190](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2190) +Defined in: [packages/web-api/src/methods.ts:2217](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2217) #### ~~access~~ @@ -3503,7 +3545,7 @@ Exchanges a legacy access token for a new expiring access token and refresh toke readonly openid: object; ``` -Defined in: [packages/web-api/src/methods.ts:2211](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2211) +Defined in: [packages/web-api/src/methods.ts:2238](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2238) #### connect @@ -3547,7 +3589,7 @@ Get the identity of a user who has authorized [Sign in with Slack](https://docs. readonly pins: object; ``` -Defined in: [packages/web-api/src/methods.ts:2229](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2229) +Defined in: [packages/web-api/src/methods.ts:2256](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2256) #### add @@ -3599,7 +3641,7 @@ Un-pins an item from a channel. readonly reactions: object; ``` -Defined in: [packages/web-api/src/methods.ts:2247](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2247) +Defined in: [packages/web-api/src/methods.ts:2274](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2274) #### add @@ -3665,7 +3707,7 @@ Removes a reaction from an item. readonly reminders: object; ``` -Defined in: [packages/web-api/src/methods.ts:2272](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2272) +Defined in: [packages/web-api/src/methods.ts:2299](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2299) #### add @@ -3745,7 +3787,7 @@ Lists all reminders created by or for a given user. readonly rtm: object; ``` -Defined in: [packages/web-api/src/methods.ts:2300](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2300) +Defined in: [packages/web-api/src/methods.ts:2327](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2327) #### connect @@ -3769,7 +3811,7 @@ Starts a Real Time Messaging session. readonly search: object; ``` -Defined in: [packages/web-api/src/methods.ts:2308](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2308) +Defined in: [packages/web-api/src/methods.ts:2335](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2335) #### all @@ -3821,7 +3863,7 @@ Searches for messages matching a query. readonly slackLists: object; ``` -Defined in: [packages/web-api/src/methods.ts:2326](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2326) +Defined in: [packages/web-api/src/methods.ts:2353](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2353) #### access @@ -4017,7 +4059,7 @@ Update a list. readonly stars: object; ``` -Defined in: [packages/web-api/src/methods.ts:2636](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2636) +Defined in: [packages/web-api/src/methods.ts:2663](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2663) #### ~~add~~ @@ -4084,7 +4126,7 @@ See [our post on stars and the Later list](https://docs.slack.dev/changelog/2023 readonly team: object; ``` -Defined in: [packages/web-api/src/methods.ts:2413](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2413) +Defined in: [packages/web-api/src/methods.ts:2440](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2440) #### accessLogs @@ -4244,7 +4286,7 @@ Retrieve a team's profile. readonly tooling: object; ``` -Defined in: [packages/web-api/src/methods.ts:2484](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2484) +Defined in: [packages/web-api/src/methods.ts:2511](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2511) #### tokens @@ -4274,7 +4316,7 @@ Exchanges a refresh token for a new app configuration token. readonly usergroups: object; ``` -Defined in: [packages/web-api/src/methods.ts:2494](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2494) +Defined in: [packages/web-api/src/methods.ts:2521](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2521) #### create @@ -4388,7 +4430,7 @@ Update the list of users in a User Group. readonly users: object; ``` -Defined in: [packages/web-api/src/methods.ts:2537](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2537) +Defined in: [packages/web-api/src/methods.ts:2564](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2564) #### conversations @@ -4578,7 +4620,7 @@ Manually sets user presence. readonly views: object; ``` -Defined in: [packages/web-api/src/methods.ts:2607](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2607) +Defined in: [packages/web-api/src/methods.ts:2634](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2634) #### open @@ -4644,7 +4686,7 @@ Update an existing view. readonly workflows: object; ``` -Defined in: [packages/web-api/src/methods.ts:2660](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2660) +Defined in: [packages/web-api/src/methods.ts:2687](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2687) #### featured @@ -4776,7 +4818,7 @@ EventEmitter.addListener abstract apiCall(method, options?): Promise; ``` -Defined in: [packages/web-api/src/methods.ts:625](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L625) +Defined in: [packages/web-api/src/methods.ts:631](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L631) #### Parameters @@ -4861,7 +4903,7 @@ EventEmitter.eventNames abstract filesUploadV2(options): Promise; ``` -Defined in: [packages/web-api/src/methods.ts:626](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L626) +Defined in: [packages/web-api/src/methods.ts:632](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L632) #### Parameters diff --git a/docs/english/reference/web-api/classes/WebClient.md b/docs/english/reference/web-api/classes/WebClient.md index 88e351663..20ae11227 100644 --- a/docs/english/reference/web-api/classes/WebClient.md +++ b/docs/english/reference/web-api/classes/WebClient.md @@ -55,7 +55,7 @@ Methods.constructor readonly admin: object; ``` -Defined in: [packages/web-api/src/methods.ts:628](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L628) +Defined in: [packages/web-api/src/methods.ts:634](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L634) #### analytics @@ -1608,7 +1608,7 @@ Unpublish workflows within the team or enterprise. readonly agents: object; ``` -Defined in: [packages/web-api/src/methods.ts:1401](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1401) +Defined in: [packages/web-api/src/methods.ts:1407](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1407) #### conversations @@ -1788,7 +1788,7 @@ Set an agent session's lifecycle status, creating the session if needed. readonly api: object; ``` -Defined in: [packages/web-api/src/methods.ts:1493](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1493) +Defined in: [packages/web-api/src/methods.ts:1499](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1499) #### test @@ -1816,7 +1816,7 @@ Checks API calling code. readonly apps: object; ``` -Defined in: [packages/web-api/src/methods.ts:1530](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1530) +Defined in: [packages/web-api/src/methods.ts:1536](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1536) #### connections @@ -1968,6 +1968,34 @@ user: object; connection: object; ``` +##### user.connection.bulkUpdate + +```ts +bulkUpdate: MethodWithRequiredArgument; +``` + +###### Description + +Updates the connection status between an app and many users in one call, for backfilling an existing user base. + +###### See + +[\`apps.user.connection.bulkUpdate\` API reference](https://docs.slack.dev/reference/methods/apps.user.connection.bulkUpdate). + +##### user.connection.requestAuth + +```ts +requestAuth: MethodWithRequiredArgument; +``` + +###### Description + +Opens or updates a standardized authentication modal for the calling app. + +###### See + +[\`apps.user.connection.requestAuth\` API reference](https://docs.slack.dev/reference/methods/apps.user.connection.requestAuth). + ##### user.connection.update ```ts @@ -1994,7 +2022,7 @@ Updates the connection status between a user and an app. readonly assistant: object; ``` -Defined in: [packages/web-api/src/methods.ts:1501](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1501) +Defined in: [packages/web-api/src/methods.ts:1507](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1507) #### threads @@ -2056,7 +2084,7 @@ Set the title of the thread. This is shown when a user views the app's chat hist readonly auth: object; ``` -Defined in: [packages/web-api/src/methods.ts:1604](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1604) +Defined in: [packages/web-api/src/methods.ts:1626](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1626) #### revoke @@ -2110,7 +2138,7 @@ test: Method; readonly blocks: object; ``` -Defined in: [packages/web-api/src/methods.ts:1643](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1643) +Defined in: [packages/web-api/src/methods.ts:1665](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1665) #### validate @@ -2138,7 +2166,7 @@ Validates blocks, messages, and views Block Kit JSON payloads. readonly bookmarks: object; ``` -Defined in: [packages/web-api/src/methods.ts:1620](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1620) +Defined in: [packages/web-api/src/methods.ts:1642](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1642) #### add @@ -2208,7 +2236,7 @@ Remove bookmark from a channel. readonly bots: object; ``` -Defined in: [packages/web-api/src/methods.ts:1651](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1651) +Defined in: [packages/web-api/src/methods.ts:1673](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1673) #### info @@ -2236,7 +2264,7 @@ Gets information about a bot user. readonly calls: object; ``` -Defined in: [packages/web-api/src/methods.ts:1659](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1659) +Defined in: [packages/web-api/src/methods.ts:1681](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1681) #### add @@ -2332,7 +2360,7 @@ Updates information about a Call. readonly canvases: object; ``` -Defined in: [packages/web-api/src/methods.ts:1693](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1693) +Defined in: [packages/web-api/src/methods.ts:1715](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1715) #### access @@ -2410,6 +2438,20 @@ Update an existing canvas. [\`canvases.edit\` API reference](https://docs.slack.dev/reference/methods/canvases.edit). +#### getContent + +```ts +getContent: MethodWithRequiredArgument; +``` + +##### Description + +Get the content of a canvas as markdown (default) or HTML. + +##### See + +[\`canvases.getContent\` API reference](https://docs.slack.dev/reference/methods/canvases.getContent). + #### sections ```ts @@ -2442,7 +2484,7 @@ Find sections matching the provided criteria. readonly chat: object; ``` -Defined in: [packages/web-api/src/methods.ts:1733](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1733) +Defined in: [packages/web-api/src/methods.ts:1760](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1760) #### appendStream @@ -2644,7 +2686,7 @@ Updates a message. readonly conversations: object; ``` -Defined in: [packages/web-api/src/methods.ts:1812](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1812) +Defined in: [packages/web-api/src/methods.ts:1839](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1839) #### acceptSharedInvite @@ -3070,7 +3112,7 @@ Reverses conversation archival. readonly dialog: object; ``` -Defined in: [packages/web-api/src/methods.ts:2005](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2005) +Defined in: [packages/web-api/src/methods.ts:2032](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2032) #### open @@ -3098,7 +3140,7 @@ Open a dialog with a user. readonly dnd: object; ``` -Defined in: [packages/web-api/src/methods.ts:2013](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2013) +Defined in: [packages/web-api/src/methods.ts:2040](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2040) #### endDnd @@ -3182,7 +3224,7 @@ Retrieves the Do Not Disturb status for up to 50 users on a team. readonly emoji: object; ``` -Defined in: [packages/web-api/src/methods.ts:2041](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2041) +Defined in: [packages/web-api/src/methods.ts:2068](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2068) #### list @@ -3210,7 +3252,7 @@ Lists custom emoji for a team. readonly entity: object; ``` -Defined in: [packages/web-api/src/methods.ts:2049](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2049) +Defined in: [packages/web-api/src/methods.ts:2076](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2076) #### presentDetails @@ -3238,7 +3280,7 @@ Provide information about the entity to be displayed in the flexpane. readonly files: object; ``` -Defined in: [packages/web-api/src/methods.ts:2060](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2060) +Defined in: [packages/web-api/src/methods.ts:2087](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2087) #### comments @@ -3460,7 +3502,7 @@ Custom method to support a new way of uploading files to Slack. Supports a single file upload Supply: - (required) single file or content -- (optional) channel, alt_text, snippet_type, +- (optional) channel, alt_txt, snippet_type, Supports multiple file uploads Supply: - multiple upload_files @@ -3483,7 +3525,7 @@ as multiple file uploads property. readonly functions: object; ``` -Defined in: [packages/web-api/src/methods.ts:2163](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2163) +Defined in: [packages/web-api/src/methods.ts:2190](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2190) #### completeError @@ -3525,7 +3567,7 @@ Signal the successful completion of a Custom Function. readonly migration: object; ``` -Defined in: [packages/web-api/src/methods.ts:2182](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2182) +Defined in: [packages/web-api/src/methods.ts:2209](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2209) #### exchange @@ -3553,7 +3595,7 @@ For Enterprise Grid workspaces, map local user IDs to global user IDs. readonly oauth: object; ``` -Defined in: [packages/web-api/src/methods.ts:2190](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2190) +Defined in: [packages/web-api/src/methods.ts:2217](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2217) #### ~~access~~ @@ -3619,7 +3661,7 @@ Exchanges a legacy access token for a new expiring access token and refresh toke readonly openid: object; ``` -Defined in: [packages/web-api/src/methods.ts:2211](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2211) +Defined in: [packages/web-api/src/methods.ts:2238](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2238) #### connect @@ -3667,7 +3709,7 @@ Get the identity of a user who has authorized [Sign in with Slack](https://docs. readonly pins: object; ``` -Defined in: [packages/web-api/src/methods.ts:2229](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2229) +Defined in: [packages/web-api/src/methods.ts:2256](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2256) #### add @@ -3723,7 +3765,7 @@ Un-pins an item from a channel. readonly reactions: object; ``` -Defined in: [packages/web-api/src/methods.ts:2247](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2247) +Defined in: [packages/web-api/src/methods.ts:2274](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2274) #### add @@ -3793,7 +3835,7 @@ Removes a reaction from an item. readonly reminders: object; ``` -Defined in: [packages/web-api/src/methods.ts:2272](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2272) +Defined in: [packages/web-api/src/methods.ts:2299](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2299) #### add @@ -3877,7 +3919,7 @@ Lists all reminders created by or for a given user. readonly rtm: object; ``` -Defined in: [packages/web-api/src/methods.ts:2300](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2300) +Defined in: [packages/web-api/src/methods.ts:2327](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2327) #### connect @@ -3905,7 +3947,7 @@ Starts a Real Time Messaging session. readonly search: object; ``` -Defined in: [packages/web-api/src/methods.ts:2308](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2308) +Defined in: [packages/web-api/src/methods.ts:2335](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2335) #### all @@ -3973,7 +4015,7 @@ The base URL for reaching Slack's Web API. Consider changing this value for test readonly slackLists: object; ``` -Defined in: [packages/web-api/src/methods.ts:2326](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2326) +Defined in: [packages/web-api/src/methods.ts:2353](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2353) #### access @@ -4173,7 +4215,7 @@ Update a list. readonly stars: object; ``` -Defined in: [packages/web-api/src/methods.ts:2636](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2636) +Defined in: [packages/web-api/src/methods.ts:2663](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2663) #### ~~add~~ @@ -4244,7 +4286,7 @@ See [our post on stars and the Later list](https://docs.slack.dev/changelog/2023 readonly team: object; ``` -Defined in: [packages/web-api/src/methods.ts:2413](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2413) +Defined in: [packages/web-api/src/methods.ts:2440](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2440) #### accessLogs @@ -4420,7 +4462,7 @@ Authentication and authorization token for accessing Slack Web API (usually begi readonly tooling: object; ``` -Defined in: [packages/web-api/src/methods.ts:2484](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2484) +Defined in: [packages/web-api/src/methods.ts:2511](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2511) #### tokens @@ -4454,7 +4496,7 @@ Exchanges a refresh token for a new app configuration token. readonly usergroups: object; ``` -Defined in: [packages/web-api/src/methods.ts:2494](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2494) +Defined in: [packages/web-api/src/methods.ts:2521](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2521) #### create @@ -4572,7 +4614,7 @@ Update the list of users in a User Group. readonly users: object; ``` -Defined in: [packages/web-api/src/methods.ts:2537](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2537) +Defined in: [packages/web-api/src/methods.ts:2564](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2564) #### conversations @@ -4766,7 +4808,7 @@ Manually sets user presence. readonly views: object; ``` -Defined in: [packages/web-api/src/methods.ts:2607](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2607) +Defined in: [packages/web-api/src/methods.ts:2634](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2634) #### open @@ -4836,7 +4878,7 @@ Update an existing view. readonly workflows: object; ``` -Defined in: [packages/web-api/src/methods.ts:2660](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2660) +Defined in: [packages/web-api/src/methods.ts:2687](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2687) #### featured diff --git a/docs/english/reference/web-api/index.md b/docs/english/reference/web-api/index.md index 2db51f3c1..eeb0c89b8 100644 --- a/docs/english/reference/web-api/index.md +++ b/docs/english/reference/web-api/index.md @@ -1,4 +1,4 @@ -# @slack/web-api v8.2.0 +# @slack/web-api v8.3.0 ## Enumerations @@ -141,6 +141,7 @@ - [AssistantThreadsSetSuggestedPromptsArguments](interfaces/AssistantThreadsSetSuggestedPromptsArguments.md) - [AssistantThreadsSetTitleArguments](interfaces/AssistantThreadsSetTitleArguments.md) - [AssistantThreadStartedEvent](interfaces/AssistantThreadStartedEvent.md) +- [AuthProviderBlock](interfaces/AuthProviderBlock.md) - [Block](interfaces/Block.md) - [BlocksChunk](interfaces/BlocksChunk.md) - [BookmarksAddArguments](interfaces/BookmarksAddArguments.md) @@ -162,6 +163,7 @@ - [CanvasesAccessSetArguments](interfaces/CanvasesAccessSetArguments.md) - [CanvasesDeleteArguments](interfaces/CanvasesDeleteArguments.md) - [CanvasesEditArguments](interfaces/CanvasesEditArguments.md) +- [CanvasesGetContentArguments](interfaces/CanvasesGetContentArguments.md) - [CanvasesSectionsLookupArguments](interfaces/CanvasesSectionsLookupArguments.md) - [CardBlock](interfaces/CardBlock.md) - [CarouselBlock](interfaces/CarouselBlock.md) @@ -432,6 +434,10 @@ - [URLRespondable](interfaces/URLRespondable.md) - [URLSourceElement](interfaces/URLSourceElement.md) - [UserChangeEvent](interfaces/UserChangeEvent.md) +- [UserConnectionConnectEvent](interfaces/UserConnectionConnectEvent.md) +- [UserConnectionDisconnectEvent](interfaces/UserConnectionDisconnectEvent.md) +- [UserConnectionPrimaryProvider](interfaces/UserConnectionPrimaryProvider.md) +- [UserConnectionStatusRequestedEvent](interfaces/UserConnectionStatusRequestedEvent.md) - [UsergroupsCreateArguments](interfaces/UsergroupsCreateArguments.md) - [UsergroupsDisableArguments](interfaces/UsergroupsDisableArguments.md) - [UsergroupsEnableArguments](interfaces/UsergroupsEnableArguments.md) @@ -624,6 +630,10 @@ - [AppsPermissionsUsersListResponse](type-aliases/AppsPermissionsUsersListResponse.md) - [AppsPermissionsUsersRequestResponse](type-aliases/AppsPermissionsUsersRequestResponse.md) - [AppsUninstallResponse](type-aliases/AppsUninstallResponse.md) +- [AppsUserConnectionBulkUpdateArguments](type-aliases/AppsUserConnectionBulkUpdateArguments.md) +- [AppsUserConnectionBulkUpdateResponse](type-aliases/AppsUserConnectionBulkUpdateResponse.md) +- [AppsUserConnectionRequestAuthArguments](type-aliases/AppsUserConnectionRequestAuthArguments.md) +- [AppsUserConnectionRequestAuthResponse](type-aliases/AppsUserConnectionRequestAuthResponse.md) - [AppsUserConnectionUpdateResponse](type-aliases/AppsUserConnectionUpdateResponse.md) - [AssistantThreadsSetStatusResponse](type-aliases/AssistantThreadsSetStatusResponse.md) - [AssistantThreadsSetSuggestedPromptsResponse](type-aliases/AssistantThreadsSetSuggestedPromptsResponse.md) @@ -655,6 +665,7 @@ - [CanvasesCreateResponse](type-aliases/CanvasesCreateResponse.md) - [CanvasesDeleteResponse](type-aliases/CanvasesDeleteResponse.md) - [CanvasesEditResponse](type-aliases/CanvasesEditResponse.md) +- [CanvasesGetContentResponse](type-aliases/CanvasesGetContentResponse.md) - [CanvasesSectionsLookupResponse](type-aliases/CanvasesSectionsLookupResponse.md) - [ChannelsArchiveResponse](type-aliases/ChannelsArchiveResponse.md) - [ChannelsCreateResponse](type-aliases/ChannelsCreateResponse.md) @@ -887,6 +898,7 @@ - [TeamProfileGetResponse](type-aliases/TeamProfileGetResponse.md) - [TextObject](type-aliases/TextObject.md) - [ToolingTokensRotateResponse](type-aliases/ToolingTokensRotateResponse.md) +- [UserConnectionEvent](type-aliases/UserConnectionEvent.md) - [UsergroupsCreateResponse](type-aliases/UsergroupsCreateResponse.md) - [UsergroupsDisableResponse](type-aliases/UsergroupsDisableResponse.md) - [UsergroupsEnableResponse](type-aliases/UsergroupsEnableResponse.md) diff --git a/docs/english/reference/web-api/interfaces/AppsEventAuthorizationsListArguments.md b/docs/english/reference/web-api/interfaces/AppsEventAuthorizationsListArguments.md index 804636c22..2b3d36896 100644 --- a/docs/english/reference/web-api/interfaces/AppsEventAuthorizationsListArguments.md +++ b/docs/english/reference/web-api/interfaces/AppsEventAuthorizationsListArguments.md @@ -2,7 +2,7 @@ # Interface: AppsEventAuthorizationsListArguments -Defined in: [packages/web-api/src/types/request/apps.ts:10](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L10) +Defined in: [packages/web-api/src/types/request/apps.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L12) ## Extends @@ -42,7 +42,7 @@ CursorPaginationEnabled.cursor event_context: string; ``` -Defined in: [packages/web-api/src/types/request/apps.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L11) +Defined in: [packages/web-api/src/types/request/apps.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L13) *** diff --git a/docs/english/reference/web-api/interfaces/AppsManifestCreateArguments.md b/docs/english/reference/web-api/interfaces/AppsManifestCreateArguments.md index 6bfa8a0b9..70b2e6045 100644 --- a/docs/english/reference/web-api/interfaces/AppsManifestCreateArguments.md +++ b/docs/english/reference/web-api/interfaces/AppsManifestCreateArguments.md @@ -2,7 +2,7 @@ # Interface: AppsManifestCreateArguments -Defined in: [packages/web-api/src/types/request/apps.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L15) +Defined in: [packages/web-api/src/types/request/apps.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L17) ## Extends @@ -16,7 +16,7 @@ Defined in: [packages/web-api/src/types/request/apps.ts:15](https://github.com/s manifest: Manifest; ``` -Defined in: [packages/web-api/src/types/request/apps.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L16) +Defined in: [packages/web-api/src/types/request/apps.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L18) *** diff --git a/docs/english/reference/web-api/interfaces/AppsManifestDeleteArguments.md b/docs/english/reference/web-api/interfaces/AppsManifestDeleteArguments.md index e1329ff4e..99b583a1c 100644 --- a/docs/english/reference/web-api/interfaces/AppsManifestDeleteArguments.md +++ b/docs/english/reference/web-api/interfaces/AppsManifestDeleteArguments.md @@ -2,7 +2,7 @@ # Interface: AppsManifestDeleteArguments -Defined in: [packages/web-api/src/types/request/apps.ts:20](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L20) +Defined in: [packages/web-api/src/types/request/apps.ts:22](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L22) ## Extends diff --git a/docs/english/reference/web-api/interfaces/AppsManifestExportArguments.md b/docs/english/reference/web-api/interfaces/AppsManifestExportArguments.md index 4c99adb46..2dc238e56 100644 --- a/docs/english/reference/web-api/interfaces/AppsManifestExportArguments.md +++ b/docs/english/reference/web-api/interfaces/AppsManifestExportArguments.md @@ -2,7 +2,7 @@ # Interface: AppsManifestExportArguments -Defined in: [packages/web-api/src/types/request/apps.ts:23](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L23) +Defined in: [packages/web-api/src/types/request/apps.ts:25](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L25) ## Extends diff --git a/docs/english/reference/web-api/interfaces/AppsManifestUpdateArguments.md b/docs/english/reference/web-api/interfaces/AppsManifestUpdateArguments.md index cf2055b88..7d1bc4804 100644 --- a/docs/english/reference/web-api/interfaces/AppsManifestUpdateArguments.md +++ b/docs/english/reference/web-api/interfaces/AppsManifestUpdateArguments.md @@ -2,7 +2,7 @@ # Interface: AppsManifestUpdateArguments -Defined in: [packages/web-api/src/types/request/apps.ts:26](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L26) +Defined in: [packages/web-api/src/types/request/apps.ts:28](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L28) ## Extends @@ -36,7 +36,7 @@ AppID.app_id manifest: Manifest; ``` -Defined in: [packages/web-api/src/types/request/apps.ts:27](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L27) +Defined in: [packages/web-api/src/types/request/apps.ts:29](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L29) *** diff --git a/docs/english/reference/web-api/interfaces/AppsManifestValidateArguments.md b/docs/english/reference/web-api/interfaces/AppsManifestValidateArguments.md index ab9b92597..05f4a403a 100644 --- a/docs/english/reference/web-api/interfaces/AppsManifestValidateArguments.md +++ b/docs/english/reference/web-api/interfaces/AppsManifestValidateArguments.md @@ -2,7 +2,7 @@ # Interface: AppsManifestValidateArguments -Defined in: [packages/web-api/src/types/request/apps.ts:31](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L31) +Defined in: [packages/web-api/src/types/request/apps.ts:33](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L33) ## Extends @@ -34,7 +34,7 @@ The ID of the app. manifest: Manifest; ``` -Defined in: [packages/web-api/src/types/request/apps.ts:32](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L32) +Defined in: [packages/web-api/src/types/request/apps.ts:34](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L34) *** diff --git a/docs/english/reference/web-api/interfaces/AppsUninstallArguments.md b/docs/english/reference/web-api/interfaces/AppsUninstallArguments.md index 3e3e18a49..33de08328 100644 --- a/docs/english/reference/web-api/interfaces/AppsUninstallArguments.md +++ b/docs/english/reference/web-api/interfaces/AppsUninstallArguments.md @@ -2,7 +2,7 @@ # Interface: AppsUninstallArguments -Defined in: [packages/web-api/src/types/request/apps.ts:44](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L44) +Defined in: [packages/web-api/src/types/request/apps.ts:117](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L117) ## Extends diff --git a/docs/english/reference/web-api/interfaces/AppsUserConnectionUpdateArguments.md b/docs/english/reference/web-api/interfaces/AppsUserConnectionUpdateArguments.md index 7f6320ef1..a64075691 100644 --- a/docs/english/reference/web-api/interfaces/AppsUserConnectionUpdateArguments.md +++ b/docs/english/reference/web-api/interfaces/AppsUserConnectionUpdateArguments.md @@ -2,7 +2,7 @@ # Interface: AppsUserConnectionUpdateArguments -Defined in: [packages/web-api/src/types/request/apps.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L36) +Defined in: [packages/web-api/src/types/request/apps.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L109) ## Extends @@ -16,7 +16,7 @@ Defined in: [packages/web-api/src/types/request/apps.ts:36](https://github.com/s status: string; ``` -Defined in: [packages/web-api/src/types/request/apps.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L40) +Defined in: [packages/web-api/src/types/request/apps.ts:113](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L113) #### Description @@ -50,7 +50,7 @@ TokenOverridable.token user_id: string; ``` -Defined in: [packages/web-api/src/types/request/apps.ts:38](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L38) +Defined in: [packages/web-api/src/types/request/apps.ts:111](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L111) #### Description diff --git a/docs/english/reference/web-api/interfaces/AuthProviderBlock.md b/docs/english/reference/web-api/interfaces/AuthProviderBlock.md new file mode 100644 index 000000000..4ed5ec695 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/AuthProviderBlock.md @@ -0,0 +1,221 @@ +[@slack/web-api](../index.md) / AuthProviderBlock + +# Interface: AuthProviderBlock + +Defined in: packages/types/dist/block-kit/blocks.d.ts:69 + +## Description + +Displays authentication provider information, including its icon, name, and connection state. + +## See + +[Auth provider block reference](https://docs.slack.dev/reference/block-kit/blocks/auth-provider-block). + +## Extends + +- [`Block`](Block.md) + +## Properties + +### accessory? + +```ts +optional accessory?: Overflow; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:122 + +#### Description + +An [Overflow](Overflow.md) menu shown when connected, e.g. Disconnect or Re-authenticate. + +*** + +### auth\_url? + +```ts +optional auth_url?: string; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:103 + +#### Description + +OAuth redirect URL opened when the user clicks Connect. Must be an HTTPS URL on a host listed in the +app manifest's `features.user_connections.auth_hosts`. Maximum length for this field is 3000 characters. + +*** + +### 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) + +*** + +### connected\_context? + +```ts +optional connected_context?: PlainTextElement; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:118 + +#### Description + +Additional context about the connection in the form of a [PlainTextElement](PlainTextElement.md), e.g. the org or +workspace name. Maximum length for the text in this field is 75 characters. + +*** + +### connected\_identity? + +```ts +optional connected_identity?: PlainTextElement; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:113 + +#### Description + +Display name of the connected account in the form of a [PlainTextElement](PlainTextElement.md), shown when +`is_connected` is `true`. Maximum length for the text in this field is 75 characters. + +*** + +### description? + +```ts +optional description?: PlainTextElement; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:93 + +#### Description + +Brief description of what this connection enables in the form of a [PlainTextElement](PlainTextElement.md). +Maximum length for the text in this field is 150 characters. + +*** + +### disconnect\_url? + +```ts +optional disconnect_url?: string; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:108 + +#### Description + +URL opened when the user clicks Disconnect. Must be an HTTPS URL on a host listed in the app +manifest's `features.user_connections.auth_hosts`. Maximum length for this field is 3000 characters. + +*** + +### fallback? + +```ts +optional fallback?: KnownBlock[]; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:127 + +#### Description + +An array of stable [KnownBlock](../type-aliases/KnownBlock.md) objects rendered by clients that don't recognize +`auth_provider`, spliced into the parent blocks array. + +*** + +### icon\_url? + +```ts +optional icon_url?: string; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:98 + +#### Description + +URL for the provider icon image. Must be an HTTPS URL. Falls back to the app's avatar when absent. +Maximum length for this field is 3000 characters. + +*** + +### is\_connected + +```ts +is_connected: boolean; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:88 + +#### Description + +Whether this provider is currently connected. Slack records this state for the user. + +*** + +### name + +```ts +name: PlainTextElement; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:84 + +#### Description + +Human-readable name of the provider in the form of a [PlainTextElement](PlainTextElement.md). +Maximum length for the text in this field is 75 characters. + +*** + +### type + +```ts +type: "auth_provider"; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:73 + +#### Description + +The type of block. For an auth provider block, `type` is always `auth_provider`. + +#### Overrides + +[`Block`](Block.md).[`type`](Block.md#type) + +*** + +### value + +```ts +value: string; +``` + +Defined in: packages/types/dist/block-kit/blocks.d.ts:79 + +#### Description + +Unique identifier for this provider within the app. Included in interaction payloads and used to +derive the connect button `action_id` (`auth_provider_connect_`). Maximum length for this field is 150 +characters. diff --git a/docs/english/reference/web-api/interfaces/Block.md b/docs/english/reference/web-api/interfaces/Block.md index 9aaba4095..3db0840b5 100644 --- a/docs/english/reference/web-api/interfaces/Block.md +++ b/docs/english/reference/web-api/interfaces/Block.md @@ -8,6 +8,7 @@ Defined in: packages/types/dist/block-kit/blocks.d.ts:3 - [`ActionsBlock`](ActionsBlock.md) - [`AlertBlock`](AlertBlock.md) +- [`AuthProviderBlock`](AuthProviderBlock.md) - [`CardBlock`](CardBlock.md) - [`CarouselBlock`](CarouselBlock.md) - [`ContainerBlock`](ContainerBlock.md) diff --git a/docs/english/reference/web-api/interfaces/Button.md b/docs/english/reference/web-api/interfaces/Button.md index c51644e06..fecadada2 100644 --- a/docs/english/reference/web-api/interfaces/Button.md +++ b/docs/english/reference/web-api/interfaces/Button.md @@ -52,6 +52,36 @@ among all other `action_id`s in the containing block. Maximum length for this fi *** +### agent\_prompt? + +```ts +optional agent_prompt?: string; +``` + +Defined in: packages/types/dist/block-kit/block-elements.d.ts:48 + +#### Description + +A prompt sent to Slackbot when the button is clicked, if Slackbot AI is available to the user. +Maximum length for this field is 4000 characters. + +*** + +### agent\_prompt\_display? + +```ts +optional agent_prompt_display?: string; +``` + +Defined in: packages/types/dist/block-kit/block-elements.d.ts:53 + +#### Description + +Short text shown instead of the full `agent_prompt` in the user's Slackbot message. Requires +`agent_prompt` and defaults to the button's `text`. + +*** + ### confirm? ```ts @@ -151,3 +181,17 @@ Defined in: packages/types/dist/block-kit/block-elements.d.ts:23 The value to send along with the [interaction payload](https://docs.slack.dev/interactivity/handling-user-interaction#payloads). Maximum length for this field is 2000 characters. + +*** + +### visible\_to\_user\_ids? + +```ts +optional visible_to_user_ids?: string[]; +``` + +Defined in: packages/types/dist/block-kit/block-elements.d.ts:57 + +#### Description + +An array of user IDs for which the button appears. If not provided, the button is visible to all users. diff --git a/docs/english/reference/web-api/interfaces/CanvasesGetContentArguments.md b/docs/english/reference/web-api/interfaces/CanvasesGetContentArguments.md new file mode 100644 index 000000000..3e3afe4a3 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/CanvasesGetContentArguments.md @@ -0,0 +1,63 @@ +[@slack/web-api](../index.md) / CanvasesGetContentArguments + +# Interface: CanvasesGetContentArguments + +Defined in: [packages/web-api/src/types/request/canvas.ts:93](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L93) + +## Extends + +- `CanvasID`.`TokenOverridable` + +## Properties + +### canvas\_id + +```ts +canvas_id: string; +``` + +Defined in: [packages/web-api/src/types/request/canvas.ts:6](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L6) + +#### Description + +Encoded ID of the canvas. + +#### Inherited from + +```ts +CanvasID.canvas_id +``` + +*** + +### content\_type? + +```ts +optional content_type?: "markdown" | "html"; +``` + +Defined in: [packages/web-api/src/types/request/canvas.ts:95](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L95) + +#### Description + +Format in which to return the canvas content. Defaults to markdown. + +*** + +### token? + +```ts +optional token?: string; +``` + +Defined in: [packages/web-api/src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43) + +#### Description + +Overridable authentication token bearing required scopes. + +#### Inherited from + +```ts +TokenOverridable.token +``` diff --git a/docs/english/reference/web-api/interfaces/CardBlock.md b/docs/english/reference/web-api/interfaces/CardBlock.md index 8c5323b3a..08a24f994 100644 --- a/docs/english/reference/web-api/interfaces/CardBlock.md +++ b/docs/english/reference/web-api/interfaces/CardBlock.md @@ -2,7 +2,7 @@ # Interface: CardBlock -Defined in: packages/types/dist/block-kit/blocks.d.ts:69 +Defined in: packages/types/dist/block-kit/blocks.d.ts:133 ## Description @@ -24,7 +24,7 @@ Displays content in a card. At least one of `hero_image`, `title`, `actions`, or optional actions?: Button[]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:100 +Defined in: packages/types/dist/block-kit/blocks.d.ts:164 #### Description @@ -60,7 +60,7 @@ a message. If a message is updated, use a new `block_id`. optional body?: MrkdwnElement; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:96 +Defined in: packages/types/dist/block-kit/blocks.d.ts:160 #### Description @@ -75,7 +75,7 @@ Maximum length for the text in this field is 200 characters. optional hero_image?: ImageElement; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:77 +Defined in: packages/types/dist/block-kit/blocks.d.ts:141 #### 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: packages/types/dist/block-kit/blocks.d.ts:81 +Defined in: packages/types/dist/block-kit/blocks.d.ts:145 #### 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: packages/types/dist/block-kit/blocks.d.ts:91 +Defined in: packages/types/dist/block-kit/blocks.d.ts:155 #### Description @@ -118,7 +118,7 @@ Maximum length for the text in this field is 150 characters. optional title?: MrkdwnElement; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:86 +Defined in: packages/types/dist/block-kit/blocks.d.ts:150 #### Description @@ -133,7 +133,7 @@ Maximum length for the text in this field is 150 characters. type: "card"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:73 +Defined in: packages/types/dist/block-kit/blocks.d.ts:137 #### Description diff --git a/docs/english/reference/web-api/interfaces/CarouselBlock.md b/docs/english/reference/web-api/interfaces/CarouselBlock.md index 00e0a014f..575675fd5 100644 --- a/docs/english/reference/web-api/interfaces/CarouselBlock.md +++ b/docs/english/reference/web-api/interfaces/CarouselBlock.md @@ -2,7 +2,7 @@ # Interface: CarouselBlock -Defined in: packages/types/dist/block-kit/blocks.d.ts:106 +Defined in: packages/types/dist/block-kit/blocks.d.ts:170 ## Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. elements: CardBlock[]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:114 +Defined in: packages/types/dist/block-kit/blocks.d.ts:178 #### Description @@ -60,7 +60,7 @@ An array of [CardBlock](CardBlock.md) elements. Minimum 1, maximum 10 cards. type: "carousel"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:110 +Defined in: packages/types/dist/block-kit/blocks.d.ts:174 #### Description diff --git a/docs/english/reference/web-api/interfaces/ChannelsSelect.md b/docs/english/reference/web-api/interfaces/ChannelsSelect.md index e2a9442ce..84bc5632e 100644 --- a/docs/english/reference/web-api/interfaces/ChannelsSelect.md +++ b/docs/english/reference/web-api/interfaces/ChannelsSelect.md @@ -2,7 +2,7 @@ # Interface: ChannelsSelect -Defined in: packages/types/dist/block-kit/block-elements.d.ts:412 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:426 ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_channel?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:420 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:434 #### Description @@ -137,7 +137,7 @@ for the message will be determined by the value of this select menu. type: "channels_select"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:416 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:430 #### Description diff --git a/docs/english/reference/web-api/interfaces/Checkboxes.md b/docs/english/reference/web-api/interfaces/Checkboxes.md index 86e49beb9..162ba7860 100644 --- a/docs/english/reference/web-api/interfaces/Checkboxes.md +++ b/docs/english/reference/web-api/interfaces/Checkboxes.md @@ -2,7 +2,7 @@ # Interface: Checkboxes -Defined in: packages/types/dist/block-kit/block-elements.d.ts:50 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:64 ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_options?: Option[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:59 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:73 #### Description @@ -97,7 +97,7 @@ These options will be selected when the checkbox group initially loads. options: Option[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:63 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:77 #### Description @@ -111,7 +111,7 @@ An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options type: "checkboxes"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:54 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:68 #### Description diff --git a/docs/english/reference/web-api/interfaces/ContainerBlock.md b/docs/english/reference/web-api/interfaces/ContainerBlock.md index dc02c9595..c65a72998 100644 --- a/docs/english/reference/web-api/interfaces/ContainerBlock.md +++ b/docs/english/reference/web-api/interfaces/ContainerBlock.md @@ -2,7 +2,7 @@ # Interface: ContainerBlock -Defined in: packages/types/dist/block-kit/blocks.d.ts:120 +Defined in: packages/types/dist/block-kit/blocks.d.ts:184 ## Description @@ -57,7 +57,7 @@ child_blocks: ( | VideoBlock)[]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:142 +Defined in: packages/types/dist/block-kit/blocks.d.ts:206 #### Description @@ -71,7 +71,7 @@ An array of child blocks. Maximum 10 blocks. optional default_collapsed?: boolean; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:158 +Defined in: packages/types/dist/block-kit/blocks.d.ts:222 #### Description @@ -85,7 +85,7 @@ Whether the container is collapsed by default. Requires `is_collapsible` to be ` optional has_header_divider?: boolean; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:163 +Defined in: packages/types/dist/block-kit/blocks.d.ts:227 #### Description @@ -100,7 +100,7 @@ Only applies when `is_collapsible` is not `true`. Defaults to `false`. optional icon?: ImageElement; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:150 +Defined in: packages/types/dist/block-kit/blocks.d.ts:214 #### Description @@ -114,7 +114,7 @@ An image element displayed alongside the title and subtitle. optional is_collapsible?: boolean; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:154 +Defined in: packages/types/dist/block-kit/blocks.d.ts:218 #### Description @@ -128,7 +128,7 @@ Whether the container can be collapsed. Defaults to `false`. optional rich_text_title?: RichTextBlock; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:134 +Defined in: packages/types/dist/block-kit/blocks.d.ts:198 #### Description @@ -143,7 +143,7 @@ One of `title` or `rich_text_title` is required. optional subtitle?: TextObject; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:138 +Defined in: packages/types/dist/block-kit/blocks.d.ts:202 #### Description @@ -157,7 +157,7 @@ Subtitle for the container in plain text or mrkdwn format. Maximum length is 150 optional title?: PlainTextElement; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:129 +Defined in: packages/types/dist/block-kit/blocks.d.ts:193 #### Description @@ -172,7 +172,7 @@ One of `title` or `rich_text_title` is required. type: "container"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:124 +Defined in: packages/types/dist/block-kit/blocks.d.ts:188 #### Description @@ -190,7 +190,7 @@ The type of block. For a container block, `type` is always `container`. optional width?: "narrow" | "standard" | "wide" | "full"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:146 +Defined in: packages/types/dist/block-kit/blocks.d.ts:210 #### Description diff --git a/docs/english/reference/web-api/interfaces/ContextActionsBlock.md b/docs/english/reference/web-api/interfaces/ContextActionsBlock.md index d1df9215c..8763540a9 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:193 +Defined in: packages/types/dist/block-kit/blocks.d.ts:257 ## 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:201 +Defined in: packages/types/dist/block-kit/blocks.d.ts:265 #### 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:197 +Defined in: packages/types/dist/block-kit/blocks.d.ts:261 #### Description diff --git a/docs/english/reference/web-api/interfaces/ContextBlock.md b/docs/english/reference/web-api/interfaces/ContextBlock.md index e724d50f3..d59f935d3 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:174 +Defined in: packages/types/dist/block-kit/blocks.d.ts:238 ## 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:183 +Defined in: packages/types/dist/block-kit/blocks.d.ts:247 #### Description @@ -61,7 +61,7 @@ Maximum number of items is 10. type: "context"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:178 +Defined in: packages/types/dist/block-kit/blocks.d.ts:242 #### Description diff --git a/docs/english/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md b/docs/english/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md index a59ea22fa..420831613 100644 --- a/docs/english/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md +++ b/docs/english/reference/web-api/interfaces/ConversationsCanvasesCreateArguments.md @@ -2,7 +2,7 @@ # Interface: ConversationsCanvasesCreateArguments -Defined in: [packages/web-api/src/types/request/canvas.ts:93](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L93) +Defined in: [packages/web-api/src/types/request/canvas.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L99) ## Extends @@ -36,7 +36,7 @@ ChannelID.channel_id optional document_content?: DocumentContent; ``` -Defined in: [packages/web-api/src/types/request/canvas.ts:95](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L95) +Defined in: [packages/web-api/src/types/request/canvas.ts:101](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L101) #### Description @@ -50,7 +50,7 @@ Structure describing the type and contents of the Canvas being created. optional title?: string; ``` -Defined in: [packages/web-api/src/types/request/canvas.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L97) +Defined in: [packages/web-api/src/types/request/canvas.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/canvas.ts#L103) #### Description diff --git a/docs/english/reference/web-api/interfaces/ConversationsSelect.md b/docs/english/reference/web-api/interfaces/ConversationsSelect.md index 6f67dcf2b..71e7fcac4 100644 --- a/docs/english/reference/web-api/interfaces/ConversationsSelect.md +++ b/docs/english/reference/web-api/interfaces/ConversationsSelect.md @@ -2,7 +2,7 @@ # Interface: ConversationsSelect -Defined in: packages/types/dist/block-kit/block-elements.d.ts:352 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:366 ## Description @@ -63,7 +63,7 @@ with. optional default_to_current_conversation?: boolean; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:366 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:380 #### Description @@ -78,7 +78,7 @@ modal, if available. Default is `false`. optional filter?: object; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:370 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:384 #### exclude\_bot\_users? @@ -130,7 +130,7 @@ Defaults to `false`. optional initial_conversation?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:361 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:375 #### Description @@ -185,7 +185,7 @@ for the message will be determined by the value of this select menu. type: "conversations_select"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:356 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:370 #### Description diff --git a/docs/english/reference/web-api/interfaces/DataTableBlock.md b/docs/english/reference/web-api/interfaces/DataTableBlock.md index 7de5653c3..536f40a3c 100644 --- a/docs/english/reference/web-api/interfaces/DataTableBlock.md +++ b/docs/english/reference/web-api/interfaces/DataTableBlock.md @@ -2,7 +2,7 @@ # Interface: DataTableBlock -Defined in: packages/types/dist/block-kit/blocks.d.ts:207 +Defined in: packages/types/dist/block-kit/blocks.d.ts:271 ## Description @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`. caption: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:219 +Defined in: packages/types/dist/block-kit/blocks.d.ts:283 #### Description @@ -60,7 +60,7 @@ A caption for the table; used as the value for the HTML caption element. optional page_size?: number; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:223 +Defined in: packages/types/dist/block-kit/blocks.d.ts:287 #### Description @@ -74,7 +74,7 @@ Number of rows per page. Min `1`, Max `100`. Defaults to `5` if omitted. optional row_header_column_index?: number; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:227 +Defined in: packages/types/dist/block-kit/blocks.d.ts:291 #### Description @@ -91,7 +91,7 @@ rows: ( | RawNumberElement)[][]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:215 +Defined in: packages/types/dist/block-kit/blocks.d.ts:279 #### Description @@ -105,7 +105,7 @@ An array consisting of table rows. type: "data_table"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:211 +Defined in: packages/types/dist/block-kit/blocks.d.ts:275 #### Description diff --git a/docs/english/reference/web-api/interfaces/DateTimepicker.md b/docs/english/reference/web-api/interfaces/DateTimepicker.md index 63ec78e1a..66c21eda2 100644 --- a/docs/english/reference/web-api/interfaces/DateTimepicker.md +++ b/docs/english/reference/web-api/interfaces/DateTimepicker.md @@ -2,7 +2,7 @@ # Interface: DateTimepicker -Defined in: packages/types/dist/block-kit/block-elements.d.ts:89 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:103 ## Description @@ -85,7 +85,7 @@ Defaults to `false`. optional initial_date_time?: number; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:99 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:113 #### Description @@ -101,7 +101,7 @@ time August 10th, 2021 at 03:17pm PST. type: "datetimepicker"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:93 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:107 #### Description diff --git a/docs/english/reference/web-api/interfaces/Datepicker.md b/docs/english/reference/web-api/interfaces/Datepicker.md index a4b6ce433..6cc891585 100644 --- a/docs/english/reference/web-api/interfaces/Datepicker.md +++ b/docs/english/reference/web-api/interfaces/Datepicker.md @@ -2,7 +2,7 @@ # Interface: Datepicker -Defined in: packages/types/dist/block-kit/block-elements.d.ts:70 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:84 ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_date?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:79 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:93 #### Description @@ -116,7 +116,7 @@ length for the `text` field in this object is 150 characters. type: "datepicker"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:74 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:88 #### Description diff --git a/docs/english/reference/web-api/interfaces/DividerBlock.md b/docs/english/reference/web-api/interfaces/DividerBlock.md index 6658e0a5e..8a56786ab 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:234 +Defined in: packages/types/dist/block-kit/blocks.d.ts:298 ## 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:238 +Defined in: packages/types/dist/block-kit/blocks.d.ts:302 #### Description diff --git a/docs/english/reference/web-api/interfaces/EmailInput.md b/docs/english/reference/web-api/interfaces/EmailInput.md index 02f0e9229..82133a5ad 100644 --- a/docs/english/reference/web-api/interfaces/EmailInput.md +++ b/docs/english/reference/web-api/interfaces/EmailInput.md @@ -2,7 +2,7 @@ # Interface: EmailInput -Defined in: packages/types/dist/block-kit/block-elements.d.ts:106 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:120 ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_value?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:114 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:128 #### Description @@ -115,7 +115,7 @@ length for the `text` field in this object is 150 characters. type: "email_text_input"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:110 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:124 #### Description diff --git a/docs/english/reference/web-api/interfaces/ExternalSelect.md b/docs/english/reference/web-api/interfaces/ExternalSelect.md index c35f4beaa..07704b444 100644 --- a/docs/english/reference/web-api/interfaces/ExternalSelect.md +++ b/docs/english/reference/web-api/interfaces/ExternalSelect.md @@ -2,7 +2,7 @@ # Interface: ExternalSelect -Defined in: packages/types/dist/block-kit/block-elements.d.ts:444 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:458 ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_option?: PlainTextOption; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:452 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:466 #### Description @@ -97,7 +97,7 @@ A single option to be selected when the menu initially loads. optional min_query_length?: number; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:458 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:472 #### Description @@ -132,7 +132,7 @@ length for the `text` field in this object is 150 characters. type: "external_select"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:448 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:462 #### Description diff --git a/docs/english/reference/web-api/interfaces/FeedbackButtons.md b/docs/english/reference/web-api/interfaces/FeedbackButtons.md index d9c4a5769..81be3e2f5 100644 --- a/docs/english/reference/web-api/interfaces/FeedbackButtons.md +++ b/docs/english/reference/web-api/interfaces/FeedbackButtons.md @@ -2,7 +2,7 @@ # Interface: FeedbackButtons -Defined in: packages/types/dist/block-kit/block-elements.d.ts:119 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:133 ## Description @@ -38,7 +38,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi negative_button: object; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:148 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:162 #### accessibility\_label? @@ -90,7 +90,7 @@ A button to indicate negative feedback. positive_button: object; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:129 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:143 #### accessibility\_label? @@ -142,7 +142,7 @@ A button to indicate positive feedback. type: "feedback_buttons"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:124 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:138 #### Description diff --git a/docs/english/reference/web-api/interfaces/FileBlock.md b/docs/english/reference/web-api/interfaces/FileBlock.md index cc36956a3..410a938b1 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:247 +Defined in: packages/types/dist/block-kit/blocks.d.ts:311 ## 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:259 +Defined in: packages/types/dist/block-kit/blocks.d.ts:323 #### Description @@ -63,7 +63,7 @@ The external unique ID for this file. source: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:255 +Defined in: packages/types/dist/block-kit/blocks.d.ts:319 #### 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:251 +Defined in: packages/types/dist/block-kit/blocks.d.ts:315 #### Description diff --git a/docs/english/reference/web-api/interfaces/FileInput.md b/docs/english/reference/web-api/interfaces/FileInput.md index 38eee5d58..46df1796f 100644 --- a/docs/english/reference/web-api/interfaces/FileInput.md +++ b/docs/english/reference/web-api/interfaces/FileInput.md @@ -2,7 +2,7 @@ # Interface: FileInput -Defined in: packages/types/dist/block-kit/block-elements.d.ts:169 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:183 ## Description @@ -43,7 +43,7 @@ among all other `action_id`s in the containing block. Maximum length for this fi optional filetypes?: string[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:179 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:193 #### Description @@ -59,7 +59,7 @@ for convenience only, and you should perform your own file type validation based optional max_files?: number; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:184 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:198 #### Description @@ -74,7 +74,7 @@ Maximum number of files that can be uploaded for this `file_input` element. Mini type: "file_input"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:173 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:187 #### Description diff --git a/docs/english/reference/web-api/interfaces/FilesCommentsDeleteArguments.md b/docs/english/reference/web-api/interfaces/FilesCommentsDeleteArguments.md index f76591c63..e73354d64 100644 --- a/docs/english/reference/web-api/interfaces/FilesCommentsDeleteArguments.md +++ b/docs/english/reference/web-api/interfaces/FilesCommentsDeleteArguments.md @@ -2,7 +2,7 @@ # Interface: FilesCommentsDeleteArguments -Defined in: [packages/web-api/src/types/request/files.ts:203](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L203) +Defined in: [packages/web-api/src/types/request/files.ts:207](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L207) ## Extends @@ -36,7 +36,7 @@ FileArgument.file id: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:205](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L205) +Defined in: [packages/web-api/src/types/request/files.ts:209](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L209) #### Description diff --git a/docs/english/reference/web-api/interfaces/FilesGetUploadURLExternalArguments.md b/docs/english/reference/web-api/interfaces/FilesGetUploadURLExternalArguments.md index 6b9b1404f..e28b6aab9 100644 --- a/docs/english/reference/web-api/interfaces/FilesGetUploadURLExternalArguments.md +++ b/docs/english/reference/web-api/interfaces/FilesGetUploadURLExternalArguments.md @@ -10,12 +10,26 @@ Defined in: [packages/web-api/src/types/request/files.ts:92](https://github.com/ ## Properties -### alt\_text? +### ~~alt\_text?~~ ```ts optional alt_text?: string; ``` +Defined in: [packages/web-api/src/types/request/files.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L100) + +#### Deprecated + +Slack does not use this. Use `alt_txt`. + +*** + +### alt\_txt? + +```ts +optional alt_txt?: string; +``` + Defined in: [packages/web-api/src/types/request/files.ts:98](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L98) #### Description @@ -58,7 +72,7 @@ Size in bytes of the file being uploaded. optional snippet_type?: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L100) +Defined in: [packages/web-api/src/types/request/files.ts:102](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L102) #### Description diff --git a/docs/english/reference/web-api/interfaces/FilesInfoArguments.md b/docs/english/reference/web-api/interfaces/FilesInfoArguments.md index 2e5589d71..b1d41741c 100644 --- a/docs/english/reference/web-api/interfaces/FilesInfoArguments.md +++ b/docs/english/reference/web-api/interfaces/FilesInfoArguments.md @@ -2,7 +2,7 @@ # Interface: FilesInfoArguments -Defined in: [packages/web-api/src/types/request/files.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L103) +Defined in: [packages/web-api/src/types/request/files.ts:105](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L105) ## Extends diff --git a/docs/english/reference/web-api/interfaces/FilesListArguments.md b/docs/english/reference/web-api/interfaces/FilesListArguments.md index a08918f76..5530f2fa8 100644 --- a/docs/english/reference/web-api/interfaces/FilesListArguments.md +++ b/docs/english/reference/web-api/interfaces/FilesListArguments.md @@ -2,7 +2,7 @@ # Interface: FilesListArguments -Defined in: [packages/web-api/src/types/request/files.ts:109](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L109) +Defined in: [packages/web-api/src/types/request/files.ts:111](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L111) ## Extends @@ -16,7 +16,7 @@ Defined in: [packages/web-api/src/types/request/files.ts:109](https://github.com optional channel?: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:111](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L111) +Defined in: [packages/web-api/src/types/request/files.ts:113](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L113) #### Description @@ -70,7 +70,7 @@ TraditionalPagingEnabled.page optional show_files_hidden_by_limit?: boolean; ``` -Defined in: [packages/web-api/src/types/request/files.ts:116](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L116) +Defined in: [packages/web-api/src/types/request/files.ts:118](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L118) #### Description @@ -125,7 +125,7 @@ TokenOverridable.token optional ts_from?: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:118](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L118) +Defined in: [packages/web-api/src/types/request/files.ts:120](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L120) #### Description @@ -139,7 +139,7 @@ Filter files created after this timestamp (inclusive). optional ts_to?: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:120](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L120) +Defined in: [packages/web-api/src/types/request/files.ts:122](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L122) #### Description @@ -153,7 +153,7 @@ Filter files created before this timestamp (inclusive). optional types?: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:126](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L126) +Defined in: [packages/web-api/src/types/request/files.ts:128](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L128) #### Description @@ -169,7 +169,7 @@ Available types are `all`, `spaces`, `snippets`, `images`, `gdocs`, `zips` and ` optional user?: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:128](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L128) +Defined in: [packages/web-api/src/types/request/files.ts:130](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L130) #### Description diff --git a/docs/english/reference/web-api/interfaces/FilesRemoteAddArguments.md b/docs/english/reference/web-api/interfaces/FilesRemoteAddArguments.md index 70329567e..cddb36f64 100644 --- a/docs/english/reference/web-api/interfaces/FilesRemoteAddArguments.md +++ b/docs/english/reference/web-api/interfaces/FilesRemoteAddArguments.md @@ -2,7 +2,7 @@ # Interface: FilesRemoteAddArguments -Defined in: [packages/web-api/src/types/request/files.ts:222](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L222) +Defined in: [packages/web-api/src/types/request/files.ts:226](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L226) ## Extends @@ -36,7 +36,7 @@ ExternalIDArgument.external_id external_url: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:211](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L211) +Defined in: [packages/web-api/src/types/request/files.ts:215](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L215) #### Description @@ -80,7 +80,7 @@ FileType.filetype optional indexable_file_contents?: Buffer | Stream; ``` -Defined in: [packages/web-api/src/types/request/files.ts:218](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L218) +Defined in: [packages/web-api/src/types/request/files.ts:222](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L222) #### Description @@ -101,7 +101,7 @@ SharedFile.indexable_file_contents optional preview_image?: Buffer | Stream; ``` -Defined in: [packages/web-api/src/types/request/files.ts:213](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L213) +Defined in: [packages/web-api/src/types/request/files.ts:217](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L217) #### Description @@ -121,7 +121,7 @@ SharedFile.preview_image title: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:209](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L209) +Defined in: [packages/web-api/src/types/request/files.ts:213](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L213) #### Description diff --git a/docs/english/reference/web-api/interfaces/FilesRemoteListArguments.md b/docs/english/reference/web-api/interfaces/FilesRemoteListArguments.md index 19b74a036..0e122958f 100644 --- a/docs/english/reference/web-api/interfaces/FilesRemoteListArguments.md +++ b/docs/english/reference/web-api/interfaces/FilesRemoteListArguments.md @@ -2,7 +2,7 @@ # Interface: FilesRemoteListArguments -Defined in: [packages/web-api/src/types/request/files.ts:228](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L228) +Defined in: [packages/web-api/src/types/request/files.ts:232](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L232) ## Extends @@ -16,7 +16,7 @@ Defined in: [packages/web-api/src/types/request/files.ts:228](https://github.com optional channel?: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:230](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L230) +Defined in: [packages/web-api/src/types/request/files.ts:234](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L234) #### Description @@ -97,7 +97,7 @@ TokenOverridable.token optional ts_from?: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:232](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L232) +Defined in: [packages/web-api/src/types/request/files.ts:236](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L236) #### Description @@ -111,7 +111,7 @@ Filter files created after this timestamp (inclusive). optional ts_to?: string; ``` -Defined in: [packages/web-api/src/types/request/files.ts:234](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L234) +Defined in: [packages/web-api/src/types/request/files.ts:238](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L238) #### Description diff --git a/docs/english/reference/web-api/interfaces/FilesRevokePublicURLArguments.md b/docs/english/reference/web-api/interfaces/FilesRevokePublicURLArguments.md index ad0e84649..2265672b4 100644 --- a/docs/english/reference/web-api/interfaces/FilesRevokePublicURLArguments.md +++ b/docs/english/reference/web-api/interfaces/FilesRevokePublicURLArguments.md @@ -2,7 +2,7 @@ # Interface: FilesRevokePublicURLArguments -Defined in: [packages/web-api/src/types/request/files.ts:131](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L131) +Defined in: [packages/web-api/src/types/request/files.ts:133](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L133) ## Extends diff --git a/docs/english/reference/web-api/interfaces/FilesSharedPublicURLArguments.md b/docs/english/reference/web-api/interfaces/FilesSharedPublicURLArguments.md index c9bbd2628..bd838c665 100644 --- a/docs/english/reference/web-api/interfaces/FilesSharedPublicURLArguments.md +++ b/docs/english/reference/web-api/interfaces/FilesSharedPublicURLArguments.md @@ -2,7 +2,7 @@ # Interface: FilesSharedPublicURLArguments -Defined in: [packages/web-api/src/types/request/files.ts:133](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L133) +Defined in: [packages/web-api/src/types/request/files.ts:135](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L135) ## Extends diff --git a/docs/english/reference/web-api/interfaces/HeaderBlock.md b/docs/english/reference/web-api/interfaces/HeaderBlock.md index 768d99ea3..cd700db9d 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:266 +Defined in: packages/types/dist/block-kit/blocks.d.ts:330 ## 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:275 +Defined in: packages/types/dist/block-kit/blocks.d.ts:339 #### 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:270 +Defined in: packages/types/dist/block-kit/blocks.d.ts:334 #### Description diff --git a/docs/english/reference/web-api/interfaces/IconButton.md b/docs/english/reference/web-api/interfaces/IconButton.md index a92b3f1d1..44cf3e1ce 100644 --- a/docs/english/reference/web-api/interfaces/IconButton.md +++ b/docs/english/reference/web-api/interfaces/IconButton.md @@ -2,7 +2,7 @@ # Interface: IconButton -Defined in: packages/types/dist/block-kit/block-elements.d.ts:190 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:204 ## Description @@ -24,7 +24,7 @@ An icon button to perform actions. optional accessibility_label?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:208 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:222 #### Description @@ -75,7 +75,7 @@ with. icon: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:199 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:213 #### Description @@ -95,7 +95,7 @@ trash text: PlainTextElement; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:204 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:218 #### Description @@ -113,7 +113,7 @@ Defines an object containing some text. type: "icon_button"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:194 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:208 #### Description @@ -131,7 +131,7 @@ The type of element. In this case `type` is always `icon_button`. optional value?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:212 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:226 #### Description @@ -145,7 +145,7 @@ The button value. optional visible_to_user_ids?: string[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:216 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:230 #### Description diff --git a/docs/english/reference/web-api/interfaces/InputBlock.md b/docs/english/reference/web-api/interfaces/InputBlock.md index ad7cf9378..6576ee7bb 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:308 +Defined in: packages/types/dist/block-kit/blocks.d.ts:372 ## 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:336 +Defined in: packages/types/dist/block-kit/blocks.d.ts:400 #### 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:331 +Defined in: packages/types/dist/block-kit/blocks.d.ts:395 #### Description @@ -77,7 +77,7 @@ A block element. optional hint?: PlainTextElement; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:322 +Defined in: packages/types/dist/block-kit/blocks.d.ts:386 #### 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:317 +Defined in: packages/types/dist/block-kit/blocks.d.ts:381 #### 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:327 +Defined in: packages/types/dist/block-kit/blocks.d.ts:391 #### Description @@ -122,7 +122,7 @@ Defaults to `false`. type: "input"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:312 +Defined in: packages/types/dist/block-kit/blocks.d.ts:376 #### Description diff --git a/docs/english/reference/web-api/interfaces/MarkdownBlock.md b/docs/english/reference/web-api/interfaces/MarkdownBlock.md index a54023ae7..33ee9db05 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:344 +Defined in: packages/types/dist/block-kit/blocks.d.ts:408 ## 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:352 +Defined in: packages/types/dist/block-kit/blocks.d.ts:416 #### 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:348 +Defined in: packages/types/dist/block-kit/blocks.d.ts:412 #### Description diff --git a/docs/english/reference/web-api/interfaces/MultiChannelsSelect.md b/docs/english/reference/web-api/interfaces/MultiChannelsSelect.md index df1a4bc27..5e62e6c3d 100644 --- a/docs/english/reference/web-api/interfaces/MultiChannelsSelect.md +++ b/docs/english/reference/web-api/interfaces/MultiChannelsSelect.md @@ -2,7 +2,7 @@ # Interface: MultiChannelsSelect -Defined in: packages/types/dist/block-kit/block-elements.d.ts:428 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:442 ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_channels?: string[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:436 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:450 #### Description @@ -134,7 +134,7 @@ length for the `text` field in this object is 150 characters. type: "multi_channels_select"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:432 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:446 #### Description diff --git a/docs/english/reference/web-api/interfaces/MultiConversationsSelect.md b/docs/english/reference/web-api/interfaces/MultiConversationsSelect.md index d40dc740d..acf1ed053 100644 --- a/docs/english/reference/web-api/interfaces/MultiConversationsSelect.md +++ b/docs/english/reference/web-api/interfaces/MultiConversationsSelect.md @@ -2,7 +2,7 @@ # Interface: MultiConversationsSelect -Defined in: packages/types/dist/block-kit/block-elements.d.ts:382 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:396 ## Description @@ -63,7 +63,7 @@ with. optional default_to_current_conversation?: boolean; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:396 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:410 #### Description @@ -78,7 +78,7 @@ modal, if available. Default is `false`. optional filter?: object; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:400 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:414 #### exclude\_bot\_users? @@ -130,7 +130,7 @@ Defaults to `false`. optional initial_conversations?: string[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:391 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:405 #### Description @@ -182,7 +182,7 @@ length for the `text` field in this object is 150 characters. type: "multi_conversations_select"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:386 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:400 #### Description diff --git a/docs/english/reference/web-api/interfaces/MultiExternalSelect.md b/docs/english/reference/web-api/interfaces/MultiExternalSelect.md index b1c2a75e9..a3c46e934 100644 --- a/docs/english/reference/web-api/interfaces/MultiExternalSelect.md +++ b/docs/english/reference/web-api/interfaces/MultiExternalSelect.md @@ -2,7 +2,7 @@ # Interface: MultiExternalSelect -Defined in: packages/types/dist/block-kit/block-elements.d.ts:465 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:479 ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_options?: PlainTextOption[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:473 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:487 #### Description @@ -114,7 +114,7 @@ Specifies the maximum number of items that can be selected. Minimum number is 1. optional min_query_length?: number; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:479 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:493 #### Description @@ -149,7 +149,7 @@ length for the `text` field in this object is 150 characters. type: "multi_external_select"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:469 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:483 #### Description diff --git a/docs/english/reference/web-api/interfaces/MultiStaticSelect.md b/docs/english/reference/web-api/interfaces/MultiStaticSelect.md index 1edb74807..927905d1f 100644 --- a/docs/english/reference/web-api/interfaces/MultiStaticSelect.md +++ b/docs/english/reference/web-api/interfaces/MultiStaticSelect.md @@ -2,7 +2,7 @@ # Interface: MultiStaticSelect -Defined in: packages/types/dist/block-kit/block-elements.d.ts:322 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:336 ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_options?: PlainTextOption[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:331 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:345 #### Description @@ -116,7 +116,7 @@ Specifies the maximum number of items that can be selected. Minimum number is 1. optional option_groups?: object[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:341 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:355 #### label @@ -143,7 +143,7 @@ this field should not be. optional options?: PlainTextOption[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:336 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:350 #### Description @@ -177,7 +177,7 @@ length for the `text` field in this object is 150 characters. type: "multi_static_select"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:326 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:340 #### Description diff --git a/docs/english/reference/web-api/interfaces/MultiUsersSelect.md b/docs/english/reference/web-api/interfaces/MultiUsersSelect.md index e474cd955..865b23098 100644 --- a/docs/english/reference/web-api/interfaces/MultiUsersSelect.md +++ b/docs/english/reference/web-api/interfaces/MultiUsersSelect.md @@ -2,7 +2,7 @@ # Interface: MultiUsersSelect -Defined in: packages/types/dist/block-kit/block-elements.d.ts:276 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:290 ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_users?: string[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:284 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:298 #### Description @@ -134,7 +134,7 @@ length for the `text` field in this object is 150 characters. type: "multi_users_select"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:280 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:294 #### Description diff --git a/docs/english/reference/web-api/interfaces/NumberInput.md b/docs/english/reference/web-api/interfaces/NumberInput.md index ffee7e133..90901028f 100644 --- a/docs/english/reference/web-api/interfaces/NumberInput.md +++ b/docs/english/reference/web-api/interfaces/NumberInput.md @@ -2,7 +2,7 @@ # Interface: NumberInput -Defined in: packages/types/dist/block-kit/block-elements.d.ts:488 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:502 ## Description @@ -84,7 +84,7 @@ Defaults to `false`. optional initial_value?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:500 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:514 #### Description @@ -98,7 +98,7 @@ The initial value in the input when it is loaded. is_decimal_allowed: boolean; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:496 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:510 #### Description @@ -112,7 +112,7 @@ Decimal numbers are allowed if this property is `true`, set the value to `false` optional max_value?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:508 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:522 #### Description @@ -126,7 +126,7 @@ The maximum value, cannot be less than `min_value`. optional min_value?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:504 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:518 #### Description @@ -159,7 +159,7 @@ length for the `text` field in this object is 150 characters. type: "number_input"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:492 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:506 #### Description diff --git a/docs/english/reference/web-api/interfaces/Overflow.md b/docs/english/reference/web-api/interfaces/Overflow.md index 3d067acaa..dbe27c652 100644 --- a/docs/english/reference/web-api/interfaces/Overflow.md +++ b/docs/english/reference/web-api/interfaces/Overflow.md @@ -2,7 +2,7 @@ # Interface: Overflow -Defined in: packages/types/dist/block-kit/block-elements.d.ts:519 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:533 ## Description @@ -66,7 +66,7 @@ with. options: PlainTextOption[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:527 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:541 #### Description @@ -80,7 +80,7 @@ An array of up to 5 [PlainTextOption](PlainTextOption.md) to display in the menu type: "overflow"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:523 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:537 #### Description diff --git a/docs/english/reference/web-api/interfaces/PlainTextInput.md b/docs/english/reference/web-api/interfaces/PlainTextInput.md index 0f0ea0099..57a6d9012 100644 --- a/docs/english/reference/web-api/interfaces/PlainTextInput.md +++ b/docs/english/reference/web-api/interfaces/PlainTextInput.md @@ -2,7 +2,7 @@ # Interface: PlainTextInput -Defined in: packages/types/dist/block-kit/block-elements.d.ts:534 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:548 ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_value?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:542 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:556 #### Description @@ -96,7 +96,7 @@ The initial value in the plain-text input when it is loaded. optional max_length?: number; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:557 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:571 #### Description @@ -111,7 +111,7 @@ they will receive an error. optional min_length?: number; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:552 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:566 #### Description @@ -126,7 +126,7 @@ an error. Maximum value is 3000. optional multiline?: boolean; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:547 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:561 #### Description @@ -160,7 +160,7 @@ length for the `text` field in this object is 150 characters. type: "plain_text_input"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:538 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:552 #### Description diff --git a/docs/english/reference/web-api/interfaces/PlanBlock.md b/docs/english/reference/web-api/interfaces/PlanBlock.md index 735ceee8b..2e5a7e19e 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:483 +Defined in: packages/types/dist/block-kit/blocks.d.ts:547 ## 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:495 +Defined in: packages/types/dist/block-kit/blocks.d.ts:559 #### 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:491 +Defined in: packages/types/dist/block-kit/blocks.d.ts:555 #### Description @@ -74,7 +74,7 @@ Title of the plan in plain text. type: "plan"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:487 +Defined in: packages/types/dist/block-kit/blocks.d.ts:551 #### Description diff --git a/docs/english/reference/web-api/interfaces/RadioButtons.md b/docs/english/reference/web-api/interfaces/RadioButtons.md index 1cee3d1c4..64cda173b 100644 --- a/docs/english/reference/web-api/interfaces/RadioButtons.md +++ b/docs/english/reference/web-api/interfaces/RadioButtons.md @@ -2,7 +2,7 @@ # Interface: RadioButtons -Defined in: packages/types/dist/block-kit/block-elements.d.ts:564 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:578 ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_option?: Option; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:573 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:587 #### Description @@ -97,7 +97,7 @@ be selected when the radio button group initially loads. options: Option[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:577 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:591 #### Description @@ -111,7 +111,7 @@ An array of [Option](../type-aliases/Option.md) objects. A maximum of 10 options type: "radio_buttons"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:568 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:582 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextBlock.md b/docs/english/reference/web-api/interfaces/RichTextBlock.md index 7f6449137..7d76a0a1e 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:368 +Defined in: packages/types/dist/block-kit/blocks.d.ts:432 ## 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:373 +Defined in: packages/types/dist/block-kit/blocks.d.ts:437 *** @@ -61,7 +61,7 @@ Defined in: packages/types/dist/block-kit/blocks.d.ts:373 type: "rich_text"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:372 +Defined in: packages/types/dist/block-kit/blocks.d.ts:436 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextBroadcastMention.md b/docs/english/reference/web-api/interfaces/RichTextBroadcastMention.md index b26abfe5a..fd4a7f55c 100644 --- a/docs/english/reference/web-api/interfaces/RichTextBroadcastMention.md +++ b/docs/english/reference/web-api/interfaces/RichTextBroadcastMention.md @@ -2,7 +2,7 @@ # Interface: RichTextBroadcastMention -Defined in: packages/types/dist/block-kit/block-elements.d.ts:699 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:713 ## Description @@ -20,7 +20,7 @@ A broadcast mention element for use in a rich text message. range: "channel" | "here" | "everyone"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:707 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:721 #### Description @@ -102,7 +102,7 @@ A limited style object for styling rich text `text` elements. type: "broadcast"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:703 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:717 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextChannelMention.md b/docs/english/reference/web-api/interfaces/RichTextChannelMention.md index ea3032ef3..f52a3c469 100644 --- a/docs/english/reference/web-api/interfaces/RichTextChannelMention.md +++ b/docs/english/reference/web-api/interfaces/RichTextChannelMention.md @@ -2,7 +2,7 @@ # Interface: RichTextChannelMention -Defined in: packages/types/dist/block-kit/block-elements.d.ts:725 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:739 ## Description @@ -20,7 +20,7 @@ A channel mention element for use in a rich text message. channel_id: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:733 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:747 #### Description @@ -102,7 +102,7 @@ A limited style object for styling rich text `text` elements. type: "channel"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:729 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:743 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextColor.md b/docs/english/reference/web-api/interfaces/RichTextColor.md index 7ef5a1363..c194d3f61 100644 --- a/docs/english/reference/web-api/interfaces/RichTextColor.md +++ b/docs/english/reference/web-api/interfaces/RichTextColor.md @@ -2,7 +2,7 @@ # Interface: RichTextColor -Defined in: packages/types/dist/block-kit/block-elements.d.ts:712 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:726 ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. type: "color"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:716 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:730 #### Description @@ -102,7 +102,7 @@ The type of element. In this case `type` is always `color`. value: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:720 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:734 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextDate.md b/docs/english/reference/web-api/interfaces/RichTextDate.md index 4a2fb9613..203e21824 100644 --- a/docs/english/reference/web-api/interfaces/RichTextDate.md +++ b/docs/english/reference/web-api/interfaces/RichTextDate.md @@ -2,7 +2,7 @@ # Interface: RichTextDate -Defined in: packages/types/dist/block-kit/block-elements.d.ts:738 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:752 ## Description @@ -20,7 +20,7 @@ A date element for use in a rich text message. optional fallback?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:778 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:792 #### Description @@ -34,7 +34,7 @@ Text to display in place of the date should parsing, formatting or displaying fa format: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:770 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:784 #### Description @@ -136,7 +136,7 @@ A limited style object for styling rich text `text` elements. timestamp: number; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:746 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:760 #### Description @@ -150,7 +150,7 @@ A UNIX timestamp for the date to be displayed in seconds. type: "date"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:742 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:756 #### Description @@ -164,7 +164,7 @@ The type of element. In this case `type` is always `date`. optional url?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:774 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:788 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextEmoji.md b/docs/english/reference/web-api/interfaces/RichTextEmoji.md index 24650722f..59dac9823 100644 --- a/docs/english/reference/web-api/interfaces/RichTextEmoji.md +++ b/docs/english/reference/web-api/interfaces/RichTextEmoji.md @@ -2,7 +2,7 @@ # Interface: RichTextEmoji -Defined in: packages/types/dist/block-kit/block-elements.d.ts:783 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:797 ## Description @@ -20,7 +20,7 @@ An emoji element for use in a rich text message. name: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:791 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:805 #### Description @@ -102,7 +102,7 @@ A limited style object for styling rich text `text` elements. type: "emoji"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:787 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:801 #### Description @@ -116,7 +116,7 @@ The type of element. In this case `type` is always `emoji`. optional unicode?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:795 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:809 #### Description @@ -130,7 +130,7 @@ Lowercase hexadecimal Unicode representation of a standard emoji (not for use wi optional url?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:799 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:813 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextInput.md b/docs/english/reference/web-api/interfaces/RichTextInput.md index f41ef2c74..3b29fe987 100644 --- a/docs/english/reference/web-api/interfaces/RichTextInput.md +++ b/docs/english/reference/web-api/interfaces/RichTextInput.md @@ -2,7 +2,7 @@ # Interface: RichTextInput -Defined in: packages/types/dist/block-kit/block-elements.d.ts:943 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:957 ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_value?: RichTextBlock; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:951 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:965 #### Description @@ -97,7 +97,7 @@ Initial contents of the input when it is loaded. optional max_lines?: number; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:960 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:974 #### Description @@ -112,7 +112,7 @@ Defaults to `8` when not specified. optional min_lines?: number; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:955 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:969 #### Description @@ -145,7 +145,7 @@ length for the `text` field in this object is 150 characters. type: "rich_text_input"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:947 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:961 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextLink.md b/docs/english/reference/web-api/interfaces/RichTextLink.md index 4a1c00bed..35189a833 100644 --- a/docs/english/reference/web-api/interfaces/RichTextLink.md +++ b/docs/english/reference/web-api/interfaces/RichTextLink.md @@ -2,7 +2,7 @@ # Interface: RichTextLink -Defined in: packages/types/dist/block-kit/block-elements.d.ts:804 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:818 ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. optional text?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:812 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:826 #### Description @@ -102,7 +102,7 @@ The text to link. type: "link"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:808 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:822 #### Description @@ -116,7 +116,7 @@ The type of element. In this case `type` is always `link`. optional unsafe?: boolean; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:816 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:830 #### Description @@ -130,7 +130,7 @@ TODO: ? url: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:820 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:834 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextList.md b/docs/english/reference/web-api/interfaces/RichTextList.md index 2b89d9f78..c82337ced 100644 --- a/docs/english/reference/web-api/interfaces/RichTextList.md +++ b/docs/english/reference/web-api/interfaces/RichTextList.md @@ -2,7 +2,7 @@ # Interface: RichTextList -Defined in: packages/types/dist/block-kit/block-elements.d.ts:891 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:905 ## Description @@ -39,7 +39,7 @@ while `1` renders a border. elements: RichTextSection[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:899 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:913 #### Description @@ -53,7 +53,7 @@ An array of [RichTextSection](RichTextSection.md) elements comprising each list optional indent?: number; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:909 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:923 #### Description @@ -68,7 +68,7 @@ or characters rendered as the list points. Also affected by the `style` property style: "bullet" | "ordered"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:904 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:918 #### Description @@ -83,7 +83,7 @@ The type of list. Can be either `bullet` (the list points are all rendered the s type: "rich_text_list"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:895 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:909 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextPreformatted.md b/docs/english/reference/web-api/interfaces/RichTextPreformatted.md index 4dce3e2f0..de0f5fb8a 100644 --- a/docs/english/reference/web-api/interfaces/RichTextPreformatted.md +++ b/docs/english/reference/web-api/interfaces/RichTextPreformatted.md @@ -2,7 +2,7 @@ # Interface: RichTextPreformatted -Defined in: packages/types/dist/block-kit/block-elements.d.ts:927 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:941 ## Description @@ -39,7 +39,7 @@ while `1` renders a border. elements: (RichTextLink | RichTextText)[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:935 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:949 #### Description @@ -53,7 +53,7 @@ An array of either [RichTextLink](RichTextLink.md) or [RichTextText](RichTextTex type: "rich_text_preformatted"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:931 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:945 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextQuote.md b/docs/english/reference/web-api/interfaces/RichTextQuote.md index b8e43c7b5..639390ba5 100644 --- a/docs/english/reference/web-api/interfaces/RichTextQuote.md +++ b/docs/english/reference/web-api/interfaces/RichTextQuote.md @@ -2,7 +2,7 @@ # Interface: RichTextQuote -Defined in: packages/types/dist/block-kit/block-elements.d.ts:914 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:928 ## Description @@ -39,7 +39,7 @@ while `1` renders a border. elements: RichTextElement[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:922 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:936 #### Description @@ -53,7 +53,7 @@ An array of [RichTextElement](../type-aliases/RichTextElement.md) comprising the type: "rich_text_quote"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:918 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:932 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextSection.md b/docs/english/reference/web-api/interfaces/RichTextSection.md index 683523083..206a8a4bd 100644 --- a/docs/english/reference/web-api/interfaces/RichTextSection.md +++ b/docs/english/reference/web-api/interfaces/RichTextSection.md @@ -2,7 +2,7 @@ # Interface: RichTextSection -Defined in: packages/types/dist/block-kit/block-elements.d.ts:881 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:895 ## Description @@ -16,7 +16,7 @@ A section block within a rich text field. elements: RichTextElement[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:886 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:900 *** @@ -26,7 +26,7 @@ Defined in: packages/types/dist/block-kit/block-elements.d.ts:886 type: "rich_text_section"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:885 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:899 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextTeamMention.md b/docs/english/reference/web-api/interfaces/RichTextTeamMention.md index fea0c8741..1de309b70 100644 --- a/docs/english/reference/web-api/interfaces/RichTextTeamMention.md +++ b/docs/english/reference/web-api/interfaces/RichTextTeamMention.md @@ -2,7 +2,7 @@ # Interface: RichTextTeamMention -Defined in: packages/types/dist/block-kit/block-elements.d.ts:825 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:839 ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. team_id: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:833 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:847 #### Description @@ -102,7 +102,7 @@ The encoded team ID, e.g. T1234ABCD. type: "team"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:829 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:843 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextText.md b/docs/english/reference/web-api/interfaces/RichTextText.md index 6d1ddf563..5ecf6313c 100644 --- a/docs/english/reference/web-api/interfaces/RichTextText.md +++ b/docs/english/reference/web-api/interfaces/RichTextText.md @@ -2,7 +2,7 @@ # Interface: RichTextText -Defined in: packages/types/dist/block-kit/block-elements.d.ts:838 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:852 ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. text: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:846 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:860 #### Description @@ -102,7 +102,7 @@ The text to render. type: "text"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:842 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:856 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextUserMention.md b/docs/english/reference/web-api/interfaces/RichTextUserMention.md index 4a38a0e3b..80331553f 100644 --- a/docs/english/reference/web-api/interfaces/RichTextUserMention.md +++ b/docs/english/reference/web-api/interfaces/RichTextUserMention.md @@ -2,7 +2,7 @@ # Interface: RichTextUserMention -Defined in: packages/types/dist/block-kit/block-elements.d.ts:851 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:865 ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. type: "user"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:855 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:869 #### Description @@ -102,7 +102,7 @@ The type of element. In this case `type` is always `user`. user_id: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:859 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:873 #### Description diff --git a/docs/english/reference/web-api/interfaces/RichTextUsergroupMention.md b/docs/english/reference/web-api/interfaces/RichTextUsergroupMention.md index 2a7561aa1..67c8add79 100644 --- a/docs/english/reference/web-api/interfaces/RichTextUsergroupMention.md +++ b/docs/english/reference/web-api/interfaces/RichTextUsergroupMention.md @@ -2,7 +2,7 @@ # Interface: RichTextUsergroupMention -Defined in: packages/types/dist/block-kit/block-elements.d.ts:864 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:878 ## Description @@ -88,7 +88,7 @@ A limited style object for styling rich text `text` elements. type: "usergroup"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:868 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:882 #### Description @@ -102,7 +102,7 @@ The type of element. In this case `type` is always `usergroup`. usergroup_id: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:872 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:886 #### Description diff --git a/docs/english/reference/web-api/interfaces/SectionBlock.md b/docs/english/reference/web-api/interfaces/SectionBlock.md index 3fbba7dbf..43bd21cb7 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:386 +Defined in: packages/types/dist/block-kit/blocks.d.ts:450 ## 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:407 +Defined in: packages/types/dist/block-kit/blocks.d.ts:471 #### 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:411 +Defined in: packages/types/dist/block-kit/blocks.d.ts:475 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:403 +Defined in: packages/types/dist/block-kit/blocks.d.ts:467 #### 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:396 +Defined in: packages/types/dist/block-kit/blocks.d.ts:460 #### Description @@ -107,7 +107,7 @@ is provided instead. type: "section"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:390 +Defined in: packages/types/dist/block-kit/blocks.d.ts:454 #### Description diff --git a/docs/english/reference/web-api/interfaces/StaticSelect.md b/docs/english/reference/web-api/interfaces/StaticSelect.md index 5211c8ecf..efa9b2289 100644 --- a/docs/english/reference/web-api/interfaces/StaticSelect.md +++ b/docs/english/reference/web-api/interfaces/StaticSelect.md @@ -2,7 +2,7 @@ # Interface: StaticSelect -Defined in: packages/types/dist/block-kit/block-elements.d.ts:292 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:306 ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_option?: PlainTextOption; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:301 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:315 #### Description @@ -98,7 +98,7 @@ This option will be selected when the menu initially loads. optional option_groups?: object[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:311 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:325 #### label @@ -125,7 +125,7 @@ this field should not be. optional options?: PlainTextOption[]; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:306 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:320 #### Description @@ -159,7 +159,7 @@ length for the `text` field in this object is 150 characters. type: "static_select"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:296 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:310 #### Description diff --git a/docs/english/reference/web-api/interfaces/TableBlock.md b/docs/english/reference/web-api/interfaces/TableBlock.md index a5393d7c3..54a9279e4 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:417 +Defined in: packages/types/dist/block-kit/blocks.d.ts:481 ## 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:429 +Defined in: packages/types/dist/block-kit/blocks.d.ts:493 #### Description @@ -63,7 +63,7 @@ rows: ( | RawNumberElement)[][]; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:425 +Defined in: packages/types/dist/block-kit/blocks.d.ts:489 #### Description @@ -77,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:421 +Defined in: packages/types/dist/block-kit/blocks.d.ts:485 #### Description diff --git a/docs/english/reference/web-api/interfaces/TaskCardBlock.md b/docs/english/reference/web-api/interfaces/TaskCardBlock.md index ee3a2a2b1..f09fc90fb 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:449 +Defined in: packages/types/dist/block-kit/blocks.d.ts:513 ## 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:465 +Defined in: packages/types/dist/block-kit/blocks.d.ts:529 #### 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:469 +Defined in: packages/types/dist/block-kit/blocks.d.ts:533 #### 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:473 +Defined in: packages/types/dist/block-kit/blocks.d.ts:537 #### 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:477 +Defined in: packages/types/dist/block-kit/blocks.d.ts:541 #### 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:457 +Defined in: packages/types/dist/block-kit/blocks.d.ts:521 #### Description @@ -116,7 +116,7 @@ ID for the task. title: string; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:461 +Defined in: packages/types/dist/block-kit/blocks.d.ts:525 #### 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:453 +Defined in: packages/types/dist/block-kit/blocks.d.ts:517 #### Description diff --git a/docs/english/reference/web-api/interfaces/ThreadBroadcastMessageEvent.md b/docs/english/reference/web-api/interfaces/ThreadBroadcastMessageEvent.md index f6437e44c..a0b24bbfd 100644 --- a/docs/english/reference/web-api/interfaces/ThreadBroadcastMessageEvent.md +++ b/docs/english/reference/web-api/interfaces/ThreadBroadcastMessageEvent.md @@ -32,7 +32,7 @@ Defined in: packages/types/dist/events/message.d.ts:233 channel: string; ``` -Defined in: packages/types/dist/events/message.d.ts:245 +Defined in: packages/types/dist/events/message.d.ts:249 *** @@ -42,7 +42,7 @@ Defined in: packages/types/dist/events/message.d.ts:245 channel_type: ChannelTypes; ``` -Defined in: packages/types/dist/events/message.d.ts:246 +Defined in: packages/types/dist/events/message.d.ts:250 *** @@ -52,7 +52,17 @@ Defined in: packages/types/dist/events/message.d.ts:246 client_msg_id: string; ``` -Defined in: packages/types/dist/events/message.d.ts:244 +Defined in: packages/types/dist/events/message.d.ts:248 + +*** + +### display\_as\_bot? + +```ts +optional display_as_bot?: boolean; +``` + +Defined in: packages/types/dist/events/message.d.ts:236 *** @@ -66,6 +76,26 @@ Defined in: packages/types/dist/events/message.d.ts:230 *** +### files? + +```ts +optional files?: File[]; +``` + +Defined in: packages/types/dist/events/message.d.ts:234 + +*** + +### parent\_user\_id? + +```ts +optional parent_user_id?: string; +``` + +Defined in: packages/types/dist/events/message.d.ts:238 + +*** + ### root ```ts @@ -74,7 +104,7 @@ root: | BotMessageEvent & object; ``` -Defined in: packages/types/dist/events/message.d.ts:237 +Defined in: packages/types/dist/events/message.d.ts:241 #### Type Declaration @@ -136,7 +166,7 @@ Defined in: packages/types/dist/events/message.d.ts:231 optional thread_ts?: string; ``` -Defined in: packages/types/dist/events/message.d.ts:236 +Defined in: packages/types/dist/events/message.d.ts:240 *** @@ -146,7 +176,7 @@ Defined in: packages/types/dist/events/message.d.ts:236 ts: string; ``` -Defined in: packages/types/dist/events/message.d.ts:235 +Defined in: packages/types/dist/events/message.d.ts:239 *** @@ -160,10 +190,20 @@ Defined in: packages/types/dist/events/message.d.ts:228 *** +### upload? + +```ts +optional upload?: boolean; +``` + +Defined in: packages/types/dist/events/message.d.ts:235 + +*** + ### user ```ts user: string; ``` -Defined in: packages/types/dist/events/message.d.ts:234 +Defined in: packages/types/dist/events/message.d.ts:237 diff --git a/docs/english/reference/web-api/interfaces/Timepicker.md b/docs/english/reference/web-api/interfaces/Timepicker.md index 9eaf3704c..646b7e106 100644 --- a/docs/english/reference/web-api/interfaces/Timepicker.md +++ b/docs/english/reference/web-api/interfaces/Timepicker.md @@ -2,7 +2,7 @@ # Interface: Timepicker -Defined in: packages/types/dist/block-kit/block-elements.d.ts:586 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:600 ## Description @@ -84,7 +84,7 @@ Defaults to `false`. optional initial_time?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:596 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:610 #### Description @@ -119,7 +119,7 @@ length for the `text` field in this object is 150 characters. optional timezone?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:601 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:615 #### Description @@ -134,7 +134,7 @@ text underneath the time picker. It is also passed to the app upon certain inter type: "timepicker"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:590 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:604 #### Description diff --git a/docs/english/reference/web-api/interfaces/URLInput.md b/docs/english/reference/web-api/interfaces/URLInput.md index bcef1f53e..44e71b048 100644 --- a/docs/english/reference/web-api/interfaces/URLInput.md +++ b/docs/english/reference/web-api/interfaces/URLInput.md @@ -2,7 +2,7 @@ # Interface: URLInput -Defined in: packages/types/dist/block-kit/block-elements.d.ts:608 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:622 ## Description @@ -82,7 +82,7 @@ Defaults to `false`. optional initial_value?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:616 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:630 #### Description @@ -115,7 +115,7 @@ length for the `text` field in this object is 150 characters. type: "url_text_input"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:612 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:626 #### Description diff --git a/docs/english/reference/web-api/interfaces/URLSourceElement.md b/docs/english/reference/web-api/interfaces/URLSourceElement.md index 68cdd38e0..77e8a067a 100644 --- a/docs/english/reference/web-api/interfaces/URLSourceElement.md +++ b/docs/english/reference/web-api/interfaces/URLSourceElement.md @@ -2,7 +2,7 @@ # Interface: URLSourceElement -Defined in: packages/types/dist/block-kit/block-elements.d.ts:622 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:636 ## Description @@ -20,7 +20,7 @@ A URL source element that displays a URL source for referencing within a task ca text: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:634 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:648 #### Description @@ -34,7 +34,7 @@ Display text for the URL. type: "url"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:626 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:640 #### Description @@ -48,7 +48,7 @@ The type of element. In this case `type` is always `url`. url: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:630 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:644 #### Description diff --git a/docs/english/reference/web-api/interfaces/UserConnectionConnectEvent.md b/docs/english/reference/web-api/interfaces/UserConnectionConnectEvent.md new file mode 100644 index 000000000..50ba773aa --- /dev/null +++ b/docs/english/reference/web-api/interfaces/UserConnectionConnectEvent.md @@ -0,0 +1,55 @@ +[@slack/web-api](../index.md) / UserConnectionConnectEvent + +# Interface: UserConnectionConnectEvent + +Defined in: packages/types/dist/events/user.d.ts:81 + +## Properties + +### event\_ts + +```ts +event_ts: string; +``` + +Defined in: packages/types/dist/events/user.d.ts:86 + +*** + +### subtype + +```ts +subtype: "connect"; +``` + +Defined in: packages/types/dist/events/user.d.ts:83 + +*** + +### trigger\_id + +```ts +trigger_id: string; +``` + +Defined in: packages/types/dist/events/user.d.ts:85 + +*** + +### type + +```ts +type: "user_connection"; +``` + +Defined in: packages/types/dist/events/user.d.ts:82 + +*** + +### user + +```ts +user: string; +``` + +Defined in: packages/types/dist/events/user.d.ts:84 diff --git a/docs/english/reference/web-api/interfaces/UserConnectionDisconnectEvent.md b/docs/english/reference/web-api/interfaces/UserConnectionDisconnectEvent.md new file mode 100644 index 000000000..3f894bbb1 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/UserConnectionDisconnectEvent.md @@ -0,0 +1,55 @@ +[@slack/web-api](../index.md) / UserConnectionDisconnectEvent + +# Interface: UserConnectionDisconnectEvent + +Defined in: packages/types/dist/events/user.d.ts:88 + +## Properties + +### enterprise\_id? + +```ts +optional enterprise_id?: string; +``` + +Defined in: packages/types/dist/events/user.d.ts:92 + +*** + +### event\_ts + +```ts +event_ts: string; +``` + +Defined in: packages/types/dist/events/user.d.ts:93 + +*** + +### subtype + +```ts +subtype: "disconnect"; +``` + +Defined in: packages/types/dist/events/user.d.ts:90 + +*** + +### type + +```ts +type: "user_connection"; +``` + +Defined in: packages/types/dist/events/user.d.ts:89 + +*** + +### user + +```ts +user: string; +``` + +Defined in: packages/types/dist/events/user.d.ts:91 diff --git a/docs/english/reference/web-api/interfaces/UserConnectionPrimaryProvider.md b/docs/english/reference/web-api/interfaces/UserConnectionPrimaryProvider.md new file mode 100644 index 000000000..6e2c4f8a9 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/UserConnectionPrimaryProvider.md @@ -0,0 +1,147 @@ +[@slack/web-api](../index.md) / UserConnectionPrimaryProvider + +# Interface: UserConnectionPrimaryProvider + +Defined in: [packages/web-api/src/types/request/apps.ts:59](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L59) + +## Properties + +### accessory? + +```ts +optional accessory?: Overflow; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:85](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L85) + +#### Description + +Overflow menu shown when connected (e.g., Disconnect, Re-authenticate). + +*** + +### auth\_url? + +```ts +optional auth_url?: string; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:77](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L77) + +#### Description + +OAuth redirect URL opened when the user clicks **Connect**. Must be HTTPs format. + +*** + +### connected\_context? + +```ts +optional connected_context?: PlainTextElement; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:83](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L83) + +#### Description + +Additional context about the connection (e.g., org or workspace name). + +*** + +### connected\_identity? + +```ts +optional connected_identity?: PlainTextElement; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:81](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L81) + +#### Description + +Display name of the connected account, shown when `is_connected` is `true`. + +*** + +### description? + +```ts +optional description?: PlainTextElement; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:73](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L73) + +#### Description + +Brief description of what this connection enables. + +*** + +### disconnect\_url? + +```ts +optional disconnect_url?: string; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:79](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L79) + +#### Description + +URL opened when the user clicks **Disconnect**. Must be HTTPs format on a registered auth host. + +*** + +### icon\_url? + +```ts +optional icon_url?: string; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:75](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L75) + +#### Description + +URL for the provider icon image. Must be HTTPs format. Falls back to the app's avatar when absent. + +*** + +### is\_connected + +```ts +is_connected: boolean; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:71](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L71) + +#### Description + +Whether this provider is currently connected or disconnected. Slack records this state for the user, +so an omitted value would be indistinguishable from an explicit `false` and silently mark the user disconnected. + +*** + +### name + +```ts +name: PlainTextElement; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:66](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L66) + +#### Description + +Human-readable name of the provider. + +*** + +### value + +```ts +value: string; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:64](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L64) + +#### Description + +Unique identifier for this provider within the app. Included in interaction payloads and used to +derive the connect button `action_id` (`auth_provider_connect_`). diff --git a/docs/english/reference/web-api/interfaces/UserConnectionStatusRequestedEvent.md b/docs/english/reference/web-api/interfaces/UserConnectionStatusRequestedEvent.md new file mode 100644 index 000000000..113596cfa --- /dev/null +++ b/docs/english/reference/web-api/interfaces/UserConnectionStatusRequestedEvent.md @@ -0,0 +1,35 @@ +[@slack/web-api](../index.md) / UserConnectionStatusRequestedEvent + +# Interface: UserConnectionStatusRequestedEvent + +Defined in: packages/types/dist/events/user.d.ts:95 + +## Properties + +### event\_ts + +```ts +event_ts: string; +``` + +Defined in: packages/types/dist/events/user.d.ts:98 + +*** + +### type + +```ts +type: "user_connection_status_requested"; +``` + +Defined in: packages/types/dist/events/user.d.ts:96 + +*** + +### user + +```ts +user: string; +``` + +Defined in: packages/types/dist/events/user.d.ts:97 diff --git a/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md b/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md index 7f0fa0049..9a49bbaa3 100644 --- a/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md @@ -2,7 +2,7 @@ # Interface: UserHuddleChangedEvent -Defined in: packages/types/dist/events/user.d.ts:80 +Defined in: packages/types/dist/events/user.d.ts:100 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/types/dist/events/user.d.ts:80 cache_ts: number; ``` -Defined in: packages/types/dist/events/user.d.ts:156 +Defined in: packages/types/dist/events/user.d.ts:176 *** @@ -22,7 +22,7 @@ Defined in: packages/types/dist/events/user.d.ts:156 event_ts: string; ``` -Defined in: packages/types/dist/events/user.d.ts:157 +Defined in: packages/types/dist/events/user.d.ts:177 *** @@ -32,7 +32,7 @@ Defined in: packages/types/dist/events/user.d.ts:157 type: "user_huddle_changed"; ``` -Defined in: packages/types/dist/events/user.d.ts:81 +Defined in: packages/types/dist/events/user.d.ts:101 *** @@ -42,7 +42,7 @@ Defined in: packages/types/dist/events/user.d.ts:81 user: object; ``` -Defined in: packages/types/dist/events/user.d.ts:82 +Defined in: packages/types/dist/events/user.d.ts:102 #### color diff --git a/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md b/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md index abe58e748..e74ba2b70 100644 --- a/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md @@ -2,7 +2,7 @@ # Interface: UserProfileChangedEvent -Defined in: packages/types/dist/events/user.d.ts:159 +Defined in: packages/types/dist/events/user.d.ts:179 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/types/dist/events/user.d.ts:159 cache_ts: number; ``` -Defined in: packages/types/dist/events/user.d.ts:234 +Defined in: packages/types/dist/events/user.d.ts:254 *** @@ -22,7 +22,7 @@ Defined in: packages/types/dist/events/user.d.ts:234 event_ts: string; ``` -Defined in: packages/types/dist/events/user.d.ts:235 +Defined in: packages/types/dist/events/user.d.ts:255 *** @@ -32,7 +32,7 @@ Defined in: packages/types/dist/events/user.d.ts:235 type: "user_profile_changed"; ``` -Defined in: packages/types/dist/events/user.d.ts:160 +Defined in: packages/types/dist/events/user.d.ts:180 *** @@ -42,7 +42,7 @@ Defined in: packages/types/dist/events/user.d.ts:160 user: object; ``` -Defined in: packages/types/dist/events/user.d.ts:161 +Defined in: packages/types/dist/events/user.d.ts:181 #### color diff --git a/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md b/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md index 52a9b6f8e..a41b274d0 100644 --- a/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md @@ -2,7 +2,7 @@ # Interface: UserStatusChangedEvent -Defined in: packages/types/dist/events/user.d.ts:237 +Defined in: packages/types/dist/events/user.d.ts:257 ## Properties @@ -12,7 +12,7 @@ Defined in: packages/types/dist/events/user.d.ts:237 cache_ts: number; ``` -Defined in: packages/types/dist/events/user.d.ts:310 +Defined in: packages/types/dist/events/user.d.ts:330 *** @@ -22,7 +22,7 @@ Defined in: packages/types/dist/events/user.d.ts:310 event_ts: string; ``` -Defined in: packages/types/dist/events/user.d.ts:311 +Defined in: packages/types/dist/events/user.d.ts:331 *** @@ -32,7 +32,7 @@ Defined in: packages/types/dist/events/user.d.ts:311 type: "user_status_changed"; ``` -Defined in: packages/types/dist/events/user.d.ts:238 +Defined in: packages/types/dist/events/user.d.ts:258 *** @@ -42,7 +42,7 @@ Defined in: packages/types/dist/events/user.d.ts:238 user: object; ``` -Defined in: packages/types/dist/events/user.d.ts:239 +Defined in: packages/types/dist/events/user.d.ts:259 #### color diff --git a/docs/english/reference/web-api/interfaces/UsersSelect.md b/docs/english/reference/web-api/interfaces/UsersSelect.md index 0822a567d..e728ca2e0 100644 --- a/docs/english/reference/web-api/interfaces/UsersSelect.md +++ b/docs/english/reference/web-api/interfaces/UsersSelect.md @@ -2,7 +2,7 @@ # Interface: UsersSelect -Defined in: packages/types/dist/block-kit/block-elements.d.ts:260 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:274 ## Description @@ -83,7 +83,7 @@ Defaults to `false`. optional initial_user?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:268 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:282 #### Description @@ -116,7 +116,7 @@ length for the `text` field in this object is 150 characters. type: "users_select"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:264 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:278 #### Description diff --git a/docs/english/reference/web-api/interfaces/VideoBlock.md b/docs/english/reference/web-api/interfaces/VideoBlock.md index aa7e31145..70f29fb95 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:503 +Defined in: packages/types/dist/block-kit/blocks.d.ts:567 ## 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:521 +Defined in: packages/types/dist/block-kit/blocks.d.ts:585 #### 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:534 +Defined in: packages/types/dist/block-kit/blocks.d.ts:598 #### 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:546 +Defined in: packages/types/dist/block-kit/blocks.d.ts:610 #### 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:542 +Defined in: packages/types/dist/block-kit/blocks.d.ts:606 #### 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:538 +Defined in: packages/types/dist/block-kit/blocks.d.ts:602 #### 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:517 +Defined in: packages/types/dist/block-kit/blocks.d.ts:581 #### Description @@ -132,7 +132,7 @@ The thumbnail image URL. title: PlainTextElement; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:525 +Defined in: packages/types/dist/block-kit/blocks.d.ts:589 #### 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:530 +Defined in: packages/types/dist/block-kit/blocks.d.ts:594 #### Description @@ -161,7 +161,7 @@ Must go to an HTTPS URL. type: "video"; ``` -Defined in: packages/types/dist/block-kit/blocks.d.ts:507 +Defined in: packages/types/dist/block-kit/blocks.d.ts:571 #### 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:513 +Defined in: packages/types/dist/block-kit/blocks.d.ts:577 #### Description diff --git a/docs/english/reference/web-api/interfaces/WorkflowButton.md b/docs/english/reference/web-api/interfaces/WorkflowButton.md index 6bfcce482..860fad36a 100644 --- a/docs/english/reference/web-api/interfaces/WorkflowButton.md +++ b/docs/english/reference/web-api/interfaces/WorkflowButton.md @@ -2,7 +2,7 @@ # Interface: WorkflowButton -Defined in: packages/types/dist/block-kit/block-elements.d.ts:640 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:654 ## Description @@ -24,7 +24,7 @@ Allows users to run a [link trigger](https://docs.slack.dev/tools/deno-slack-sdk optional accessibility_label?: string; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:694 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:708 #### Description @@ -76,7 +76,7 @@ with. optional style?: ColorScheme; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:689 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:703 #### Description @@ -95,7 +95,7 @@ If you don't include this field, the default button style will be used. text: PlainTextElement; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:649 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:663 #### Description @@ -110,7 +110,7 @@ Maximum length for the `text` in this field is 75 characters. type: "workflow_button"; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:644 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:658 #### Description @@ -128,7 +128,7 @@ The type of element. In this case `type` is always `workflow_button`. workflow: object; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:653 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:667 #### trigger diff --git a/docs/english/reference/web-api/type-aliases/AppsConnectionsOpenArguments.md b/docs/english/reference/web-api/type-aliases/AppsConnectionsOpenArguments.md index 7d910241b..99adc0b0c 100644 --- a/docs/english/reference/web-api/type-aliases/AppsConnectionsOpenArguments.md +++ b/docs/english/reference/web-api/type-aliases/AppsConnectionsOpenArguments.md @@ -6,4 +6,4 @@ type AppsConnectionsOpenArguments = OptionalArgument; ``` -Defined in: [packages/web-api/src/types/request/apps.ts:7](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L7) +Defined in: [packages/web-api/src/types/request/apps.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L9) diff --git a/docs/english/reference/web-api/type-aliases/AppsUserConnectionBulkUpdateArguments.md b/docs/english/reference/web-api/type-aliases/AppsUserConnectionBulkUpdateArguments.md new file mode 100644 index 000000000..7d9b485f7 --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/AppsUserConnectionBulkUpdateArguments.md @@ -0,0 +1,9 @@ +[@slack/web-api](../index.md) / AppsUserConnectionBulkUpdateArguments + +# Type Alias: AppsUserConnectionBulkUpdateArguments + +```ts +type AppsUserConnectionBulkUpdateArguments = TokenOverridable & UserConnectionConnectedUserIDs | UserConnectionDisconnectedUserIDs; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:56](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L56) diff --git a/docs/english/reference/web-api/type-aliases/AppsUserConnectionBulkUpdateResponse.md b/docs/english/reference/web-api/type-aliases/AppsUserConnectionBulkUpdateResponse.md new file mode 100644 index 000000000..86169b3a1 --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/AppsUserConnectionBulkUpdateResponse.md @@ -0,0 +1,59 @@ +[@slack/web-api](../index.md) / AppsUserConnectionBulkUpdateResponse + +# Type Alias: AppsUserConnectionBulkUpdateResponse + +```ts +type AppsUserConnectionBulkUpdateResponse = WebAPICallResult & object; +``` + +Defined in: [packages/web-api/src/types/response/AppsUserConnectionBulkUpdateResponse.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsUserConnectionBulkUpdateResponse.ts#L11) + +## Type Declaration + +### changed\_user\_ids? + +```ts +optional changed_user_ids?: string[]; +``` + +### error? + +```ts +optional error?: string; +``` + +### failures? + +```ts +optional failures?: Failure[]; +``` + +### needed? + +```ts +optional needed?: string; +``` + +### ok? + +```ts +optional ok?: boolean; +``` + +### provided? + +```ts +optional provided?: string; +``` + +### response\_metadata? + +```ts +optional response_metadata?: ResponseMetadata; +``` + +### warning? + +```ts +optional warning?: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/AppsUserConnectionRequestAuthArguments.md b/docs/english/reference/web-api/type-aliases/AppsUserConnectionRequestAuthArguments.md new file mode 100644 index 000000000..a0d546f17 --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/AppsUserConnectionRequestAuthArguments.md @@ -0,0 +1,21 @@ +[@slack/web-api](../index.md) / AppsUserConnectionRequestAuthArguments + +# Type Alias: AppsUserConnectionRequestAuthArguments + +```ts +type AppsUserConnectionRequestAuthArguments = TokenOverridable & UserConnectionTriggerID | UserConnectionUserID & object; +``` + +Defined in: [packages/web-api/src/types/request/apps.ts:102](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/apps.ts#L102) + +## Type Declaration + +### primary\_provider + +```ts +primary_provider: UserConnectionPrimaryProvider; +``` + +#### Description + +The connection to render. Its `icon_url` defaults to the app's own avatar when omitted. diff --git a/docs/english/reference/web-api/type-aliases/AppsUserConnectionRequestAuthResponse.md b/docs/english/reference/web-api/type-aliases/AppsUserConnectionRequestAuthResponse.md new file mode 100644 index 000000000..0d5186e0d --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/AppsUserConnectionRequestAuthResponse.md @@ -0,0 +1,47 @@ +[@slack/web-api](../index.md) / AppsUserConnectionRequestAuthResponse + +# Type Alias: AppsUserConnectionRequestAuthResponse + +```ts +type AppsUserConnectionRequestAuthResponse = WebAPICallResult & object; +``` + +Defined in: [packages/web-api/src/types/response/AppsUserConnectionRequestAuthResponse.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/AppsUserConnectionRequestAuthResponse.ts#L11) + +## Type Declaration + +### error? + +```ts +optional error?: string; +``` + +### needed? + +```ts +optional needed?: string; +``` + +### ok? + +```ts +optional ok?: boolean; +``` + +### provided? + +```ts +optional provided?: string; +``` + +### response\_metadata? + +```ts +optional response_metadata?: ResponseMetadata; +``` + +### warning? + +```ts +optional warning?: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/CanvasesGetContentResponse.md b/docs/english/reference/web-api/type-aliases/CanvasesGetContentResponse.md new file mode 100644 index 000000000..a63e52c9c --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/CanvasesGetContentResponse.md @@ -0,0 +1,47 @@ +[@slack/web-api](../index.md) / CanvasesGetContentResponse + +# Type Alias: CanvasesGetContentResponse + +```ts +type CanvasesGetContentResponse = WebAPICallResult & object; +``` + +Defined in: [packages/web-api/src/types/response/CanvasesGetContentResponse.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/CanvasesGetContentResponse.ts#L11) + +## Type Declaration + +### content? + +```ts +optional content?: string; +``` + +### error? + +```ts +optional error?: string; +``` + +### needed? + +```ts +optional needed?: string; +``` + +### ok? + +```ts +optional ok?: boolean; +``` + +### provided? + +```ts +optional provided?: string; +``` + +### warning? + +```ts +optional warning?: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/ContextActionsBlockElement.md b/docs/english/reference/web-api/type-aliases/ContextActionsBlockElement.md index 4448bb0ef..e65cd7247 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:188 +Defined in: packages/types/dist/block-kit/blocks.d.ts:252 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 4941171bf..079116759 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:169 +Defined in: packages/types/dist/block-kit/blocks.d.ts:233 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/FilesRemoteInfoArguments.md b/docs/english/reference/web-api/type-aliases/FilesRemoteInfoArguments.md index 8eab452e2..fbe89347e 100644 --- a/docs/english/reference/web-api/type-aliases/FilesRemoteInfoArguments.md +++ b/docs/english/reference/web-api/type-aliases/FilesRemoteInfoArguments.md @@ -6,4 +6,4 @@ type FilesRemoteInfoArguments = FileOrExternalID & TokenOverridable; ``` -Defined in: [packages/web-api/src/types/request/files.ts:226](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L226) +Defined in: [packages/web-api/src/types/request/files.ts:230](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L230) diff --git a/docs/english/reference/web-api/type-aliases/FilesRemoteRemoveArguments.md b/docs/english/reference/web-api/type-aliases/FilesRemoteRemoveArguments.md index 117a35720..cf3854020 100644 --- a/docs/english/reference/web-api/type-aliases/FilesRemoteRemoveArguments.md +++ b/docs/english/reference/web-api/type-aliases/FilesRemoteRemoveArguments.md @@ -6,4 +6,4 @@ type FilesRemoteRemoveArguments = FileOrExternalID & TokenOverridable; ``` -Defined in: [packages/web-api/src/types/request/files.ts:237](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L237) +Defined in: [packages/web-api/src/types/request/files.ts:241](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L241) diff --git a/docs/english/reference/web-api/type-aliases/FilesRemoteShareArguments.md b/docs/english/reference/web-api/type-aliases/FilesRemoteShareArguments.md index 06bda4449..408a6b6c3 100644 --- a/docs/english/reference/web-api/type-aliases/FilesRemoteShareArguments.md +++ b/docs/english/reference/web-api/type-aliases/FilesRemoteShareArguments.md @@ -6,4 +6,4 @@ type FilesRemoteShareArguments = Required & FileOrExternalID & TokenOverridable; ``` -Defined in: [packages/web-api/src/types/request/files.ts:239](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L239) +Defined in: [packages/web-api/src/types/request/files.ts:243](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L243) diff --git a/docs/english/reference/web-api/type-aliases/FilesRemoteUpdateArguments.md b/docs/english/reference/web-api/type-aliases/FilesRemoteUpdateArguments.md index 5ad6de862..4bd121805 100644 --- a/docs/english/reference/web-api/type-aliases/FilesRemoteUpdateArguments.md +++ b/docs/english/reference/web-api/type-aliases/FilesRemoteUpdateArguments.md @@ -6,4 +6,4 @@ type FilesRemoteUpdateArguments = Partial & FileOrExternalID & FileType & TokenOverridable; ``` -Defined in: [packages/web-api/src/types/request/files.ts:241](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L241) +Defined in: [packages/web-api/src/types/request/files.ts:245](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L245) diff --git a/docs/english/reference/web-api/type-aliases/FilesUploadV2Arguments.md b/docs/english/reference/web-api/type-aliases/FilesUploadV2Arguments.md index 69bcb6298..10098a065 100644 --- a/docs/english/reference/web-api/type-aliases/FilesUploadV2Arguments.md +++ b/docs/english/reference/web-api/type-aliases/FilesUploadV2Arguments.md @@ -8,4 +8,4 @@ type FilesUploadV2Arguments = TokenOverridable & | Omit & FilesUploadV2ArgumentsMultipleFiles; ``` -Defined in: [packages/web-api/src/types/request/files.ts:190](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L190) +Defined in: [packages/web-api/src/types/request/files.ts:194](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/files.ts#L194) diff --git a/docs/english/reference/web-api/type-aliases/ImageBlock.md b/docs/english/reference/web-api/type-aliases/ImageBlock.md index 16b4def54..ce02021c5 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:281 +Defined in: packages/types/dist/block-kit/blocks.d.ts:345 ## Type Declaration diff --git a/docs/english/reference/web-api/type-aliases/ImageElement.md b/docs/english/reference/web-api/type-aliases/ImageElement.md index fc6dcf165..ca9ceee25 100644 --- a/docs/english/reference/web-api/type-aliases/ImageElement.md +++ b/docs/english/reference/web-api/type-aliases/ImageElement.md @@ -8,7 +8,7 @@ type ImageElement = object & | SlackFileImageObject; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:223 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:237 ## 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 6008f4f17..d4cc0ad2d 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:301 +Defined in: packages/types/dist/block-kit/blocks.d.ts:365 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 57ba3a0a0..92e6c3d91 100644 --- a/docs/english/reference/web-api/type-aliases/KnownBlock.md +++ b/docs/english/reference/web-api/type-aliases/KnownBlock.md @@ -6,6 +6,7 @@ type KnownBlock = | ActionsBlock | AlertBlock + | AuthProviderBlock | CardBlock | CarouselBlock | ContainerBlock diff --git a/docs/english/reference/web-api/type-aliases/Method.md b/docs/english/reference/web-api/type-aliases/Method.md index a1b94b7ba..02538097f 100644 --- a/docs/english/reference/web-api/type-aliases/Method.md +++ b/docs/english/reference/web-api/type-aliases/Method.md @@ -6,7 +6,7 @@ type Method = (options?) => Promise; ``` -Defined in: [packages/web-api/src/methods.ts:577](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L577) +Defined in: [packages/web-api/src/methods.ts:583](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L583) ## Type Parameters diff --git a/docs/english/reference/web-api/type-aliases/MultiSelect.md b/docs/english/reference/web-api/type-aliases/MultiSelect.md index 69cfe570c..9294e0c0d 100644 --- a/docs/english/reference/web-api/type-aliases/MultiSelect.md +++ b/docs/english/reference/web-api/type-aliases/MultiSelect.md @@ -11,7 +11,7 @@ type MultiSelect = | MultiExternalSelect; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:253 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:267 ## Description diff --git a/docs/english/reference/web-api/type-aliases/RichTextBlockElement.md b/docs/english/reference/web-api/type-aliases/RichTextBlockElement.md index 78b638256..7cac7b1dd 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:358 +Defined in: packages/types/dist/block-kit/blocks.d.ts:422 A helper union type of all Block Elements that can be used in a [RichTextBlock](../interfaces/RichTextBlock.md). diff --git a/docs/english/reference/web-api/type-aliases/RichTextElement.md b/docs/english/reference/web-api/type-aliases/RichTextElement.md index 6d1a209a2..3702aecf3 100644 --- a/docs/english/reference/web-api/type-aliases/RichTextElement.md +++ b/docs/english/reference/web-api/type-aliases/RichTextElement.md @@ -16,7 +16,7 @@ type RichTextElement = | RichTextUsergroupMention; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:877 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:891 ## Description diff --git a/docs/english/reference/web-api/type-aliases/SectionBlockAccessory.md b/docs/english/reference/web-api/type-aliases/SectionBlockAccessory.md index bc14b8ad2..ca6dd8557 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:379 +Defined in: packages/types/dist/block-kit/blocks.d.ts:443 A helper union type of all Block Elements that can be used as an accessory in a [SectionBlock](../interfaces/SectionBlock.md). diff --git a/docs/english/reference/web-api/type-aliases/Select.md b/docs/english/reference/web-api/type-aliases/Select.md index a52abde36..a17048a32 100644 --- a/docs/english/reference/web-api/type-aliases/Select.md +++ b/docs/english/reference/web-api/type-aliases/Select.md @@ -11,7 +11,7 @@ type Select = | ExternalSelect; ``` -Defined in: packages/types/dist/block-kit/block-elements.d.ts:242 +Defined in: packages/types/dist/block-kit/block-elements.d.ts:256 ## Description diff --git a/docs/english/reference/web-api/type-aliases/SlackEvent.md b/docs/english/reference/web-api/type-aliases/SlackEvent.md index fcee5fb93..2e52bd186 100644 --- a/docs/english/reference/web-api/type-aliases/SlackEvent.md +++ b/docs/english/reference/web-api/type-aliases/SlackEvent.md @@ -84,6 +84,8 @@ type SlackEvent = | TeamRenameEvent | TokensRevokedEvent | UserChangeEvent + | UserConnectionEvent + | UserConnectionStatusRequestedEvent | UserHuddleChangedEvent | UserProfileChangedEvent | UserStatusChangedEvent diff --git a/docs/english/reference/web-api/type-aliases/TeamIntegrationLogsArguments.md b/docs/english/reference/web-api/type-aliases/TeamIntegrationLogsArguments.md index df90d514c..48770e648 100644 --- a/docs/english/reference/web-api/type-aliases/TeamIntegrationLogsArguments.md +++ b/docs/english/reference/web-api/type-aliases/TeamIntegrationLogsArguments.md @@ -6,4 +6,4 @@ type TeamIntegrationLogsArguments = OptionalArgument & TokenOverridable & OptionalTeamAssignable & TraditionalPagingEnabled & object>; ``` -Defined in: [packages/web-api/src/types/request/team.ts:76](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L76) +Defined in: [packages/web-api/src/types/request/team.ts:82](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L82) diff --git a/docs/english/reference/web-api/type-aliases/TeamPreferencesListArguments.md b/docs/english/reference/web-api/type-aliases/TeamPreferencesListArguments.md index acfa82dea..e10f978bd 100644 --- a/docs/english/reference/web-api/type-aliases/TeamPreferencesListArguments.md +++ b/docs/english/reference/web-api/type-aliases/TeamPreferencesListArguments.md @@ -6,4 +6,4 @@ type TeamPreferencesListArguments = OptionalArgument; ``` -Defined in: [packages/web-api/src/types/request/team.ts:97](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L97) +Defined in: [packages/web-api/src/types/request/team.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L103) diff --git a/docs/english/reference/web-api/type-aliases/TeamProfileGetArguments.md b/docs/english/reference/web-api/type-aliases/TeamProfileGetArguments.md index 436b3877d..45feb4dc7 100644 --- a/docs/english/reference/web-api/type-aliases/TeamProfileGetArguments.md +++ b/docs/english/reference/web-api/type-aliases/TeamProfileGetArguments.md @@ -6,4 +6,4 @@ type TeamProfileGetArguments = OptionalArgument; ``` -Defined in: [packages/web-api/src/types/request/team.ts:90](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L90) +Defined in: [packages/web-api/src/types/request/team.ts:96](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/team.ts#L96) diff --git a/docs/english/reference/web-api/type-aliases/UserConnectionEvent.md b/docs/english/reference/web-api/type-aliases/UserConnectionEvent.md new file mode 100644 index 000000000..f4117f872 --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/UserConnectionEvent.md @@ -0,0 +1,11 @@ +[@slack/web-api](../index.md) / UserConnectionEvent + +# Type Alias: UserConnectionEvent + +```ts +type UserConnectionEvent = + | UserConnectionConnectEvent + | UserConnectionDisconnectEvent; +``` + +Defined in: packages/types/dist/events/user.d.ts:80 diff --git a/package-lock.json b/package-lock.json index 3cc52ca0b..a82e2885f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5463,11 +5463,11 @@ }, "packages/socket-mode": { "name": "@slack/socket-mode", - "version": "3.1.0", + "version": "3.1.1", "license": "MIT", "dependencies": { "@slack/logger": "^5.0.0", - "@slack/web-api": "^8.2.0", + "@slack/web-api": "^8.3.0", "@types/node": ">=20", "eventemitter3": "^5" }, @@ -5502,7 +5502,7 @@ }, "packages/types": { "name": "@slack/types", - "version": "3.2.0", + "version": "3.3.0", "license": "MIT", "devDependencies": { "tsd": "^0.33.0" @@ -5514,11 +5514,11 @@ }, "packages/web-api": { "name": "@slack/web-api", - "version": "8.2.0", + "version": "8.3.0", "license": "MIT", "dependencies": { "@slack/logger": "^5.0.0", - "@slack/types": "^3.2.0", + "@slack/types": "^3.3.0", "@types/node": ">=20", "@types/retry": "0.12.5", "eventemitter3": "^5.0.1", diff --git a/packages/socket-mode/CHANGELOG.md b/packages/socket-mode/CHANGELOG.md index 8fd2aad8d..344ab7f49 100644 --- a/packages/socket-mode/CHANGELOG.md +++ b/packages/socket-mode/CHANGELOG.md @@ -1,5 +1,22 @@ # @slack/socket-mode +## 3.1.1 + +### Patch Changes + +- b0706c6: Fix Events API dispatch for payloads without an inner event, including app_rate_limited. Keep malformed payloads available to generic slack_event listeners for acknowledgement. +- 8730b5e: Fix an orphaned close-handshake timer ([#2771](https://github.com/slackapi/node-slack-sdk/issues/2771)). When the connection closed while a close frame was in flight, the 30s timer armed by `disconnect()` outlived the connection, then logged a false "Peer did not complete the close handshake" warning and emitted a second `close`, which could start a duplicate reconnect. + + - `disconnect()` on an already closed socket now cleans up immediately instead of sending a close frame and arming a second timer. This is the path when Slack drops the TCP connection after a `disconnect` message. + - `disconnect()` before the connection opens no longer leaves the timer behind: undici fails a connecting socket synchronously inside `close()`, so the timer is now armed before it. +- Updated dependencies [604135c] +- Updated dependencies [bf3ca27] +- Updated dependencies [28bd9f9] +- Updated dependencies [4483395] +- Updated dependencies [651c298] +- Updated dependencies [9c6893e] + - @slack/web-api@8.3.0 + ## 3.1.0 ### Minor Changes diff --git a/packages/socket-mode/package.json b/packages/socket-mode/package.json index dc30bb9e7..65e2585dd 100644 --- a/packages/socket-mode/package.json +++ b/packages/socket-mode/package.json @@ -1,6 +1,6 @@ { "name": "@slack/socket-mode", - "version": "3.1.0", + "version": "3.1.1", "description": "Official library for using the Slack Platform's Socket Mode API", "author": "Slack Technologies, LLC", "license": "MIT", @@ -52,7 +52,7 @@ }, "dependencies": { "@slack/logger": "^5.0.0", - "@slack/web-api": "^8.2.0", + "@slack/web-api": "^8.3.0", "@types/node": ">=20", "eventemitter3": "^5" }, diff --git a/packages/types/CHANGELOG.md b/packages/types/CHANGELOG.md index 7bfdf6eb9..5df0722de 100644 --- a/packages/types/CHANGELOG.md +++ b/packages/types/CHANGELOG.md @@ -1,5 +1,17 @@ # @slack/types +## 3.3.0 + +### Minor Changes + +- 1fabb45: feat(types): add [`AuthProviderBlock`](https://docs.slack.dev/reference/block-kit/blocks/auth-provider-block) block interface +- 7c310ea: feat(types): add the [`user_connection`](https://docs.slack.dev/reference/events/user_connection) and [`user_connection_status_requested`](https://docs.slack.dev/reference/events/user_connection_status_requested) event interfaces + +### Patch Changes + +- 6f6fbd1: fix(types): add the `agent_prompt`, `agent_prompt_display`, and `visible_to_user_ids` fields to the [`Button`](https://docs.slack.dev/reference/block-kit/block-elements/button-element) block element +- e02e7fe: fix: add the `files`, `upload`, `display_as_bot`, and `parent_user_id` fields to `ThreadBroadcastMessageEvent` + ## 3.2.0 ### Minor Changes diff --git a/packages/types/package.json b/packages/types/package.json index d213e67ad..52d5ef0c4 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@slack/types", - "version": "3.2.0", + "version": "3.3.0", "description": "Shared type definitions for the Node Slack SDK", "author": "Slack Technologies, LLC", "license": "MIT", diff --git a/packages/web-api/CHANGELOG.md b/packages/web-api/CHANGELOG.md index f8f105e97..a786b65af 100644 --- a/packages/web-api/CHANGELOG.md +++ b/packages/web-api/CHANGELOG.md @@ -1,5 +1,24 @@ # @slack/web-api +## 8.3.0 + +### Minor Changes + +- 604135c: feat: add support for apps.user.connection.requestAuth and apps.user.connection.bulkUpdate +- bf3ca27: feat(web-api): add [`canvases.getContent`](https://docs.slack.dev/reference/methods/canvases.getContent) method +- 4483395: feat: add the `code_channels` app manifest feature and the `code_channels:manage` bot scope to manifest types +- 651c298: feat: add the `user_connections` feature (`is_enabled`, `auth_hosts`) and the `user_connection` and `user_connection_status_requested` events to the app manifest types +- 9c6893e: Add the optional `include_slackbot_availability` argument and `team.slackbot_availability` response field to `team.info`. + +### Patch Changes + +- 28bd9f9: fix: image alt text passed to `files.uploadV2` is now saved. Before, it was sent as `alt_text`, which Slack ignores. Add `alt_txt` to `files.uploadV2` and `files.getUploadURLExternal` arguments, and deprecate `alt_text` in both. A deprecated `alt_text` passed to `files.uploadV2` is still sent as `alt_txt` ([#2788](https://github.com/slackapi/node-slack-sdk/issues/2788)) +- Updated dependencies [1fabb45] +- Updated dependencies [6f6fbd1] +- Updated dependencies [e02e7fe] +- Updated dependencies [7c310ea] + - @slack/types@3.3.0 + ## 8.2.0 ### Minor Changes diff --git a/packages/web-api/package.json b/packages/web-api/package.json index cbbfd7ed8..b2f1433c9 100644 --- a/packages/web-api/package.json +++ b/packages/web-api/package.json @@ -1,6 +1,6 @@ { "name": "@slack/web-api", - "version": "8.2.0", + "version": "8.3.0", "description": "Official library for using the Slack Platform's Web API", "author": "Slack Technologies, LLC", "license": "MIT", @@ -49,7 +49,7 @@ }, "dependencies": { "@slack/logger": "^5.0.0", - "@slack/types": "^3.2.0", + "@slack/types": "^3.3.0", "@types/node": ">=20", "@types/retry": "0.12.5", "eventemitter3": "^5.0.1",