Skip to content
Merged
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
278 changes: 243 additions & 35 deletions docs/english/reference/web-api/classes/Methods.md

Large diffs are not rendered by default.

282 changes: 248 additions & 34 deletions docs/english/reference/web-api/classes/WebClient.md

Large diffs are not rendered by default.

26 changes: 25 additions & 1 deletion docs/english/reference/web-api/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @slack/web-api v7.12.0
# @slack/web-api v7.13.0

## Enumerations

Expand Down Expand Up @@ -354,6 +354,18 @@
- [SharedChannelInviteReceivedEvent](interfaces/SharedChannelInviteReceivedEvent.md)
- [SharedChannelInviteRequestedEvent](interfaces/SharedChannelInviteRequestedEvent.md)
- [SlackFileImageObject](interfaces/SlackFileImageObject.md)
- [SlackListsAccessDeleteArguments](interfaces/SlackListsAccessDeleteArguments.md)
- [SlackListsAccessSetArguments](interfaces/SlackListsAccessSetArguments.md)
- [SlackListsCreateArguments](interfaces/SlackListsCreateArguments.md)
- [SlackListsDownloadGetArguments](interfaces/SlackListsDownloadGetArguments.md)
- [SlackListsDownloadStartArguments](interfaces/SlackListsDownloadStartArguments.md)
- [SlackListsItemsCreateArguments](interfaces/SlackListsItemsCreateArguments.md)
- [SlackListsItemsDeleteArguments](interfaces/SlackListsItemsDeleteArguments.md)
- [SlackListsItemsDeleteMultipleArguments](interfaces/SlackListsItemsDeleteMultipleArguments.md)
- [SlackListsItemsInfoArguments](interfaces/SlackListsItemsInfoArguments.md)
- [SlackListsItemsListArguments](interfaces/SlackListsItemsListArguments.md)
- [SlackListsItemsUpdateArguments](interfaces/SlackListsItemsUpdateArguments.md)
- [SlackListsUpdateArguments](interfaces/SlackListsUpdateArguments.md)
- [StarAddedEvent](interfaces/StarAddedEvent.md)
- [StarRemovedEvent](interfaces/StarRemovedEvent.md)
- [StarsListArguments](interfaces/StarsListArguments.md)
Expand Down Expand Up @@ -786,6 +798,18 @@
- [~~SharedChannelInviteReceived~~](type-aliases/SharedChannelInviteReceived.md)
- [SlackEvent](type-aliases/SlackEvent.md)
- [SlackFile](type-aliases/SlackFile.md)
- [SlackListsAccessDeleteResponse](type-aliases/SlackListsAccessDeleteResponse.md)
- [SlackListsAccessSetResponse](type-aliases/SlackListsAccessSetResponse.md)
- [SlackListsCreateResponse](type-aliases/SlackListsCreateResponse.md)
- [SlackListsDownloadGetResponse](type-aliases/SlackListsDownloadGetResponse.md)
- [SlackListsDownloadStartResponse](type-aliases/SlackListsDownloadStartResponse.md)
- [SlackListsItemsCreateResponse](type-aliases/SlackListsItemsCreateResponse.md)
- [SlackListsItemsDeleteMultipleResponse](type-aliases/SlackListsItemsDeleteMultipleResponse.md)
- [SlackListsItemsDeleteResponse](type-aliases/SlackListsItemsDeleteResponse.md)
- [SlackListsItemsInfoResponse](type-aliases/SlackListsItemsInfoResponse.md)
- [SlackListsItemsListResponse](type-aliases/SlackListsItemsListResponse.md)
- [SlackListsItemsUpdateResponse](type-aliases/SlackListsItemsUpdateResponse.md)
- [SlackListsUpdateResponse](type-aliases/SlackListsUpdateResponse.md)
- [StarsAddRemoveArguments](type-aliases/StarsAddRemoveArguments.md)
- [StarsAddResponse](type-aliases/StarsAddResponse.md)
- [StarsListResponse](type-aliases/StarsListResponse.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,16 +200,16 @@ Defined in: node\_modules/@slack/types/dist/events/app.d.ts:62

```ts
previous_resolution:
| null
| {
scopes: {
description: string;
is_dangerous: boolean;
name: string;
token_type: null | "user" | "bot" | "app";
token_type: "user" | "bot" | "app" | null;
};
status: "approved" | "restricted";
};
}
| null;
```

Defined in: node\_modules/@slack/types/dist/events/app.d.ts:36
Expand Down Expand Up @@ -245,7 +245,7 @@ name: string;
#### token\_type

```ts
token_type: null | "user" | "bot" | "app";
token_type: "user" | "bot" | "app" | null;
```

***
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ optional channel_id: string;
##### context.enterprise\_id?

```ts
optional enterprise_id: null | string;
optional enterprise_id: string | null;
```

##### context.team\_id?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ optional channel_id: string;
##### context.enterprise\_id?

```ts
optional enterprise_id: null | string;
optional enterprise_id: string | null;
```

##### context.team\_id?
Expand Down
6 changes: 3 additions & 3 deletions docs/english/reference/web-api/interfaces/CodedError.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ NodeJS.ErrnoException.code
optional errno: number;
```

Defined in: node\_modules/@types/node/globals.d.ts:393
Defined in: node\_modules/@types/node/globals.d.ts:102

#### Inherited from

Expand Down Expand Up @@ -89,7 +89,7 @@ NodeJS.ErrnoException.name
optional path: string;
```

Defined in: node\_modules/@types/node/globals.d.ts:395
Defined in: node\_modules/@types/node/globals.d.ts:104

#### Inherited from

Expand Down Expand Up @@ -121,7 +121,7 @@ NodeJS.ErrnoException.stack
optional syscall: string;
```

Defined in: node\_modules/@types/node/globals.d.ts:396
Defined in: node\_modules/@types/node/globals.d.ts:105

#### Inherited from

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
[@slack/web-api](../index.md) / SlackListsAccessDeleteArguments

# Interface: SlackListsAccessDeleteArguments

Defined in: [src/types/request/slackLists.ts:329](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L329)

## Extends

- `TokenOverridable`

## Properties

### channel\_ids?

```ts
optional channel_ids: string[];
```

Defined in: [src/types/request/slackLists.ts:338](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L338)

#### Description

List of channels you wish to update access for. Can only be used if user_ids is not provided.

***

### list\_id

```ts
list_id: string;
```

Defined in: [src/types/request/slackLists.ts:333](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L333)

#### Description

Encoded ID of the List.

***

### token?

```ts
optional token: string;
```

Defined in: [src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43)

#### Description

Overridable authentication token bearing required scopes.

#### Inherited from

```ts
TokenOverridable.token
```

***

### user\_ids?

```ts
optional user_ids: string[];
```

Defined in: [src/types/request/slackLists.ts:343](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L343)

#### Description

List of users you wish to update access for. Can only be used if channel_ids is not provided.
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
[@slack/web-api](../index.md) / SlackListsAccessSetArguments

# Interface: SlackListsAccessSetArguments

Defined in: [src/types/request/slackLists.ts:347](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L347)

## Extends

- `TokenOverridable`

## Properties

### access\_level

```ts
access_level: string;
```

Defined in: [src/types/request/slackLists.ts:356](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L356)

#### Description

Desired level of access.

***

### channel\_ids?

```ts
optional channel_ids: string[];
```

Defined in: [src/types/request/slackLists.ts:361](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L361)

#### Description

List of channels you wish to update access for. Can only be used if user_ids is not provided.

***

### list\_id

```ts
list_id: string;
```

Defined in: [src/types/request/slackLists.ts:351](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L351)

#### Description

Encoded ID of the List.

***

### token?

```ts
optional token: string;
```

Defined in: [src/types/request/common.ts:43](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/common.ts#L43)

#### Description

Overridable authentication token bearing required scopes.

#### Inherited from

```ts
TokenOverridable.token
```

***

### user\_ids?

```ts
optional user_ids: string[];
```

Defined in: [src/types/request/slackLists.ts:366](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L366)

#### Description

List of users you wish to update access for. Can only be used if channel_ids is not provided.
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
[@slack/web-api](../index.md) / SlackListsCreateArguments

# Interface: SlackListsCreateArguments

Defined in: [src/types/request/slackLists.ts:370](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L370)

## Extends

- `TokenOverridable`

## Properties

### copy\_from\_list\_id?

```ts
optional copy_from_list_id: string;
```

Defined in: [src/types/request/slackLists.ts:390](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L390)

#### Description

ID of the List to copy.

***

### description\_blocks?

```ts
optional description_blocks: RichTextBlock[];
```

Defined in: [src/types/request/slackLists.ts:379](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L379)

#### Description

A rich text description of the List.

***

### include\_copied\_list\_records?

```ts
optional include_copied_list_records: boolean;
```

Defined in: [src/types/request/slackLists.ts:395](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L395)

#### Description

Boolean indicating whether to include records when a List is copied.

***

### name

```ts
name: string;
```

Defined in: [src/types/request/slackLists.ts:374](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L374)

#### Description

Name of the List.

***

### schema?

```ts
optional schema: SlackListsSchemaColumn[];
```

Defined in: [src/types/request/slackLists.ts:385](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L385)

#### Description

Column definition for the List.

#### See

[https://docs.slack.dev/reference/methods/slackLists.create#schema-definition](https://docs.slack.dev/reference/methods/slackLists.create#schema-definition)

***

### todo\_mode?

```ts
optional todo_mode: boolean;
```

Defined in: [src/types/request/slackLists.ts:400](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L400)

#### Description

Boolean indicating whether the List should be used to track todo tasks.

***

### token?

```ts
optional token: string;
```

Defined in: [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
```
Loading