diff --git a/docs/english/reference/web-api/classes/Methods.md b/docs/english/reference/web-api/classes/Methods.md index d9fdb36ff..412e47151 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: [src/methods.ts:573](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L573) +Defined in: [src/methods.ts:597](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L597) 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: [src/methods.ts:586](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L586) +Defined in: [src/methods.ts:610](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L610) #### analytics @@ -1558,7 +1558,7 @@ Unpublish workflows within the team or enterprise. readonly api: object; ``` -Defined in: [src/methods.ts:1351](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1351) +Defined in: [src/methods.ts:1375](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1375) #### test @@ -1582,7 +1582,7 @@ Checks API calling code. readonly apps: object; ``` -Defined in: [src/methods.ts:1388](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1388) +Defined in: [src/methods.ts:1412](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1412) #### connections @@ -1730,7 +1730,7 @@ Uninstalls your app from a workspace. readonly assistant: object; ``` -Defined in: [src/methods.ts:1359](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1359) +Defined in: [src/methods.ts:1383](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1383) #### threads @@ -1788,7 +1788,7 @@ Set the title of the thread. This is shown when a user views the app's chat hist readonly auth: object; ``` -Defined in: [src/methods.ts:1450](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1450) +Defined in: [src/methods.ts:1474](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1474) #### revoke @@ -1838,7 +1838,7 @@ test: Method; readonly bookmarks: object; ``` -Defined in: [src/methods.ts:1466](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1466) +Defined in: [src/methods.ts:1490](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1490) #### add @@ -1904,7 +1904,7 @@ Remove bookmark from a channel. readonly bots: object; ``` -Defined in: [src/methods.ts:1489](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1489) +Defined in: [src/methods.ts:1513](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1513) #### info @@ -1928,7 +1928,7 @@ Gets information about a bot user. readonly calls: object; ``` -Defined in: [src/methods.ts:1497](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1497) +Defined in: [src/methods.ts:1521](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1521) #### add @@ -2020,7 +2020,7 @@ Updates information about a Call. readonly canvases: object; ``` -Defined in: [src/methods.ts:1531](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1531) +Defined in: [src/methods.ts:1555](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1555) #### access @@ -2126,7 +2126,7 @@ Find sections matching the provided criteria. readonly chat: object; ``` -Defined in: [src/methods.ts:1571](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1571) +Defined in: [src/methods.ts:1595](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1595) #### appendStream @@ -2138,6 +2138,10 @@ appendStream: MethodWithRequiredArgument; +``` + +###### Description + +Delete access for specified entities. + +###### See + +[\`slackLists.access.delete\` API reference](https://docs.slack.dev/reference/methods/slackLists.access.delete). + +##### access.set + +```ts +set: MethodWithRequiredArgument; +``` + +###### Description + +Set access level for specified entities. + +###### See + +[\`slackLists.access.set\` API reference](https://docs.slack.dev/reference/methods/slackLists.access.set). + +#### create + +```ts +create: MethodWithRequiredArgument; +``` + +##### Description + +Create a List. + +##### See + +[\`slackLists.create\` API reference](https://docs.slack.dev/reference/methods/slackLists.create). + +#### download + +```ts +download: object; +``` + +##### download.get + +```ts +get: MethodWithRequiredArgument; +``` + +###### Description + +Get download job status. + +###### See + +[\`slackLists.download.get\` API reference](https://docs.slack.dev/reference/methods/slackLists.download.get). + +##### download.start + +```ts +start: MethodWithRequiredArgument; +``` + +###### Description + +Start a download job for a list. + +###### See + +[\`slackLists.download.start\` API reference](https://docs.slack.dev/reference/methods/slackLists.download.start). + +#### items + +```ts +items: object; +``` + +##### items.create + +```ts +create: MethodWithRequiredArgument; +``` + +###### Description + +Create a list item. + +###### See + +[\`slackLists.items.create\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.create). + +##### items.delete + +```ts +delete: MethodWithRequiredArgument; +``` + +###### Description + +Delete a list item. + +###### See + +[\`slackLists.items.delete\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.delete). + +##### items.deleteMultiple + +```ts +deleteMultiple: MethodWithRequiredArgument; +``` + +###### Description + +Delete multiple list items. + +###### See + +[\`slackLists.items.deleteMultiple\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.deleteMultiple). + +##### items.info + +```ts +info: MethodWithRequiredArgument; +``` + +###### Description + +Get info about a list item. + +###### See + +[\`slackLists.items.info\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.info). + +##### items.list + +```ts +list: MethodWithRequiredArgument; +``` + +###### Description + +Get records from a List. + +###### See + +[\`slackLists.items.list\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.list). + +##### items.update + +```ts +update: MethodWithRequiredArgument; +``` + +###### Description + +Update a list item. + +###### See + +[\`slackLists.items.update\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.update). + +#### update + +```ts +update: MethodWithRequiredArgument; +``` + +##### Description + +Update a list. + +##### See + +[\`slackLists.update\` API reference](https://docs.slack.dev/reference/methods/slackLists.update). + +*** + ### stars ```ts readonly stars: object; ``` -Defined in: [src/methods.ts:2397](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2397) +Defined in: [src/methods.ts:2511](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2511) #### ~~add~~ @@ -3672,7 +3880,7 @@ See [our post on stars and the Later list](https://docs.slack.dev/changelog/2023 readonly team: object; ``` -Defined in: [src/methods.ts:2173](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2173) +Defined in: [src/methods.ts:2287](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2287) #### accessLogs @@ -3832,7 +4040,7 @@ Retrieve a team's profile. readonly tooling: object; ``` -Defined in: [src/methods.ts:2244](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2244) +Defined in: [src/methods.ts:2358](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2358) #### tokens @@ -3862,7 +4070,7 @@ Exchanges a refresh token for a new app configuration token. readonly usergroups: object; ``` -Defined in: [src/methods.ts:2254](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2254) +Defined in: [src/methods.ts:2368](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2368) #### create @@ -3976,7 +4184,7 @@ Update the list of users in a User Group. readonly users: object; ``` -Defined in: [src/methods.ts:2297](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2297) +Defined in: [src/methods.ts:2411](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2411) #### conversations @@ -4166,7 +4374,7 @@ Manually sets user presence. readonly views: object; ``` -Defined in: [src/methods.ts:2367](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2367) +Defined in: [src/methods.ts:2481](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2481) #### open @@ -4232,7 +4440,7 @@ Update an existing view. readonly workflows: object; ``` -Defined in: [src/methods.ts:2421](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2421) +Defined in: [src/methods.ts:2535](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2535) #### featured @@ -4423,7 +4631,7 @@ EventEmitter.addListener abstract apiCall(method, options?): Promise; ``` -Defined in: [src/methods.ts:583](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L583) +Defined in: [src/methods.ts:607](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L607) #### Parameters @@ -4508,7 +4716,7 @@ EventEmitter.eventNames abstract filesUploadV2(options): Promise; ``` -Defined in: [src/methods.ts:584](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L584) +Defined in: [src/methods.ts:608](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L608) #### Parameters diff --git a/docs/english/reference/web-api/classes/WebClient.md b/docs/english/reference/web-api/classes/WebClient.md index 7718333c7..adc37abbe 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: [src/methods.ts:586](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L586) +Defined in: [src/methods.ts:610](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L610) #### analytics @@ -1594,7 +1594,7 @@ Unpublish workflows within the team or enterprise. readonly api: object; ``` -Defined in: [src/methods.ts:1351](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1351) +Defined in: [src/methods.ts:1375](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1375) #### test @@ -1622,7 +1622,7 @@ Checks API calling code. readonly apps: object; ``` -Defined in: [src/methods.ts:1388](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1388) +Defined in: [src/methods.ts:1412](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1412) #### connections @@ -1774,7 +1774,7 @@ Uninstalls your app from a workspace. readonly assistant: object; ``` -Defined in: [src/methods.ts:1359](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1359) +Defined in: [src/methods.ts:1383](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1383) #### threads @@ -1836,7 +1836,7 @@ Set the title of the thread. This is shown when a user views the app's chat hist readonly auth: object; ``` -Defined in: [src/methods.ts:1450](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1450) +Defined in: [src/methods.ts:1474](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1474) #### revoke @@ -1890,7 +1890,7 @@ test: Method; readonly bookmarks: object; ``` -Defined in: [src/methods.ts:1466](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1466) +Defined in: [src/methods.ts:1490](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1490) #### add @@ -1960,7 +1960,7 @@ Remove bookmark from a channel. readonly bots: object; ``` -Defined in: [src/methods.ts:1489](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1489) +Defined in: [src/methods.ts:1513](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1513) #### info @@ -1988,7 +1988,7 @@ Gets information about a bot user. readonly calls: object; ``` -Defined in: [src/methods.ts:1497](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1497) +Defined in: [src/methods.ts:1521](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1521) #### add @@ -2084,7 +2084,7 @@ Updates information about a Call. readonly canvases: object; ``` -Defined in: [src/methods.ts:1531](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1531) +Defined in: [src/methods.ts:1555](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1555) #### access @@ -2194,7 +2194,7 @@ Find sections matching the provided criteria. readonly chat: object; ``` -Defined in: [src/methods.ts:1571](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1571) +Defined in: [src/methods.ts:1595](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1595) #### appendStream @@ -2206,6 +2206,10 @@ appendStream: MethodWithRequiredArgument; +``` + +###### Description + +Delete access for specified entities. + +###### See + +[\`slackLists.access.delete\` API reference](https://docs.slack.dev/reference/methods/slackLists.access.delete). + +##### access.set + +```ts +set: MethodWithRequiredArgument; +``` + +###### Description + +Set access level for specified entities. + +###### See + +[\`slackLists.access.set\` API reference](https://docs.slack.dev/reference/methods/slackLists.access.set). + +#### create + +```ts +create: MethodWithRequiredArgument; +``` + +##### Description + +Create a List. + +##### See + +[\`slackLists.create\` API reference](https://docs.slack.dev/reference/methods/slackLists.create). + +#### download + +```ts +download: object; +``` + +##### download.get + +```ts +get: MethodWithRequiredArgument; +``` + +###### Description + +Get download job status. + +###### See + +[\`slackLists.download.get\` API reference](https://docs.slack.dev/reference/methods/slackLists.download.get). + +##### download.start + +```ts +start: MethodWithRequiredArgument; +``` + +###### Description + +Start a download job for a list. + +###### See + +[\`slackLists.download.start\` API reference](https://docs.slack.dev/reference/methods/slackLists.download.start). + +#### items + +```ts +items: object; +``` + +##### items.create + +```ts +create: MethodWithRequiredArgument; +``` + +###### Description + +Create a list item. + +###### See + +[\`slackLists.items.create\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.create). + +##### items.delete + +```ts +delete: MethodWithRequiredArgument; +``` + +###### Description + +Delete a list item. + +###### See + +[\`slackLists.items.delete\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.delete). + +##### items.deleteMultiple + +```ts +deleteMultiple: MethodWithRequiredArgument; +``` + +###### Description + +Delete multiple list items. + +###### See + +[\`slackLists.items.deleteMultiple\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.deleteMultiple). + +##### items.info + +```ts +info: MethodWithRequiredArgument; +``` + +###### Description + +Get info about a list item. + +###### See + +[\`slackLists.items.info\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.info). + +##### items.list + +```ts +list: MethodWithRequiredArgument; +``` + +###### Description + +Get records from a List. + +###### See + +[\`slackLists.items.list\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.list). + +##### items.update + +```ts +update: MethodWithRequiredArgument; +``` + +###### Description + +Update a list item. + +###### See + +[\`slackLists.items.update\` API reference](https://docs.slack.dev/reference/methods/slackLists.items.update). + +#### update + +```ts +update: MethodWithRequiredArgument; +``` + +##### Description + +Update a list. + +##### See + +[\`slackLists.update\` API reference](https://docs.slack.dev/reference/methods/slackLists.update). + +#### Inherited from + +[`Methods`](Methods.md).[`slackLists`](Methods.md#slacklists) + +*** + ### stars ```ts readonly stars: object; ``` -Defined in: [src/methods.ts:2397](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2397) +Defined in: [src/methods.ts:2511](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2511) #### ~~add~~ @@ -3820,7 +4032,7 @@ See [our post on stars and the Later list](https://docs.slack.dev/changelog/2023 readonly team: object; ``` -Defined in: [src/methods.ts:2173](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2173) +Defined in: [src/methods.ts:2287](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2287) #### accessLogs @@ -3996,7 +4208,7 @@ Authentication and authorization token for accessing Slack Web API (usually begi readonly tooling: object; ``` -Defined in: [src/methods.ts:2244](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2244) +Defined in: [src/methods.ts:2358](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2358) #### tokens @@ -4030,7 +4242,7 @@ Exchanges a refresh token for a new app configuration token. readonly usergroups: object; ``` -Defined in: [src/methods.ts:2254](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2254) +Defined in: [src/methods.ts:2368](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2368) #### create @@ -4148,7 +4360,7 @@ Update the list of users in a User Group. readonly users: object; ``` -Defined in: [src/methods.ts:2297](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2297) +Defined in: [src/methods.ts:2411](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2411) #### conversations @@ -4342,7 +4554,7 @@ Manually sets user presence. readonly views: object; ``` -Defined in: [src/methods.ts:2367](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2367) +Defined in: [src/methods.ts:2481](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2481) #### open @@ -4412,7 +4624,7 @@ Update an existing view. readonly workflows: object; ``` -Defined in: [src/methods.ts:2421](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2421) +Defined in: [src/methods.ts:2535](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2535) #### featured @@ -4637,7 +4849,7 @@ options chatStream(params): ChatStreamer; ``` -Defined in: [src/WebClient.ts:537](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L537) +Defined in: [src/WebClient.ts:539](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L539) Stream markdown text into a conversation. @@ -4655,6 +4867,8 @@ Stream markdown text into a conversation. The "chatStream" method starts a new chat stream in a conversation that can be appended to. After appending an entire message, the stream can be stopped with concluding arguments such as "blocks" for gathering feedback. +The "markdown_text" content is appended to a buffer before being sent to the recipient, with a default buffer size of "256" characters. Setting the "buffer_size" value to a smaller number sends more frequent updates for the same amount of characters, but might reach rate limits more often. + #### Example ```ts @@ -4744,7 +4958,7 @@ listeners. filesUploadV2(options): Promise; ``` -Defined in: [src/WebClient.ts:558](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L558) +Defined in: [src/WebClient.ts:560](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L560) This wrapper method provides an easy way to upload files using the following endpoints: diff --git a/docs/english/reference/web-api/index.md b/docs/english/reference/web-api/index.md index 96fef9883..9bfcfd31f 100644 --- a/docs/english/reference/web-api/index.md +++ b/docs/english/reference/web-api/index.md @@ -1,4 +1,4 @@ -# @slack/web-api v7.12.0 +# @slack/web-api v7.13.0 ## Enumerations @@ -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) @@ -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) diff --git a/docs/english/reference/web-api/interfaces/AppRequestedEvent.md b/docs/english/reference/web-api/interfaces/AppRequestedEvent.md index 149157b9e..6fd4ff102 100644 --- a/docs/english/reference/web-api/interfaces/AppRequestedEvent.md +++ b/docs/english/reference/web-api/interfaces/AppRequestedEvent.md @@ -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 @@ -245,7 +245,7 @@ name: string; #### token\_type ```ts -token_type: null | "user" | "bot" | "app"; +token_type: "user" | "bot" | "app" | null; ``` *** diff --git a/docs/english/reference/web-api/interfaces/AssistantThreadContextChangedEvent.md b/docs/english/reference/web-api/interfaces/AssistantThreadContextChangedEvent.md index 18f2c3f4f..d0da55c61 100644 --- a/docs/english/reference/web-api/interfaces/AssistantThreadContextChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/AssistantThreadContextChangedEvent.md @@ -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? diff --git a/docs/english/reference/web-api/interfaces/AssistantThreadStartedEvent.md b/docs/english/reference/web-api/interfaces/AssistantThreadStartedEvent.md index 1553a11c2..1bcc145ca 100644 --- a/docs/english/reference/web-api/interfaces/AssistantThreadStartedEvent.md +++ b/docs/english/reference/web-api/interfaces/AssistantThreadStartedEvent.md @@ -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? diff --git a/docs/english/reference/web-api/interfaces/CodedError.md b/docs/english/reference/web-api/interfaces/CodedError.md index 24c64141f..89ff36670 100644 --- a/docs/english/reference/web-api/interfaces/CodedError.md +++ b/docs/english/reference/web-api/interfaces/CodedError.md @@ -41,7 +41,7 @@ NodeJS.ErrnoException.code optional errno: number; ``` -Defined in: node\_modules/@types/node/globals.d.ts:393 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -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 @@ -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 diff --git a/docs/english/reference/web-api/interfaces/SlackListsAccessDeleteArguments.md b/docs/english/reference/web-api/interfaces/SlackListsAccessDeleteArguments.md new file mode 100644 index 000000000..3c2a14ff2 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsAccessDeleteArguments.md @@ -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. diff --git a/docs/english/reference/web-api/interfaces/SlackListsAccessSetArguments.md b/docs/english/reference/web-api/interfaces/SlackListsAccessSetArguments.md new file mode 100644 index 000000000..57c9c37e2 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsAccessSetArguments.md @@ -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. diff --git a/docs/english/reference/web-api/interfaces/SlackListsCreateArguments.md b/docs/english/reference/web-api/interfaces/SlackListsCreateArguments.md new file mode 100644 index 000000000..07529e240 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsCreateArguments.md @@ -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 +``` diff --git a/docs/english/reference/web-api/interfaces/SlackListsDownloadGetArguments.md b/docs/english/reference/web-api/interfaces/SlackListsDownloadGetArguments.md new file mode 100644 index 000000000..debd38bd6 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsDownloadGetArguments.md @@ -0,0 +1,57 @@ +[@slack/web-api](../index.md) / SlackListsDownloadGetArguments + +# Interface: SlackListsDownloadGetArguments + +Defined in: [src/types/request/slackLists.ts:404](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L404) + +## Extends + +- `TokenOverridable` + +## Properties + +### job\_id + +```ts +job_id: string; +``` + +Defined in: [src/types/request/slackLists.ts:413](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L413) + +#### Description + +The ID of the recently started job to export the List. + +*** + +### list\_id + +```ts +list_id: string; +``` + +Defined in: [src/types/request/slackLists.ts:408](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L408) + +#### 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 +``` diff --git a/docs/english/reference/web-api/interfaces/SlackListsDownloadStartArguments.md b/docs/english/reference/web-api/interfaces/SlackListsDownloadStartArguments.md new file mode 100644 index 000000000..06957c93c --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsDownloadStartArguments.md @@ -0,0 +1,57 @@ +[@slack/web-api](../index.md) / SlackListsDownloadStartArguments + +# Interface: SlackListsDownloadStartArguments + +Defined in: [src/types/request/slackLists.ts:417](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L417) + +## Extends + +- `TokenOverridable` + +## Properties + +### include\_archived? + +```ts +optional include_archived: boolean; +``` + +Defined in: [src/types/request/slackLists.ts:426](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L426) + +#### Description + +Boolean indicating whether to include archived items. + +*** + +### list\_id + +```ts +list_id: string; +``` + +Defined in: [src/types/request/slackLists.ts:421](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L421) + +#### 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 +``` diff --git a/docs/english/reference/web-api/interfaces/SlackListsItemsCreateArguments.md b/docs/english/reference/web-api/interfaces/SlackListsItemsCreateArguments.md new file mode 100644 index 000000000..cbba09bbd --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsItemsCreateArguments.md @@ -0,0 +1,85 @@ +[@slack/web-api](../index.md) / SlackListsItemsCreateArguments + +# Interface: SlackListsItemsCreateArguments + +Defined in: [src/types/request/slackLists.ts:430](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L430) + +## Extends + +- `TokenOverridable` + +## Properties + +### duplicated\_item\_id? + +```ts +optional duplicated_item_id: string; +``` + +Defined in: [src/types/request/slackLists.ts:439](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L439) + +#### Description + +ID of the record to make a copy of. + +*** + +### initial\_fields? + +```ts +optional initial_fields: SlackListsItemField[]; +``` + +Defined in: [src/types/request/slackLists.ts:449](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L449) + +#### Description + +Initial item data. + +*** + +### list\_id + +```ts +list_id: string; +``` + +Defined in: [src/types/request/slackLists.ts:434](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L434) + +#### Description + +Encoded ID of the List. + +*** + +### parent\_item\_id? + +```ts +optional parent_item_id: string; +``` + +Defined in: [src/types/request/slackLists.ts:444](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L444) + +#### Description + +ID of the parent record for this subtask. + +*** + +### 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 +``` diff --git a/docs/english/reference/web-api/interfaces/SlackListsItemsDeleteArguments.md b/docs/english/reference/web-api/interfaces/SlackListsItemsDeleteArguments.md new file mode 100644 index 000000000..d8e6f78c5 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsItemsDeleteArguments.md @@ -0,0 +1,57 @@ +[@slack/web-api](../index.md) / SlackListsItemsDeleteArguments + +# Interface: SlackListsItemsDeleteArguments + +Defined in: [src/types/request/slackLists.ts:453](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L453) + +## Extends + +- `TokenOverridable` + +## Properties + +### id + +```ts +id: string; +``` + +Defined in: [src/types/request/slackLists.ts:462](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L462) + +#### Description + +ID of item to delete. + +*** + +### list\_id + +```ts +list_id: string; +``` + +Defined in: [src/types/request/slackLists.ts:457](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L457) + +#### 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 +``` diff --git a/docs/english/reference/web-api/interfaces/SlackListsItemsDeleteMultipleArguments.md b/docs/english/reference/web-api/interfaces/SlackListsItemsDeleteMultipleArguments.md new file mode 100644 index 000000000..eb097fdbb --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsItemsDeleteMultipleArguments.md @@ -0,0 +1,57 @@ +[@slack/web-api](../index.md) / SlackListsItemsDeleteMultipleArguments + +# Interface: SlackListsItemsDeleteMultipleArguments + +Defined in: [src/types/request/slackLists.ts:466](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L466) + +## Extends + +- `TokenOverridable` + +## Properties + +### ids + +```ts +ids: string[]; +``` + +Defined in: [src/types/request/slackLists.ts:475](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L475) + +#### Description + +IDs of the items to delete. + +*** + +### list\_id + +```ts +list_id: string; +``` + +Defined in: [src/types/request/slackLists.ts:470](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L470) + +#### 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 +``` diff --git a/docs/english/reference/web-api/interfaces/SlackListsItemsInfoArguments.md b/docs/english/reference/web-api/interfaces/SlackListsItemsInfoArguments.md new file mode 100644 index 000000000..8f927a7cb --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsItemsInfoArguments.md @@ -0,0 +1,71 @@ +[@slack/web-api](../index.md) / SlackListsItemsInfoArguments + +# Interface: SlackListsItemsInfoArguments + +Defined in: [src/types/request/slackLists.ts:479](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L479) + +## Extends + +- `TokenOverridable` + +## Properties + +### id + +```ts +id: string; +``` + +Defined in: [src/types/request/slackLists.ts:488](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L488) + +#### Description + +ID of item to delete. + +*** + +### include\_is\_subscribed? + +```ts +optional include_is_subscribed: boolean; +``` + +Defined in: [src/types/request/slackLists.ts:493](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L493) + +#### Description + +Set to true to include is_subscribed data for the returned List row. + +*** + +### list\_id + +```ts +list_id: string; +``` + +Defined in: [src/types/request/slackLists.ts:483](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L483) + +#### 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 +``` diff --git a/docs/english/reference/web-api/interfaces/SlackListsItemsListArguments.md b/docs/english/reference/web-api/interfaces/SlackListsItemsListArguments.md new file mode 100644 index 000000000..d148a2ead --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsItemsListArguments.md @@ -0,0 +1,85 @@ +[@slack/web-api](../index.md) / SlackListsItemsListArguments + +# Interface: SlackListsItemsListArguments + +Defined in: [src/types/request/slackLists.ts:497](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L497) + +## Extends + +- `TokenOverridable` + +## Properties + +### archived? + +```ts +optional archived: boolean; +``` + +Defined in: [src/types/request/slackLists.ts:516](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L516) + +#### Description + +Boolean indicating whether archived items or normal items should be returned. + +*** + +### cursor? + +```ts +optional cursor: string; +``` + +Defined in: [src/types/request/slackLists.ts:511](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L511) + +#### Description + +Next cursor for pagination. + +*** + +### limit? + +```ts +optional limit: number; +``` + +Defined in: [src/types/request/slackLists.ts:506](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L506) + +#### Description + +The maximum number of records to return. + +*** + +### list\_id + +```ts +list_id: string; +``` + +Defined in: [src/types/request/slackLists.ts:501](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L501) + +#### 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 +``` diff --git a/docs/english/reference/web-api/interfaces/SlackListsItemsUpdateArguments.md b/docs/english/reference/web-api/interfaces/SlackListsItemsUpdateArguments.md new file mode 100644 index 000000000..0e537ebf0 --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsItemsUpdateArguments.md @@ -0,0 +1,57 @@ +[@slack/web-api](../index.md) / SlackListsItemsUpdateArguments + +# Interface: SlackListsItemsUpdateArguments + +Defined in: [src/types/request/slackLists.ts:520](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L520) + +## Extends + +- `TokenOverridable` + +## Properties + +### cells + +```ts +cells: SlackListsItemCellUpdate[]; +``` + +Defined in: [src/types/request/slackLists.ts:529](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L529) + +#### Description + +Cells to update. Each cell includes the row_id, column_id, and field value. + +*** + +### list\_id + +```ts +list_id: string; +``` + +Defined in: [src/types/request/slackLists.ts:524](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L524) + +#### 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 +``` diff --git a/docs/english/reference/web-api/interfaces/SlackListsUpdateArguments.md b/docs/english/reference/web-api/interfaces/SlackListsUpdateArguments.md new file mode 100644 index 000000000..f46ca58fc --- /dev/null +++ b/docs/english/reference/web-api/interfaces/SlackListsUpdateArguments.md @@ -0,0 +1,85 @@ +[@slack/web-api](../index.md) / SlackListsUpdateArguments + +# Interface: SlackListsUpdateArguments + +Defined in: [src/types/request/slackLists.ts:533](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L533) + +## Extends + +- `TokenOverridable` + +## Properties + +### description\_blocks? + +```ts +optional description_blocks: RichTextBlock[]; +``` + +Defined in: [src/types/request/slackLists.ts:547](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L547) + +#### Description + +A rich text description of the List. + +*** + +### id + +```ts +id: string; +``` + +Defined in: [src/types/request/slackLists.ts:537](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L537) + +#### Description + +Encoded ID of the List. + +*** + +### name? + +```ts +optional name: string; +``` + +Defined in: [src/types/request/slackLists.ts:542](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L542) + +#### Description + +Name of the List. + +*** + +### todo\_mode? + +```ts +optional todo_mode: boolean; +``` + +Defined in: [src/types/request/slackLists.ts:552](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/request/slackLists.ts#L552) + +#### 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 +``` diff --git a/docs/english/reference/web-api/interfaces/TeamJoinEvent.md b/docs/english/reference/web-api/interfaces/TeamJoinEvent.md index 13d93b695..e64e5b466 100644 --- a/docs/english/reference/web-api/interfaces/TeamJoinEvent.md +++ b/docs/english/reference/web-api/interfaces/TeamJoinEvent.md @@ -234,11 +234,11 @@ optional email: string; ```ts fields: - | null | { [key: string]: object; } - | []; + | [] + | null; ``` ##### profile.first\_name diff --git a/docs/english/reference/web-api/interfaces/UserChangeEvent.md b/docs/english/reference/web-api/interfaces/UserChangeEvent.md index 75ea0aa30..856913b83 100644 --- a/docs/english/reference/web-api/interfaces/UserChangeEvent.md +++ b/docs/english/reference/web-api/interfaces/UserChangeEvent.md @@ -234,11 +234,11 @@ optional email: string; ```ts fields: - | null | [] | { [key: string]: object; -}; +} + | null; ``` ##### profile.first\_name diff --git a/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md b/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md index 54942d2f0..a5de8136f 100644 --- a/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/UserHuddleChangedEvent.md @@ -234,11 +234,11 @@ optional email: string; ```ts fields: - | null | [] | { [key: string]: object; -}; +} + | null; ``` ##### profile.first\_name diff --git a/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md b/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md index cf83e8126..d226b1c0d 100644 --- a/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/UserProfileChangedEvent.md @@ -234,11 +234,11 @@ optional email: string; ```ts fields: - | null | [] | { [key: string]: object; -}; +} + | null; ``` ##### profile.first\_name diff --git a/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md b/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md index 5f51ba51f..0b237f8cf 100644 --- a/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md +++ b/docs/english/reference/web-api/interfaces/UserStatusChangedEvent.md @@ -234,11 +234,11 @@ optional email: string; ```ts fields: - | null | [] | { [key: string]: object; -}; +} + | null; ``` ##### profile.first\_name diff --git a/docs/english/reference/web-api/interfaces/WebAPIHTTPError.md b/docs/english/reference/web-api/interfaces/WebAPIHTTPError.md index 1e1e963a4..777f8fdb7 100644 --- a/docs/english/reference/web-api/interfaces/WebAPIHTTPError.md +++ b/docs/english/reference/web-api/interfaces/WebAPIHTTPError.md @@ -42,7 +42,7 @@ Defined in: [src/errors.ts:52](https://github.com/slackapi/node-slack-sdk/blob/m 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 @@ -94,7 +94,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 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 @@ -142,7 +142,7 @@ Defined in: [src/errors.ts:54](https://github.com/slackapi/node-slack-sdk/blob/m 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 diff --git a/docs/english/reference/web-api/interfaces/WebAPIPlatformError.md b/docs/english/reference/web-api/interfaces/WebAPIPlatformError.md index b78825aba..6b778c333 100644 --- a/docs/english/reference/web-api/interfaces/WebAPIPlatformError.md +++ b/docs/english/reference/web-api/interfaces/WebAPIPlatformError.md @@ -50,7 +50,7 @@ error: string; optional errno: number; ``` -Defined in: node\_modules/@types/node/globals.d.ts:393 +Defined in: node\_modules/@types/node/globals.d.ts:102 #### Inherited from @@ -92,7 +92,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 optional path: string; ``` -Defined in: node\_modules/@types/node/globals.d.ts:395 +Defined in: node\_modules/@types/node/globals.d.ts:104 #### Inherited from @@ -120,7 +120,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 optional syscall: string; ``` -Defined in: node\_modules/@types/node/globals.d.ts:396 +Defined in: node\_modules/@types/node/globals.d.ts:105 #### Inherited from diff --git a/docs/english/reference/web-api/interfaces/WebAPIRateLimitedError.md b/docs/english/reference/web-api/interfaces/WebAPIRateLimitedError.md index 6a191e4d6..0fc867300 100644 --- a/docs/english/reference/web-api/interfaces/WebAPIRateLimitedError.md +++ b/docs/english/reference/web-api/interfaces/WebAPIRateLimitedError.md @@ -32,7 +32,7 @@ Defined in: [src/errors.ts:61](https://github.com/slackapi/node-slack-sdk/blob/m 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 @@ -74,7 +74,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 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 @@ -112,7 +112,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 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 diff --git a/docs/english/reference/web-api/interfaces/WebAPIRequestError.md b/docs/english/reference/web-api/interfaces/WebAPIRequestError.md index 34aa2ef28..cea150cc3 100644 --- a/docs/english/reference/web-api/interfaces/WebAPIRequestError.md +++ b/docs/english/reference/web-api/interfaces/WebAPIRequestError.md @@ -32,7 +32,7 @@ Defined in: [src/errors.ts:47](https://github.com/slackapi/node-slack-sdk/blob/m 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 @@ -84,7 +84,7 @@ Defined in: [src/errors.ts:48](https://github.com/slackapi/node-slack-sdk/blob/m 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 @@ -112,7 +112,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078 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 diff --git a/docs/english/reference/web-api/type-aliases/Method.md b/docs/english/reference/web-api/type-aliases/Method.md index b6711cc56..9ae67c6d0 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: [src/methods.ts:535](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L535) +Defined in: [src/methods.ts:559](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L559) ## Type Parameters diff --git a/docs/english/reference/web-api/type-aliases/SlackListsAccessDeleteResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsAccessDeleteResponse.md new file mode 100644 index 000000000..ac611aeed --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsAccessDeleteResponse.md @@ -0,0 +1,35 @@ +[@slack/web-api](../index.md) / SlackListsAccessDeleteResponse + +# Type Alias: SlackListsAccessDeleteResponse + +```ts +type SlackListsAccessDeleteResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsAccessDeleteResponse.ts:3](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsAccessDeleteResponse.ts#L3) + +## Type Declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/SlackListsAccessSetResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsAccessSetResponse.md new file mode 100644 index 000000000..9f7dc9b11 --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsAccessSetResponse.md @@ -0,0 +1,35 @@ +[@slack/web-api](../index.md) / SlackListsAccessSetResponse + +# Type Alias: SlackListsAccessSetResponse + +```ts +type SlackListsAccessSetResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsAccessSetResponse.ts:3](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsAccessSetResponse.ts#L3) + +## Type Declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/SlackListsCreateResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsCreateResponse.md new file mode 100644 index 000000000..3309cf5cf --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsCreateResponse.md @@ -0,0 +1,59 @@ +[@slack/web-api](../index.md) / SlackListsCreateResponse + +# Type Alias: SlackListsCreateResponse + +```ts +type SlackListsCreateResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsCreateResponse.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsCreateResponse.ts#L4) + +## Type Declaration + +### error? + +```ts +optional error: string; +``` + +### list\_id? + +```ts +optional list_id: string; +``` + +### list\_metadata? + +```ts +optional list_metadata: object; +``` + +#### list\_metadata.schema? + +```ts +optional schema: SlackListsSchemaColumnResponse[]; +``` + +#### list\_metadata.subtask\_schema? + +```ts +optional subtask_schema: SlackListsSchemaColumnResponse[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/SlackListsDownloadGetResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsDownloadGetResponse.md new file mode 100644 index 000000000..2ac9e08cd --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsDownloadGetResponse.md @@ -0,0 +1,47 @@ +[@slack/web-api](../index.md) / SlackListsDownloadGetResponse + +# Type Alias: SlackListsDownloadGetResponse + +```ts +type SlackListsDownloadGetResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsDownloadGetResponse.ts:3](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsDownloadGetResponse.ts#L3) + +## Type Declaration + +### download\_url? + +```ts +optional download_url: string; +``` + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### status? + +```ts +optional status: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/SlackListsDownloadStartResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsDownloadStartResponse.md new file mode 100644 index 000000000..248ede875 --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsDownloadStartResponse.md @@ -0,0 +1,41 @@ +[@slack/web-api](../index.md) / SlackListsDownloadStartResponse + +# Type Alias: SlackListsDownloadStartResponse + +```ts +type SlackListsDownloadStartResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsDownloadStartResponse.ts:3](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsDownloadStartResponse.ts#L3) + +## Type Declaration + +### error? + +```ts +optional error: string; +``` + +### job\_id? + +```ts +optional job_id: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/SlackListsItemsCreateResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsItemsCreateResponse.md new file mode 100644 index 000000000..a9e5399e8 --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsItemsCreateResponse.md @@ -0,0 +1,41 @@ +[@slack/web-api](../index.md) / SlackListsItemsCreateResponse + +# Type Alias: SlackListsItemsCreateResponse + +```ts +type SlackListsItemsCreateResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsItemsCreateResponse.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsItemsCreateResponse.ts#L4) + +## Type Declaration + +### error? + +```ts +optional error: string; +``` + +### item? + +```ts +optional item: SlackListsItem; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/SlackListsItemsDeleteMultipleResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsItemsDeleteMultipleResponse.md new file mode 100644 index 000000000..afff158bf --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsItemsDeleteMultipleResponse.md @@ -0,0 +1,35 @@ +[@slack/web-api](../index.md) / SlackListsItemsDeleteMultipleResponse + +# Type Alias: SlackListsItemsDeleteMultipleResponse + +```ts +type SlackListsItemsDeleteMultipleResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsItemsDeleteMultipleResponse.ts:3](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsItemsDeleteMultipleResponse.ts#L3) + +## Type Declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/SlackListsItemsDeleteResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsItemsDeleteResponse.md new file mode 100644 index 000000000..72567c6a8 --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsItemsDeleteResponse.md @@ -0,0 +1,35 @@ +[@slack/web-api](../index.md) / SlackListsItemsDeleteResponse + +# Type Alias: SlackListsItemsDeleteResponse + +```ts +type SlackListsItemsDeleteResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsItemsDeleteResponse.ts:3](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsItemsDeleteResponse.ts#L3) + +## Type Declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/SlackListsItemsInfoResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsItemsInfoResponse.md new file mode 100644 index 000000000..62e40fd2d --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsItemsInfoResponse.md @@ -0,0 +1,53 @@ +[@slack/web-api](../index.md) / SlackListsItemsInfoResponse + +# Type Alias: SlackListsItemsInfoResponse + +```ts +type SlackListsItemsInfoResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsItemsInfoResponse.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsItemsInfoResponse.ts#L4) + +## Type Declaration + +### error? + +```ts +optional error: string; +``` + +### list? + +```ts +optional list: SlackList; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### record? + +```ts +optional record: SlackListsItemWithSubscription; +``` + +### subtasks? + +```ts +optional subtasks: SlackListsItem[]; +``` diff --git a/docs/english/reference/web-api/type-aliases/SlackListsItemsListResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsItemsListResponse.md new file mode 100644 index 000000000..400291fa1 --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsItemsListResponse.md @@ -0,0 +1,53 @@ +[@slack/web-api](../index.md) / SlackListsItemsListResponse + +# Type Alias: SlackListsItemsListResponse + +```ts +type SlackListsItemsListResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsItemsListResponse.ts:4](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsItemsListResponse.ts#L4) + +## Type Declaration + +### error? + +```ts +optional error: string; +``` + +### items? + +```ts +optional items: SlackListsItem[]; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` + +### response\_metadata? + +```ts +optional response_metadata: object; +``` + +#### response\_metadata.next\_cursor? + +```ts +optional next_cursor: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/SlackListsItemsUpdateResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsItemsUpdateResponse.md new file mode 100644 index 000000000..64c592aa7 --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsItemsUpdateResponse.md @@ -0,0 +1,35 @@ +[@slack/web-api](../index.md) / SlackListsItemsUpdateResponse + +# Type Alias: SlackListsItemsUpdateResponse + +```ts +type SlackListsItemsUpdateResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsItemsUpdateResponse.ts:3](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsItemsUpdateResponse.ts#L3) + +## Type Declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` diff --git a/docs/english/reference/web-api/type-aliases/SlackListsUpdateResponse.md b/docs/english/reference/web-api/type-aliases/SlackListsUpdateResponse.md new file mode 100644 index 000000000..eb68e3b7e --- /dev/null +++ b/docs/english/reference/web-api/type-aliases/SlackListsUpdateResponse.md @@ -0,0 +1,35 @@ +[@slack/web-api](../index.md) / SlackListsUpdateResponse + +# Type Alias: SlackListsUpdateResponse + +```ts +type SlackListsUpdateResponse = WebAPICallResult & object; +``` + +Defined in: [src/types/response/SlackListsUpdateResponse.ts:3](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/types/response/SlackListsUpdateResponse.ts#L3) + +## Type Declaration + +### error? + +```ts +optional error: string; +``` + +### needed? + +```ts +optional needed: string; +``` + +### ok? + +```ts +optional ok: boolean; +``` + +### provided? + +```ts +optional provided: string; +``` diff --git a/packages/web-api/package.json b/packages/web-api/package.json index 4c338834d..36ffc23bf 100644 --- a/packages/web-api/package.json +++ b/packages/web-api/package.json @@ -1,6 +1,6 @@ { "name": "@slack/web-api", - "version": "7.12.0", + "version": "7.13.0", "description": "Official library for using the Slack Platform's Web API", "author": "Slack Technologies, LLC", "license": "MIT",