Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .changeset/add-auth-provider-block.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/apps-user-connection-request-auth-bulk-update.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/thread-broadcast-file-fields.md

This file was deleted.

3 changes: 2 additions & 1 deletion docs/english/reference/types/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @slack/types v3.2.0
# @slack/types v3.3.0

## Enumerations

Expand All @@ -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)
Expand Down
6 changes: 3 additions & 3 deletions docs/english/reference/types/interfaces/ActionsBlock.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down
8 changes: 4 additions & 4 deletions docs/english/reference/types/interfaces/AlertBlock.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down
221 changes: 221 additions & 0 deletions docs/english/reference/types/interfaces/AuthProviderBlock.md
Original file line number Diff line number Diff line change
@@ -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_<value>`). Maximum length for this field is 150
characters.
1 change: 1 addition & 0 deletions docs/english/reference/types/interfaces/Block.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
16 changes: 8 additions & 8 deletions docs/english/reference/types/interfaces/CardBlock.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down
Loading