diff --git a/docs/content/migration/migrating-socket-mode-package-to-v2.md b/docs/content/migration/migrating-socket-mode-package-to-v2.md new file mode 100644 index 000000000..c32a41489 --- /dev/null +++ b/docs/content/migration/migrating-socket-mode-package-to-v2.md @@ -0,0 +1,18 @@ +# Migrating the `socket‐mode` package to v2.x + +This migration guide helps you transition an application written using the `v1.x` series of the `@slack/socket-mode` package to the `v2.x` series. This guide focuses specifically on the breaking changes to help get your existing projects up and running as quickly as possible. + +## Installation + +``` +npm i @slack/socket-mode +``` + +## Breaking Changes + +1. Two [Lifecycle Events](https://github.com/slackapi/node-slack-sdk/tree/main/packages/socket-mode#lifecycle-events) have been removed: + - `authenticated`. This event corresponded to the client retrieving a response from the [`apps.connections.open`](https://api.slack.com/methods/apps.connections.open) Slack API method - but it didn't signal anything about the actual socket connection that matters! If you had been listening to this event, we recommend moving instead to one of these two events: + - `connected`. This signals that the client has established a connection with Slack and has received a `hello` message from the Slack backend. Events will start flowing to your app after this event. + - `connecting`. This signals that the client is about to establish a connection with Slack. If you were using `authenticated` to be notified _before_ the client establishes a connection, we recommend using this event instead. + - `unable_to_socket_mode_start`. This event corresponded to an error happening when attempting to hit the [`apps.connections.open`](https://api.slack.com/methods/apps.connections.open) Slack API method. We recommend moving instead to `reconnecting` (if you have client reconnections enabled), or the `error` event. +2. Two public properties on the client have been removed: `connected` and `authenticated`. Instead, we recommend migrating to the `isActive()` method to determine whether the WebSocket connection powering the client is healthy. \ No newline at end of file diff --git a/docs/content/migration/migrating-to-v4.md b/docs/content/migration/migrating-to-v4.md new file mode 100644 index 000000000..9b318c4d6 --- /dev/null +++ b/docs/content/migration/migrating-to-v4.md @@ -0,0 +1,316 @@ +# Migrating to v4.x + +This migration guide helps you transition an application written using the `v3.x` series of this package, to the `v4.x` series. This guide focuses specifically on the breaking changes to help get your existing app up and running as quickly as possible. In some cases, there may be better techniques for accomplishing what your app already does by utilizing brand new features or new API methods. Learn about all the new features in our [`v4.0.0` release notes](https://github.com/slackapi/node-slack-sdk/releases/tag/v4.0.0) if you'd like to go beyond a simple port. + +## WebClient + +### Constructor + +* The `slackAPIUrl` option has been renamed to `slackApiUrl` to improve readability. +* The `transport` option has been removed. If you used this option to implement proxy support, use the new `agent` option as described [below](#proxy-support-with-agent). If you used this option for setting custom TLS configuration, use the new `tls` option as described [below](#custom-tls-configuration). If you were using this for some other reason, please [open an issue](https://github.com/slackapi/node-slack-sdk/issues/new) and describe your use case so we can help you migrate. + +### All methods + +All Web API methods no longer take positional arguments. They each take one argument, an object, in which some properties are required and others are optional (depending on the method). You no longer have to memorize or look up the order of the arguments. The method arguments are described in the [API method documentation](https://api.slack.com/methods). If you are using an editor that understands TypeScript or JSDoc annotations, your editor may present you with useful information about these arguments as you type. + +If any Web API method is called with a callback parameter, and the call results in an error from the platform, you will no longer get the platform's response as the second argument to the callback. Instead, that response will exist as the `.data` property on the first argument (the error). You can consolidate this logic by using Promises instead (or continue to use callbacks if you prefer). + +**Before:** + +```javascript +const { WebClient } = require('@slack/client') +const web = new WebClient(token); + +web.chat.postMessage(channelId, text, { as_user: true, parse: 'full' }, (error, resp) => { + if (error) { + if (resp) { + // a platform error occurred, `resp.error` contains the error information + } + // some other error occurred + return; + } + + // success +}); +``` + +**After:** + +```javascript +// a new export, ErrorCode, is a dictionary of known error types +const { WebClient, ErrorCode } = require('@slack/client') +const web = new WebClient(token); + +web.chat.postMessage({ channel: channelId, text, as_user: true, parse: 'full' }) + .then((resp) => { /* success */ }) + .catch((error) => { + if (error.code === ErrorCode.PlatformError) { + // a platform error occurred, `error.message` contains error information, `error.data` contains the entire resp + } else { + // some other error occurred + } + }); +``` + +### `dm` methods + +This family of methods was always a duplicate of those under the `.im` family. These duplicates have been removed. + +### `mpdm` methods + +This family of methods was always a duplicate of those under the `.mpim` family. These duplicates have been removed. + +## `RTMClient` + +The top-level export name has changed from `RtmClient` to `RTMClient`. + +### Constructor + +* The `slackAPIUrl` option has been renamed to `slackApiUrl` to improve readability. +* The `dataStore` option has been removed. +* The `useRtmConnect` option now has a default value of `true`. We recommend querying for additional data using a `WebClient` after this client is connected. If that doesn't help, then you can set this option to `false`. +* The `socketFn` option has been removed. If you used this option to implement proxy support, use the new `agent` option as described [below](#proxy-support-with-agent). If you used this option for setting custom TLS configuration, use the new `tls` option as described [below](#custom-tls-configuration). If you were using this for some other reason, please [open an issue](https://github.com/slackapi/node-slack-sdk/issues/new) and describe your use case so we can help you migrate. +* The `wsPingInterval` and `maxPongInterval` options have been replaced with `clientPingTimeout` and `serverPongTimeout`. Most likely, you can replace these values respectively, or drop using them all together. + +### `dataStore` + +The v3.15.0 release of `@slack/client` has deprecated use of the `SlackDataStore` interface and its implementations (including `SlackMemoryDataStore`). In v4.0.0 ([release milestone](https://github.com/slackapi/node-slack-sdk/milestone/2)), these types and APIs have been removed. + +The datastore APIs have helped apps keep track of team state since this feature was released. But as the Slack platform has evolved, the model has become out of date in tricky and unexpected ways. The data store was designed to behave like the Slack web and desktop applications, managing the type of state that a logged in human user would typically need. But bots and Slack apps have a whole new (and more powerful in many ways) perspective of the world! + +At a high level, here are the design issues that could not be addressed in a backwards compatible way: + +- **Synchronous calling convention** - In order to plug in storage destinations other than memory (`SlackMemoryDataStore`), the code to reach that destination would need to be asynchronous. This is important if you want to share state across many processes while horizontally scaling an app. As a result, the maintainers have never seen an implementation of the `SlackDataStore` interface other than the memory-based one provided. + +- **Names versus IDs** - While we always thought it was a good idea to use IDs anywhere possible in programmatic use, the Slack platform wasn't overly strict about it. With the introduction of Shared Channels, we cannot preserve any guarantees of uniqueness for usernames, as we mentioned in this [changelog entry](https://api.slack.com/changelog/2017-09-the-one-about-usernames). In fact, channel names also lose these types of guarantees. The APIs in the `SlackDataStore` that operate on names instead of IDs start to break since the fundamental assumptions are not true anymore. + +- **Missing Users** - We want the SDK to be clear and easy to use across many use cases, including applications developed for Enterprise Grid and Shared Channels. In this context, an application is likely to receive events from users it does not recognize and for whom it cannot get more information. `SlackDataStore` cannot deal with these scenarios. If your application has more than one RTM client connected to different workspaces, and those workspaces are joined by a shared channel, there is no general purpose way to deduplicate the messages and arrive at a consistent deterministic state. The Slack platform has solved for this issue using the Events API (which deduplicates events on your app's behalf). + +For the full discussion, see [#330](https://github.com/slackapi/node-slack-sdk/issues/330). + +When you initialize an `RtmClient` object, turn on the `useRtmConnect` option and turn off the `dataStore` option as below: + +```javascript +const { RtmClient } = require('@slack/client'); + +const rtm = new RtmClient('your-token-here', { + useRtmConnect: true, + dataStore: false, +}); +``` + +Next look through your code for any places you might reference the `.dataStore` property of the `RtmClient`. In most cases, you'll be able to replace finding data in the dataStore with finding that data using a `WebClient`. + +```javascript +const { RtmClient, WebClient } = require('@slack/client'); +const web = new WebClient('your-token-here'); + +// Before: +// const channel = rtm.dataStore.getChannelById(channelId); +// console.log(`channel info: ${JSON.stringify(channel)}`); + +// After: +web.conversations.info(channelId) + .then(resp => console.log(`channel info: ${JSON.stringify(resp.channel)}`) + .catch(error => /* TODO: handle error */); +``` + +If you aren't sure how to translate a specific data store method into a Web API call, file a new `question` issue and we will help you figure it out. + +You'll notice that this code has become asynchronous. This will likely be the largest challenge in migrating away from the data store, but for most developers it will be worth it. + +For the majority of apps, you will be ready for v4 at this point. If your app is having performance related issues, there's room to make improvements by caching the data that is relevant to your app. This should only be taken on if you believe it's necessary, since cache invalidation is one of the [only two hard things in computer science](https://martinfowler.com/bliki/TwoHardThings.html). + +The approach for caching data that we recommend is to pick out the data your app needs, store it at connection time, and update it according to a determined policy. You may want to disable the `useRtmConnect` option in order +to get more data at connection time. + +### `reconnect()` + +This method has been removed, but it can be substituted by using `disconnect()`, waiting for the `disconnected` event, and then calling `start(options)`. Reconnecting using the method was rarely used by developers, and its implementation increased the complexity of state management in the client. + +**Before:** + +```javascript +rtm.reconnect(); +``` + +**After:** + +```javascript +rtm.disconnect(); +// You will need to store the start options from the first time you connect and then reuse them here. +rtm.once('disconnected', () => rtm.start(options)); +``` + +### `updateMessage()` + +This method has been removed from the `RTMClient`, but can be substituted by using the `WebClient`. + +**Before:** + +```javascript +const message = { ts: '999999999.0000000', channel: 'C123456', text: 'updated message text' }; +rtm.updateMessage(message).then(console.log); +``` + +**After:** + +```javascript +// We recommend that you initialize this object at the same time you would have initialized the RTMClient +const web = new WebClient(token); + +const message = { ts: '999999999.0000000', channel: 'C123456', text: 'updated message text' }; +web.chat.update(message).then(console.log); +``` + +### `send()` + +This method has be repurposed, and in most cases you will instead rely on `addOutgoingEvent(awaitReply, type, body)`. + +The main difference is that if you want to know when the message is acknowledged by the server (you were using the optional callback parameter to `send()`), you'll only be able to do so using the returned Promise. If you prefer callbacks, you can translate the interface using a library like Bluebird (see: http://bluebirdjs.com/docs/api/ascallback.html) or the Node [`util.callbackify()`](https://nodejs.org/api/util.html#util_util_callbackify_original) since v8.2.0. + +As an added benefit, you will be able to send the message without worrying whether the client is in a connected state or not. + +**Before:** + +```javascript +const message = { type: 'message_type', key: 'value', foo: 'bar' }; +rtm.send(message, (error, resp) => { + if (error) { + // error handling + return; + } + // success handling +}); +``` + +**After:** + +```javascript +const message = { type: 'message_type', key: 'value', foo: 'bar' }; +rtm.addOutgoingEvent(true, message.type, message) + .then((resp) => { + // success handling + }) + .catch((error) => { + // error handling + }); +``` + +### Events {#events} + +The `RTMClient` now has more well-defined states (and substates) that you may observe using the [`EventEmitter` API pattern](https://nodejs.org/api/events.html). The following table helps describe the relationship between events in the `v3.x` series and events in the `v4.x` series. + +| Event Name (`v4.x`) | Event Name (`v3.x`) | Description | +|-----------------|-----------------|-------------| +| `disconnected` | `disconnect` | The client is not connected to the platform. This is a steady state - no attempt to connect is occurring. | +| `connecting` | `connecting` / `attempting_reconnect` | The client is in the process of connecting to the platform. | +| `authenticated` | `authenticated` | The client has authenticated with the platform. The `rtm.connect` or `rtm.start` response is emitted as an argument. This is a sub-state of `connecting`. | +| `connected` | | The client is connected to the platform and incoming events will start being emitted. | +| `ready` | `open` | The client is ready to send outgoing messages. This is a sub-state of `connected` | +| `disconnecting` | | The client is no longer connected to the platform and cleaning up its resources. It will soon transition to `disconnected`. | +| `reconnecting` | | The client is no longer connected to the platform and cleaning up its resources. It will soon transition to `connecting`. | +| `error` | `ws_error` | An error has occurred. The error is emitted as an argument. The `v4` event is a super set of the `v3` event. To test whether the event is a websocket error, check `error.code === ErrorCodes.RTMWebsocketError` | +| `unable_to_rtm_start` | `unable_to_rtm_start` | A problem occurred while connecting, a reconnect may or may not occur. Use of this event is discouraged since `disconnecting` and `reconnecting` are more meaningful. | +| `slack_event` | | An incoming Slack event has been received. The event type and event body are emitted as the arguments. | +| `{type}` | `{type}` | An incoming Slack event of type `{type}` has been received. The event is emitted as an argument. An example is `message` for all message events | +| `{type}::{subtype}` | `{type}::{subtype}` | An incoming Slack event of type `{type}` and subtype `{subtype}` has been received. The event is emitted as an argument. An example is `message::bot_message` for all bot messages. | +| `raw_message` | `raw_message` | A websocket message arrived. The message (unparsed string) is emitted as an argument. Use of this event is discouraged since `slack_event` is more useful. | +| | `ws_opening` | This event is no longer emitted, and the state of the underlying websocket is considered private. | +| | `ws_opened` | This event is no longer emitted, and the state of the underlying websocket is considered private. | +| | `ws_close` | This event is no longer emitted, and the state of the underlying websocket is considered private. | + +## Incoming webhooks + +* The following options have been renamed: + - `iconEmoji` => `icon_emoji` + - `iconUrl` => `icon_url` + - `linkNames` => `link_names` + - `unfurlLinks` => `unfurl_links` + - `unfurlMedia` => `unfurl_media` + +## Removed constants + +The `CLIENT_EVENTS`, `RTM_EVENTS` and `RTM_MESSAGE_SUBTYPES` constants have been removed. We recommend using simple strings for event names. The values that were in `CLIENT_EVENTS` have been migrated according to the [events table above](#events). The `RTM_EVENTS` dictionary isn't necessary, just directly subscribe to the event name as a string. + +**Before:** +```javascript +rtm.on(CLIENT_EVENTS.RTM.AUTHENTICATED, (connectionData) => { + console.log('RTMClient authenticated'); +}); + +rtm.on(RTM_EVENTS.MESSAGE, (event) => { + console.log(`Incoming message: ${event.ts}`); +}) +``` + +**After:** +```javascript +rtm.on('authenticated', (connectionData) => { + console.log('RTMClient authenticated'); +}); + +rtm.on('message', (event) => { + console.log(`Incoming message: ${event.ts}`); +}) +``` + +## `RETRY_POLICIES` + +The names of these policies have slightly changed for more consistency with our style guide. The dictionary of policies is now exported under the name `retryPolicies`. See `src/retry-policies.ts` for details. + +## Proxy support with `agent` + +In order to pass outgoing requests from `WebClient` or `RTMClient` through an HTTP proxy, you'll first need to install an additional package in your application: + +``` +$ npm install --save https-proxy-agent +``` + +Next, use the `agent` option in the client constructor to configure with your proxy settings. + +```javascript +const HttpsProxyAgent = require('https-proxy-agent'); +const { WebClient, RTMClient } = require('@slack/client'); + +// in this example, we read the token from an environment variable. its best practice to keep sensitive data outside +// your source code. +const token = process.env.SLACK_TOKEN; + +// its common to read the proxy URL from an environment variable, since it also may be sensitive. +const proxyUrl = process.env.http_proxy || 'http://12.34.56.78:9999'; + +// To use Slack's Web API: +const web = new WebClient(token, { agent: new HttpsProxyAgent(proxyUrl) }); + +// To use Slack's RTM API: +const rtm = new RTMClient(token, { agent: new HttpsProxyAgent(proxyUrl) }); + +// NOTE: for a more complex proxy configuration, see the https-proxy-agent documentation: +// https://github.com/TooTallNate/node-https-proxy-agent#api +``` + +## Custom TLS configuration + +You may want to use a custom TLS configuration if your application needs to send requests through a server with a +self-signed certificate. + +Example: + +```javascript +const { WebClient, RTMClient } = require('@slack/client'); + +// in this example, we read the token from an environment variable. its best practice to keep sensitive data outside +// your source code. +const token = process.env.SLACK_TOKEN; + +// Configure TLS options +const tls = { + key: fs.readFileSync('/path/to/key'), + cert: fs.readFileSync('/path/to/cert'), + ca: fs.readFileSync('/path/to/cert'), +}; + +const web = new WebClient(token, { slackApiUrl: 'https://fake.slack.com/api', tls }); +const rtm = new RTMClient(token, { slackApiUrl: 'https://fake.slack.com/api', tls }); +``` diff --git a/docs/content/tutorials/migrating-to-v5.md b/docs/content/migration/migrating-to-v5.md similarity index 94% rename from docs/content/tutorials/migrating-to-v5.md rename to docs/content/migration/migrating-to-v5.md index c50ba419c..f0b5872ec 100644 --- a/docs/content/tutorials/migrating-to-v5.md +++ b/docs/content/migration/migrating-to-v5.md @@ -1,31 +1,21 @@ ---- -title: Migrating to v5.x ---- - -# Migration Guide (v4 to v5) +# Migrating to v5.x This tutorial will guide you through the process of updating your app from using the `@slack/client` package (`v4.x`) to using the new, improved, and independent packages, starting with `v5.0.0`. If you were not using any deprecated features, this should only take a couple minutes. -:::info +:::info[If you were using the `@slack/events-api` or `@slack/interactive-messages` packages, this migration doesn't affect your app] -If you were using the `@slack/events-api` or `@slack/interactive-messages` packages, this migration doesn't -affect your app. Those packages only moved repositories, but did not get updated in this process. You're done! +Those packages only moved repositories, but did not get updated in this process. You're done! ::: ## Update to a supported version of Node -These package have dropped support for versions of Node that are no longer supported. We recommend updating to the -latest LTS version of [Node](https://nodejs.org/en/), which at this time is v10.15.3. The minimum supported version is -v8.9.0. - -:::info +These packages have dropped support for versions of Node that are no longer supported. We recommend updating to the latest LTS version of [Node](https://nodejs.org/en/), which at this time is v10.15.3. The minimum supported version is v8.9.0. -Learn more about our [support schedule](https://github.com/slackapi/node-slack-sdk/wiki/Support-Schedule) so -that you can prepare and plan for future updates. +:::info[Learn more about our [support schedule](/support-schedule) so that you can prepare and plan for future updates.] ::: diff --git a/docs/content/tutorials/migrating-to-v6.md b/docs/content/migration/migrating-to-v6.md similarity index 81% rename from docs/content/tutorials/migrating-to-v6.md rename to docs/content/migration/migrating-to-v6.md index c26cdd3a8..b21ffaf89 100644 --- a/docs/content/tutorials/migrating-to-v6.md +++ b/docs/content/migration/migrating-to-v6.md @@ -1,8 +1,4 @@ ---- -title: Migrating to v6.x ---- - -# Migration Guide (v5 to v6) +# Migrating to v6.x The following packages have been updated in the release being dubbed as `v6`: * `@slack/web-api@6.0.0` @@ -19,11 +15,9 @@ To migrate to the latest packages, updating your minimum Node.js to `12.13.0` is ### Minimum Node Version -Our newly released major versions all require a minimum Node version of `12.13.0` and minimum npm version of `6.12.0` . - -:::info +Our newly released major versions all require a minimum Node version of `12.13.0` and minimum npm version of `6.12.0`. -Learn more about our [support schedule](https://github.com/slackapi/node-slack-sdk/wiki/Support-Schedule) so that you can prepare and plan for future updates. +:::info[Learn more about our [support schedule](/support-schedule) so that you can prepare and plan for future updates.] ::: @@ -89,9 +83,9 @@ installationStore: { }, ``` -### Deprecating @slack/events-api & @slack/interactive-messages +### Deprecating `@slack/events-api` & `@slack/interactive-messages` packages -`@slack/events-api` and `@slack/interactive-messages` will be deprecated on **January 12th, 2021**. We will only implement **critical bug fixes** until the official end of life date and close non critical issues and pull requests, which is slated for **May 31st, 2021**. At this time, development will fully stop for these packages and all remaining open issues and pull requests will be closed. Bolt for JavaScript can now perform all the same functionality as these packages. We think you’ll love the more modern set of features you get in Bolt. Here are some migration examples: +`@slack/events-api` and `@slack/interactive-messages`are now deprecated and have reached end of life. Development has fully stopped for these packages and all remaining open issues and pull requests have been closed. Bolt for JavaScript can now perform all the same functionality as these packages. We think you’ll love the more modern set of features you get in Bolt. Here are some migration examples: Before: ```javascript diff --git a/docs/content/migration/migrating-web-api-package-to-v7.md b/docs/content/migration/migrating-web-api-package-to-v7.md new file mode 100644 index 000000000..76d0338b4 --- /dev/null +++ b/docs/content/migration/migrating-web-api-package-to-v7.md @@ -0,0 +1,217 @@ +# Migrating the `web-api` package to v7.x + +This migration guide helps you transition an application written using the `v6.x` series of the `@slack/web-api` package to the `v7.x` +series. This guide focuses specifically on the breaking changes to help get your existing app up and running as +quickly as possible. + +## Installation + +``` +npm i @slack/web-api +``` + +## `@slack/web-api` v7 Changes + +**TL;DR**: this package now supports only node v18 and newer, and HTTP API arguments passed to methods in this project in the context of a TypeScript project are stricter. + +This release focuses on the type safety of Slack HTTP API method arguments provided by `@slack/web-api`. If you use this package in a TypeScript project, many of the HTTP API methods now have stricter argument typing, which hopefully helps guide developers towards proper argument usage for Slack's HTTP API methods. + +**If you use this package in a JavaScript project, no such guidance is provided and the breaking changes listed below do not apply to you.** + +This release broadly is composed of five significant changes to the `web-api` codebase: + +1. ⬆️ The minimum supported (and thus tested) version of node.js is now v18, +1. 🚨 Breaking changes to API method arguments for TypeScript users (_not_ for JavaScript users), +2. 🧹 We deprecated a few sets of methods that are on their way out, +3. 📝 Added a _ton_ of new hand-written JSDocs to provide useful method-specific context and descriptions directly in your IDE, and +4. 🧑‍🔬 Type tests for method arguments, formalizing some of the co-dependencies and constraints unique to specific API methods + +Let's dive into these three sets of changes and begin with the 🚨 Breaking Changes 🚨 to make sure we set you all up for success and an easy migration to v7. + +## Breaking Changes (TypeScript users only) + +### All Web API methods no longer allow arbitrary arguments + +Previously, the arguments provided to specific methods extended from a [`WebAPICallOptions` TypeScript interface](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/WebClient.ts#L68-L70). +This interface made all API arguments effectively type un-safe: you could place whatever properties you wanted on arguments, and +the TypeScript compiler would be fine with it. + +In v7, in an attempt to improve type safety, we have removed this argument. As a result, if you were using unknown or publicly undocumented API arguments, you will now see a TypeScript compiler error. If you _really_ want to send unsupported arguments to our APIs, you will have to tell TypeScript "no, trust me, I really want to do this" using [the `// @ts-expect-error` directive](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-9.html#-ts-expect-error-comments). + +If you find an issue with any of our method arguments, please let us know by [filing an issue in this project](https://github.com/slackapi/node-slack-sdk/issues/new/choose)! + +### Many Web API methods have new, sometimes quite-specific, type constraints + +Another change that only affects TypeScript projects. A full and detailed list of changes is at the end of this document, with migration steps where applicable. + +## Deprecating some methods + +The following sets of methods have been deprecated and will be removed in a future major version of `@slack/web-api`: + +- `channels.*` +- `groups.*` +- `im.*` +- `mpim.*` + +Generally, all of the above methods have equivalents available under the `conversations.*` APIs. + +## Adding JSDoc to methods and method arguments + +This one benefits both TypeScript and JavaScript users! Both API methods and API arguments are exhaustively documented with JSDoc. It includes the API method descriptions, mimicking the hand-written docs we have on https://api.slack.com/methods, as well as documenting each API argument and linking to relevant contextual documentation where applicable. + +## Type tests for method arguments + +All of the above-mentioned new TypeScript API argument constraints are exhaustively tested under `test/types/methods`. When in doubt, read these tests to understand exactly what combination of arguments are expected to raise a TypeScript error, and which ones are not. + +## TypeScript API argument changes + +Many of the API argument changes follow a similar pattern. Previously, API arguments would be modeled as a 'bag of optional arguments.' While this was a decent approach to at least surface what arguments were available, they did not model certain arguments _well_. In particular, API arguments that had either/or-style constraints (e.g. `chat.postMessage` accepts _either_ `channel` and `blocks` _or_ `channel` and `attachments` - but never all three) could not be modeled with this approach. This could lead developers to a situation where, at runtime, they would get error responses from Slack APIs when using a combination of arguments that were unsupported. + +Moving forward, all of our APIs were exhaustively tested and the arguments to them modeled in such a way that would prevent TypeScript developers from using the APIs with an unsupported combination of arguments - ideally preventing ever encountering these avoidable runtime errors. + +Without further ado, let's dive in the changes for each API: + +## [`admin.analytics.getFile`](https://api.slack.com/methods/admin.analytics.getFile) + +Previously, most arguments to this API were optional. Now, the specific combinations of `type`, `date` and `metadata_only` are [more strictly typed to ensure only valid combinations are possible](https://github.com/slackapi/node-slack-sdk/pull/1673/files?diff=unified&w=0#diff-49ab2c95a2115046c53fe532bcd82a4e52434c16fbf1a7fdab08a764321ac0cdR44). + +## `admin.apps.*` + +You can no longer provide _both_ `request_id` and `app_id` - these APIs will only accept one of these arguments. Similarly for `enterprise_id` and `team_id` - only one can be provided, and one of them is required as well. + +### [`admin.apps.activities.list`](https://api.slack.com/methods/admin.apps.activities.list) + +- `component_type` is no longer any `string`, but rather it must be one of: `events_api`, `workflows`, `functions`, `tables` +- `min_log_level` is no longer any `string`, but rather it must be one of: `trace`, `debug`, `info`, `warn`, `error`, `fatal` +- `sort_direction` is no longer any `string`, but rather it must be one of: `asc`, `desc` +- `source` is no longer any `string`, but rather it must be one of: `slack`, `developer` + +## `admin.auth.*` + +- `entity_type` is no longer any `string` and is now an enum that only accepts the only valid value: `USER` +- `policy_name` is no longer any `string` and is now an enum that only accepts the only valid value: `email_password` + +## `admin.barriers.*` + +The `restricted_subjects` array is no longer a `string[]` but enforces an array with the exact values `['im', 'mpim', 'call']` - which these APIs demand (see e.g. [`admin.barriers.create` usage info](https://api.slack.com/methods/admin.barriers.create#markdown)). + +## `admin.conversations.*` + +- The `channel_ids` parameter now must be passed at least one channel ID - no more empty arrays allowed! +- Similarly, `team_ids` must be passed at least one team ID. Empty arrays: no good. +- This might sound familiar, but `user_ids` must be passed at least one user ID. Keeping it consistent around here, folks. +- The `org_wide` and `team_id` parameters influence one another: if `org_wide` is true, `team_id` must not be provided. Conversely, if `team_id` is provided, `org_wide` should be omitted, or, if you really want to include it, it must be `false`. Previously, both properties were simply optional. + +### [`admin.conversations.search`](https://api.slack.com/methods/admin.conversations.search) + +The `search_channel_types` argument is [now an enumeration of specific values](https://github.com/slackapi/node-slack-sdk/pull/1673/files?diff=unified&w=0#diff-16abafd789456431bd84945a174544e42cf9d0ddda6077b4cfcdd85377a1971eR8), rather than just any old `string` you want. + +## `admin.functions.*` + +- `function_ids` now requires at least one array element. +- `visibility` is no longer any `string` and instead an enumeration: `everyone`, `app_collaborators`, `named_entities`, `no_one`. + +## `admin.roles.*` + +- `entity_ids` now requires at least one array element. +- `user_ids` must be passed at least one user ID. +- `sort_dir` will accept either `asc` or `desc`. Previously any `string` was, unfortunately, A-OK. + +## `admin.teams.*` + +- `team_discoverability` and `discoverability` are now enumerations consisting of: `open`, `closed`, `invite_only`, `unlisted`, rather than any `string`. +- `channel_ids` must be passed at least one channel ID. + +## `admin.users.*` + +- `channel_ids` must be passed at least one channel ID. Previously this parameter was a string, so you had to comma-separate your channel IDs manually, as if this was the 1800s. +- `user_ids` must be passed at least one user ID. Otherwise, what, you're going to invite 0 users? Who do you think you're kidding? + +### [`admin.users.list`](https://api.slack.com/methods/admin.users.list) + +The `team_id` and `include_deactivated_user_workspaces` parameters were previously both optional. However, they kind of depend on each other. You can either provide a `team_id` and no `include_deactivated_user_workspaces` (or set it to `false`), or set `include_deactivated_user_workspaces` to `true` and omit `team_id`. Otherwise providing both doesn't make any sense at all? We need to be logically consistent, people! + +### [`admin.users.session.list`](https://api.slack.com/methods/admin.users.session.list) + +This API will now accept either _both_ `team_id` and `user_id`, or _neither_. Previously both properties were optional, which was not ideal. + +## `admin.workflows.*` + +- `collaborator_ids` must be passed at least one collaborator ID. Collaborating with 0 other humans is not really collaborating, now is it? +- Similarly, `workflow_ids` must be passed at least one workflow ID. + +### [`admin.workflows.search`](https://api.slack.com/methods/admin.workflows.search) + +- `sort_dir` will accept either `asc` or `desc`. Previously any `string` was, unfortunately, A-OK. +- `sort` now only accepts `premium_runs`, whereas previously you could pass it any `string`. +- `source` now only accepts either `code` or `workflow_builder`, whereas before you could feed it any `string`. + +## `apps.connections.open` + +Previously this method could be called without any arguments. Now, arguments are required. The migration path is to pass an empty object (`{}`) to `apps.connections.open`. + +## `apps.manifest.*` + +Previously the `manifest` parameter was a `string`. In reality this is a very complex object, which we've done our best to model in excruciating detail. + +## `auth.test` + +Previously this method could be called without any arguments. Now, arguments are required. The migration path is to pass an empty object (`{}`) to `auth.test`. + +## `bookmarks.*` + +- `type` now accepts only one value: `link`. +- The `link` parameter (not to be confused with the `type: 'link'` value in the previous point!) was previously optional for the `bookmarks.add` API. That's just silly as a bookmark necessarily requires a link, so it is now a required property. It is, however, optional for the `bookmarks.edit` API. + +## `chat.*` + +- Previously, we didn't model message contents very well. All of the various message-posting APIs (`postEphemeral`, `postMessage`, `scheduleMessage`) would accept `text`, `attachments`, and `blocks`, but all were optional arguments. That's not exactly correct, however. Now, you _must_ provide one of these three. Previously, you could avoid all three if you wished! Additionally, if you use `attachments` or `blocks`, `text` becomes an optional addition for you to specify and will be used as fallback text for notifications. +- The properties `as_user`, `username`, `icon_emoji` and `icon_url` interact with one another: + - If you set `as_user` to `true`, you cannot set `icon_emoji`, `icon_url` or `username`. + - You can provide either `icon_emoji` or `icon_url`, but never both. +- If you set `reply_broadcast` to `true`, then you must also provide a `thread_ts`. Previously, both were optional. + +## `conversations.*` + +- For APIs that accept either `channel_id` or `invite_id` (`conversations.acceptSharedInvite`), we now enforce specifying one or the other (but not both). +- For APIs that accept either `emails` or `user_ids` (`conversations.inviteShared`), we now enforce specifying one or the other (but not both). +- For APIs that accept either `channel` or `users` (`conversations.open`), we now enforce specifying one or the other (but not both). + +## `files.*` + +- You must provide either `content` or `file`. Previously these were both optional. +- If you provide the `thread_ts` argument, you now must also provide the `channels`, or `channel_id` argument (depending on the method). +- The `files` array parameter must now be provided at least one element. +- The `files.remote.*` APIs require one of `file` or `external_id`, but not both. Previously both were optional. + +## `reactions.*` + +- `channel` and `timestamp` are now required properties for `reactions.add`. +- `reactions.add` no longer supports the `file` and `file_comment` parameters, as per our [API docs for this method](https://api.slack.com/methods/reactions.add). +- `reactions.get` and `reactions.remove` now require to supply one and only one of: + - both `channel` and `timestamp`, or + - a `file` encoded file ID, or + - a `file_comment` ID + +## `stars.*` + +The `add` and `remove` APIs require one of: + +- both `channel` and `timestamp`, or +- a `file` encoded file ID, or +- a `file_comment` ID + +## `team.*` + +- `change_type` is no longer any `string` but an enumeration of: `added`, `removed`, `enabled`, `disabled`, `updated` + +## `users.*` + +- The deprecated `presence` parameter for [`users.list`](https://api.slack.com/methods/users.list) has been removed. +- The `profile` parameter for [`users.profile.set`](https://api.slack.com/methods/users.profile.set) has been changed from a string to, basically, any object you wish. + +## `views.*` + +All `views.*` APIs now accept either a `trigger_id` or an `interactivity_pointer`, as they both effectively serve the same purpose. + +In addition, `views.update` now accepts either a `external_id` or a `view_id` parameter - but not both. \ No newline at end of file diff --git a/docs/content/packages/web-api.md b/docs/content/packages/web-api.md index cd5b4446f..6e619d346 100644 --- a/docs/content/packages/web-api.md +++ b/docs/content/packages/web-api.md @@ -1,8 +1,8 @@ --- -title: Web API slug: /web-api --- +# Web API The `@slack/web-api` package contains a simple, convenient, and configurable HTTP client for making requests to Slack's [Web API](https://api.slack.com/web). Use it in your app to call any of the over 130 diff --git a/docs/content/support-schedule.md b/docs/content/support-schedule.md new file mode 100644 index 000000000..b610b4328 --- /dev/null +++ b/docs/content/support-schedule.md @@ -0,0 +1,27 @@ +# Support schedule + +## How long will my version be supported? + +You have at least until the next Node.js LTS version maintenance ends. According to [current schedule](https://github.com/nodejs/Release), this happens once every 12 months. + +If there is a newer major version of the Node SDK available today than the one you are using, plan your migration now. Some updates will only make it to the newest major version, and your feedback on the transition will help the community. Don't panic though, as long as you aren't a year behind on updates you still have until the next LTS version maintenance ends. + +## How our schedule works + +In order to guarantee you at least 90 days to migrate from one major version to the next, the maintainers make the following three commitments: + +1. If we've decided to end support for a major version, we will announce this at least 90 days before the next Node.js LTS version maintenance ends. +2. Within 30 days of that announcement, a new major version release will be available to start developing against. +3. After a major version's maintenance ends, there will be a 30 day period of soft-maintenance for critical fixes and merging low impact contributions. It then is considered end-of-life. + +![Node v4.x LTS maintenance end in April creates the opportunity to sunset @slack/client v3.x](/img/support-schedule.png) + +_Node v4.x LTS maintenance end in April creates the opportunity to sunset `@slack/client` v3.x_ + +These commitments are important because it enables both users and maintainers of the Node SDK to establish expectations and plan ahead. + +For users, it means you'll have at least 120 days from when you can first find out your major version will be unsupported, to when its end-of-life. It also means you have at least 90 of those days to migrate your application to use the next major version because a release will be available. Lastly, it means you have up to 30 days where you can speak up for the major version changes that are most important to you. + +For maintainers, it gives us the freedom of always developing against supported versions of Node and most dependencies. It also keeps us honest by giving us a finite amount of time to make decisions about large changes and to communicate those decisions. Maintainers can decide to create a new major version at any time in the year, but we cannot move a major version out of maintenance without meeting the transition expectations of users. + +Lastly, the 30 day soft maintenance period is not meant for new feature development. Maintainers will gladly review contributions, issues, and PRs, but we may close them without a release if they are seen as risky or out of scope. diff --git a/docs/content/typescript.md b/docs/content/typescript.md index f3e801cba..0f1b60f7b 100644 --- a/docs/content/typescript.md +++ b/docs/content/typescript.md @@ -16,7 +16,7 @@ The v6 versions of `@slack/web-api`, `@slack/rtm-api`, and `@slack/webhook` pack The v5 versions of `@slack/web-api`, `@slack/rtm-api`, and `@slack/webhook` packages are supported to build against TypeScript v3.3.0 or higher. The v4 versions of the `@slack/web-api`, `@slack/rtm-api`, and `@slack/webhook` packages are supported to build against TypeScript v2.7.0 or higher. -This project adheres to a [support schedule](https://github.com/slackapi/node-slack-sdk/wiki/Support-Schedule) so that you can predictably plan your time and effort for migration. That plan covers versions of Node.js and how they correlate to major versions of these packages. However, for TypeScript, we're using a slightly different convention. Each time a major version is released, we take the most recent version of TypeScript available, and make it the minimum. That doesn't mean that the project won't work against earlier versions of TypeScript, but it does give this project a chance to adopt new features from up to and including that version of TypeScript throughout the time that the major version of the package is supported. +This project adheres to a [support schedule](/support-schedule) so that you can predictably plan your time and effort for migration. That plan covers versions of Node.js and how they correlate to major versions of these packages. However, for TypeScript, we're using a slightly different convention. Each time a major version is released, we take the most recent version of TypeScript available, and make it the minimum. That doesn't mean that the project won't work against earlier versions of TypeScript, but it does give this project a chance to adopt new features from up to and including that version of TypeScript throughout the time that the major version of the package is supported. --- diff --git a/docs/package-lock.json b/docs/package-lock.json index c0c5d20af..4c1b7c35c 100644 --- a/docs/package-lock.json +++ b/docs/package-lock.json @@ -15,15 +15,15 @@ "clsx": "^2.0.0", "docusaurus-theme-github-codeblock": "^2.0.2", "prism-react-renderer": "^2.4.1", - "react": "^19.0.0", - "react-dom": "^19.0.0" + "react": "^19.1.0", + "react-dom": "^19.1.0" }, "devDependencies": { "@docusaurus/module-type-aliases": "3.7.0", "@docusaurus/types": "3.7.0", "@tsconfig/recommended": "^1.0.8", - "docusaurus-plugin-typedoc": "^1.2.3", - "typedoc": ">=0.27.9", + "docusaurus-plugin-typedoc": "^1.4.0", + "typedoc": ">=0.28.3", "typedoc-plugin-markdown": "^4.4.2" }, "engines": { @@ -3746,15 +3746,17 @@ } }, "node_modules/@gerrit0/mini-shiki": { - "version": "1.27.2", - "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-1.27.2.tgz", - "integrity": "sha512-GeWyHz8ao2gBiUW4OJnQDxXQnFgZQwwQk05t/CVVgNBN7/rK8XZ7xY6YhLVv9tH3VppWWmr9DCl3MwemB/i+Og==", + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.2.2.tgz", + "integrity": "sha512-vaZNGhGLKMY14HbF53xxHNgFO9Wz+t5lTlGNpl2N9xFiKQ0I5oIe0vKjU9dh7Nb3Dw6lZ7wqUE0ri+zcdpnK+Q==", "dev": true, "license": "MIT", "dependencies": { - "@shikijs/engine-oniguruma": "^1.27.2", - "@shikijs/types": "^1.27.2", - "@shikijs/vscode-textmate": "^10.0.1" + "@shikijs/engine-oniguruma": "^3.2.1", + "@shikijs/langs": "^3.2.1", + "@shikijs/themes": "^3.2.1", + "@shikijs/types": "^3.2.1", + "@shikijs/vscode-textmate": "^10.0.2" } }, "node_modules/@hapi/hoek": { @@ -3987,31 +3989,51 @@ "license": "MIT" }, "node_modules/@shikijs/engine-oniguruma": { - "version": "1.29.2", - "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-1.29.2.tgz", - "integrity": "sha512-7iiOx3SG8+g1MnlzZVDYiaeHe7Ez2Kf2HrJzdmGwkRisT7r4rak0e655AcM/tF9JG/kg5fMNYlLLKglbN7gBqA==", + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.2.1.tgz", + "integrity": "sha512-wZZAkayEn6qu2+YjenEoFqj0OyQI64EWsNR6/71d1EkG4sxEOFooowKivsWPpaWNBu3sxAG+zPz5kzBL/SsreQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.2.1", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/langs": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.2.1.tgz", + "integrity": "sha512-If0iDHYRSGbihiA8+7uRsgb1er1Yj11pwpX1c6HLYnizDsKAw5iaT3JXj5ZpaimXSWky/IhxTm7C6nkiYVym+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.2.1" + } + }, + "node_modules/@shikijs/themes": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.2.1.tgz", + "integrity": "sha512-k5DKJUT8IldBvAm8WcrDT5+7GA7se6lLksR+2E3SvyqGTyFMzU2F9Gb7rmD+t+Pga1MKrYFxDIeyWjMZWM6uBQ==", "dev": true, "license": "MIT", "dependencies": { - "@shikijs/types": "1.29.2", - "@shikijs/vscode-textmate": "^10.0.1" + "@shikijs/types": "3.2.1" } }, "node_modules/@shikijs/types": { - "version": "1.29.2", - "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-1.29.2.tgz", - "integrity": "sha512-VJjK0eIijTZf0QSTODEXCqinjBn0joAHQ+aPSBzrv4O2d/QSbsMw+ZeSRx03kV34Hy7NzUvV/7NqfYGRLrASmw==", + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.2.1.tgz", + "integrity": "sha512-/NTWAk4KE2M8uac0RhOsIhYQf4pdU0OywQuYDGIGAJ6Mjunxl2cGiuLkvu4HLCMn+OTTLRWkjZITp+aYJv60yA==", "dev": true, "license": "MIT", "dependencies": { - "@shikijs/vscode-textmate": "^10.0.1", + "@shikijs/vscode-textmate": "^10.0.2", "@types/hast": "^3.0.4" } }, "node_modules/@shikijs/vscode-textmate": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.1.tgz", - "integrity": "sha512-fTIQwLF+Qhuws31iw7Ncl1R3HUDtGwIipiJ9iU+UsDUwMhegFcQKQHd51nZjb7CArq0MvON8rbgCGQYWHUKAdg==", + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", + "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", "dev": true, "license": "MIT" }, @@ -6986,13 +7008,16 @@ } }, "node_modules/docusaurus-plugin-typedoc": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/docusaurus-plugin-typedoc/-/docusaurus-plugin-typedoc-1.2.3.tgz", - "integrity": "sha512-u1l2VlNRDK49A8G3iZW8iRt3LCmE6aeYnkG+nNqQBMVMqiv8Ifwe7gjsoQXTJXDxbMqUiTWWhqOLElP8B9s3fg==", + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/docusaurus-plugin-typedoc/-/docusaurus-plugin-typedoc-1.4.0.tgz", + "integrity": "sha512-lRehUMevMHc40gy/bVuTzu/XwB46Tk342AG0UbpjIKkj3lvsG9rQZK5nnpWffvNalk8QHs3BlAb+xmG4FAUGcg==", "dev": true, "license": "MIT", + "dependencies": { + "typedoc-docusaurus-theme": "^1.4.0" + }, "peerDependencies": { - "typedoc-plugin-markdown": ">=4.4.0" + "typedoc-plugin-markdown": ">=4.6.0" } }, "node_modules/docusaurus-theme-github-codeblock": { @@ -14525,9 +14550,9 @@ } }, "node_modules/react": { - "version": "19.0.0", - "resolved": "https://registry.npmjs.org/react/-/react-19.0.0.tgz", - "integrity": "sha512-V8AVnmPIICiWpGfm6GLzCR/W5FXLchHop40W4nXBmdlEceh16rCN8O8LNWm5bh5XUX91fh7KpA+W0TgMKmgTpQ==", + "version": "19.1.0", + "resolved": "https://registry.npmjs.org/react/-/react-19.1.0.tgz", + "integrity": "sha512-FS+XFBNvn3GTAWq26joslQgWNoFu08F4kl0J4CgdNKADkdSGXQyTCnKteIAJy96Br6YbpEU1LSzV5dYtjMkMDg==", "license": "MIT", "engines": { "node": ">=0.10.0" @@ -14660,15 +14685,15 @@ } }, "node_modules/react-dom": { - "version": "19.0.0", - "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.0.0.tgz", - "integrity": "sha512-4GV5sHFG0e/0AD4X+ySy6UJd3jVl1iNsNHdpad0qhABJ11twS3TTBnseqsKurKcsNqCEFeGL3uLpVChpIO3QfQ==", + "version": "19.1.0", + "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.1.0.tgz", + "integrity": "sha512-Xs1hdnE+DyKgeHJeJznQmYMIBG3TKIHJJT95Q58nHLSrElKlGQqDTR2HQ9fx5CN/Gk6Vh/kupBTDLU11/nDk/g==", "license": "MIT", "dependencies": { - "scheduler": "^0.25.0" + "scheduler": "^0.26.0" }, "peerDependencies": { - "react": "^19.0.0" + "react": "^19.1.0" } }, "node_modules/react-error-overlay": { @@ -15363,9 +15388,9 @@ "license": "ISC" }, "node_modules/scheduler": { - "version": "0.25.0", - "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.25.0.tgz", - "integrity": "sha512-xFVuu11jh+xcO7JOAGJNOXld8/TcEHK/4CituBUeUb5hqxJLj9YuemAEuvm9gQ/+pgXYfbQuqAkiYu+u7YEsNA==", + "version": "0.26.0", + "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.26.0.tgz", + "integrity": "sha512-NlHwttCI/l5gCPR3D1nNXtWABUmBwvZpEQiD4IXSbIDq8BzLIK/7Ir5gTFSGZDUu37K5cMNp0hFtzO38sC7gWA==", "license": "MIT" }, "node_modules/schema-utils": { @@ -16472,39 +16497,50 @@ } }, "node_modules/typedoc": { - "version": "0.27.9", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.27.9.tgz", - "integrity": "sha512-/z585740YHURLl9DN2jCWe6OW7zKYm6VoQ93H0sxZ1cwHQEQrUn5BJrEnkWhfzUdyO+BLGjnKUZ9iz9hKloFDw==", + "version": "0.28.3", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.3.tgz", + "integrity": "sha512-5svOCTfXvVSh6zbZKSQluZhR8yN2tKpTeHZxlmWpE6N5vc3R8k/jhg9nnD6n5tN9/ObuQTojkONrOxFdUFUG9w==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@gerrit0/mini-shiki": "^1.24.0", + "@gerrit0/mini-shiki": "^3.2.2", "lunr": "^2.3.9", "markdown-it": "^14.1.0", "minimatch": "^9.0.5", - "yaml": "^2.6.1" + "yaml": "^2.7.1" }, "bin": { "typedoc": "bin/typedoc" }, "engines": { - "node": ">= 18" + "node": ">= 18", + "pnpm": ">= 10" }, "peerDependencies": { "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x" } }, + "node_modules/typedoc-docusaurus-theme": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/typedoc-docusaurus-theme/-/typedoc-docusaurus-theme-1.4.0.tgz", + "integrity": "sha512-L8etzGUfGv1nxcdzw/s/0MUgfiIetTMttdqCY2ZpTnK26pDB8GsBi+9hHwl8cgDrMz+FF+mIyPKNDKhqDeGvTA==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "typedoc-plugin-markdown": ">=4.6.3" + } + }, "node_modules/typedoc-plugin-markdown": { - "version": "4.4.2", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.4.2.tgz", - "integrity": "sha512-kJVkU2Wd+AXQpyL6DlYXXRrfNrHrEIUgiABWH8Z+2Lz5Sq6an4dQ/hfvP75bbokjNDUskOdFlEEm/0fSVyC7eg==", + "version": "4.6.3", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.6.3.tgz", + "integrity": "sha512-86oODyM2zajXwLs4Wok2mwVEfCwCnp756QyhLGX2IfsdRYr1DXLCgJgnLndaMUjJD7FBhnLk2okbNE9PdLxYRw==", "dev": true, "license": "MIT", "engines": { "node": ">= 18" }, "peerDependencies": { - "typedoc": "0.27.x" + "typedoc": "0.28.x" } }, "node_modules/typedoc/node_modules/brace-expansion": { @@ -16532,9 +16568,9 @@ } }, "node_modules/typedoc/node_modules/yaml": { - "version": "2.7.0", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.7.0.tgz", - "integrity": "sha512-+hSoy/QHluxmC9kCIJyL/uyFmLmc+e5CFR5Wa+bpIhIj85LVb9ZH2nVnqrHoSvKogwODv0ClqZkmiSSaIH5LTA==", + "version": "2.7.1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.7.1.tgz", + "integrity": "sha512-10ULxpnOCQXxJvBgxsn9ptjq6uviG/htZKk9veJGhlqn3w/DxQ631zFF+nlQXLwmImeS5amR2dl2U8sg6U9jsQ==", "dev": true, "license": "ISC", "bin": { diff --git a/docs/package.json b/docs/package.json index 6fec2f54c..11730e6f6 100644 --- a/docs/package.json +++ b/docs/package.json @@ -21,15 +21,15 @@ "clsx": "^2.0.0", "docusaurus-theme-github-codeblock": "^2.0.2", "prism-react-renderer": "^2.4.1", - "react": "^19.0.0", - "react-dom": "^19.0.0" + "react": "^19.1.0", + "react-dom": "^19.1.0" }, "devDependencies": { "@docusaurus/module-type-aliases": "3.7.0", "@docusaurus/types": "3.7.0", "@tsconfig/recommended": "^1.0.8", - "docusaurus-plugin-typedoc": "^1.2.3", - "typedoc": ">=0.27.9", + "docusaurus-plugin-typedoc": "^1.4.0", + "typedoc": ">=0.28.3", "typedoc-plugin-markdown": "^4.4.2" }, "browserslist": { diff --git a/docs/sidebars.js b/docs/sidebars.js index b30e37290..3be53222b 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -31,6 +31,18 @@ const sidebars = { 'packages/rtm-api', 'packages/webhook', 'packages/socket-mode', + { + type: 'category', + label: 'Migration', + items: [ + 'migration/migrating-to-v4', + 'migration/migrating-to-v5', + 'migration/migrating-to-v6', + 'migration/migrating-socket-mode-package-to-v2', + 'migration/migrating-web-api-package-to-v7', + + ], + }, { type: 'category', label: 'Deprecated packages', @@ -44,9 +56,7 @@ const sidebars = { type: 'category', label: 'Tutorials', items: [ - 'tutorials/local-development', - 'tutorials/migrating-to-v5', - 'tutorials/migrating-to-v6', + 'tutorials/local-development' ], }, {type: 'html', value: '
'}, @@ -147,6 +157,7 @@ const sidebars = { ], }, {type: 'html', value: '
'}, + 'support-schedule', { type: 'link', label: 'Release notes', diff --git a/docs/static/img/support-schedule.png b/docs/static/img/support-schedule.png new file mode 100644 index 000000000..9b64ae5a5 Binary files /dev/null and b/docs/static/img/support-schedule.png differ diff --git a/examples/express-all-interactions/package.json b/examples/express-all-interactions/package.json index cf1cf2f27..da18c1f4c 100644 --- a/examples/express-all-interactions/package.json +++ b/examples/express-all-interactions/package.json @@ -13,8 +13,8 @@ "@slack/interactive-messages": "^2.0.2", "@slack/web-api": "^7.3.4", "axios": "^1.6.0", - "body-parser": "^1.18.2", + "body-parser": "^2.2.0", "dotenv": "^16.4.5", - "express": "^4.16.3" + "express": "^5.1.0" } } diff --git a/examples/greet-and-react/package.json b/examples/greet-and-react/package.json index 4667835e8..1e618c56d 100644 --- a/examples/greet-and-react/package.json +++ b/examples/greet-and-react/package.json @@ -13,7 +13,7 @@ "@slack/events-api": "^3.0.1", "@slack/web-api": "^7.3.4", "dotenv": "^16.4.5", - "express": "^4.16.3", + "express": "^5.1.0", "node-localstorage": "^3.0.5", "passport": "^0.7.0" } diff --git a/examples/oauth-v1/package.json b/examples/oauth-v1/package.json index 65a0b0a56..05d5b7828 100644 --- a/examples/oauth-v1/package.json +++ b/examples/oauth-v1/package.json @@ -17,6 +17,6 @@ "@slack/events-api": "^3.0.1", "@slack/oauth": "^3.0.1", "@slack/web-api": "^7.3.4", - "express": "^4.17.1" + "express": "^5.1.0" } } diff --git a/examples/oauth-v2/package.json b/examples/oauth-v2/package.json index a010ffcd7..f5b67dfbe 100644 --- a/examples/oauth-v2/package.json +++ b/examples/oauth-v2/package.json @@ -13,7 +13,7 @@ "@slack/events-api": "^3.0.1", "@slack/oauth": "^3.0.1", "@slack/web-api": "^7.3.4", - "express": "^4.17.1", + "express": "^5.1.0", "keyv": "^5.0.1" } } diff --git a/examples/openid-connect/package.json b/examples/openid-connect/package.json index c523bb12b..aed99d696 100644 --- a/examples/openid-connect/package.json +++ b/examples/openid-connect/package.json @@ -13,7 +13,7 @@ "@koa/router": "^13.0.0", "@slack/web-api": "^7.3.4", "jsonwebtoken": "^9.0.2", - "koa": "^2.13.1", + "koa": "^3.0.0", "uuid": "^11.0.2" } } diff --git a/packages/cli-hooks/package.json b/packages/cli-hooks/package.json index 65c06590a..fe9d3eab6 100644 --- a/packages/cli-hooks/package.json +++ b/packages/cli-hooks/package.json @@ -63,6 +63,6 @@ "mocha-multi-reporters": "^1.5.1", "shx": "^0.4.0", "sinon": "^20.0.0", - "typescript": "5.8.2" + "typescript": "5.8.3" } } diff --git a/packages/cli-test/package.json b/packages/cli-test/package.json index eb49740c9..192746d34 100644 --- a/packages/cli-test/package.json +++ b/packages/cli-test/package.json @@ -47,6 +47,6 @@ "shx": "^0.4.0", "sinon": "^20.0.0", "ts-node": "^10.9.2", - "typescript": "5.8.2" + "typescript": "5.8.3" } } diff --git a/packages/oauth/package.json b/packages/oauth/package.json index f3cac68ed..a05e27de0 100644 --- a/packages/oauth/package.json +++ b/packages/oauth/package.json @@ -53,6 +53,6 @@ "sinon": "^20", "source-map-support": "^0.5.21", "ts-node": "^10", - "typescript": "5.8.2" + "typescript": "5.8.3" } } diff --git a/packages/socket-mode/package.json b/packages/socket-mode/package.json index 6cb04adc3..1b765f036 100644 --- a/packages/socket-mode/package.json +++ b/packages/socket-mode/package.json @@ -71,6 +71,6 @@ "sinon": "^20", "source-map-support": "^0.5.21", "ts-node": "^10", - "typescript": "5.7.3" + "typescript": "5.8.3" } } diff --git a/packages/types/package.json b/packages/types/package.json index bb6078067..6002ebdac 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -32,7 +32,7 @@ "devDependencies": { "@biomejs/biome": "^1.8.3", "shx": "^0.4.0", - "tsd": "^0.31.0", + "tsd": "^0.32.0", "typescript": "^5.5.4" }, "tsd": { diff --git a/packages/web-api/package.json b/packages/web-api/package.json index 8b4620228..07967af89 100644 --- a/packages/web-api/package.json +++ b/packages/web-api/package.json @@ -1,6 +1,6 @@ { "name": "@slack/web-api", - "version": "7.9.1", + "version": "7.9.2", "description": "Official library for using the Slack Platform's Web API", "author": "Slack Technologies, LLC", "license": "MIT", @@ -61,13 +61,13 @@ "mocha": "^11", "mocha-junit-reporter": "^2.2.1", "mocha-multi-reporters": "^1.5.1", - "nock": "^13", + "nock": "^14", "shx": "^0.4.0", "sinon": "^20", "source-map-support": "^0.5.21", "ts-node": "^10", - "tsd": "^0.31.1", - "typescript": "5.3.3" + "tsd": "^0.32.0", + "typescript": "5.8.3" }, "tsd": { "directory": "test/types" diff --git a/packages/web-api/src/WebClient.spec.ts b/packages/web-api/src/WebClient.spec.ts index bbade1d90..a51cb2091 100644 --- a/packages/web-api/src/WebClient.spec.ts +++ b/packages/web-api/src/WebClient.spec.ts @@ -1,7 +1,7 @@ import fs from 'node:fs'; import axios, { type InternalAxiosRequestConfig } from 'axios'; import { assert, expect } from 'chai'; -import nock from 'nock'; +import nock, { type ReplyHeaders } from 'nock'; import sinon from 'sinon'; import { type RequestConfig, @@ -58,6 +58,21 @@ describe('WebClient', () => { const client = new WebClient(); assert.instanceOf(client, WebClient); }); + + it('should add a trailing slash to slackApiUrl if missing', () => { + const client = new WebClient(token, { slackApiUrl: 'https://slack.com/api' }); + assert.equal(client.slackApiUrl, 'https://slack.com/api/'); + }); + + it('should preserve trailing slash in slackApiUrl if provided', () => { + const client = new WebClient(token, { slackApiUrl: 'https://slack.com/api/' }); + assert.equal(client.slackApiUrl, 'https://slack.com/api/'); + }); + + it('should handle custom domains and add trailing slash', () => { + const client = new WebClient(token, { slackApiUrl: 'https://example.com/slack/api' }); + assert.equal(client.slackApiUrl, 'https://example.com/slack/api/'); + }); }); describe('Methods superclass', () => { @@ -797,11 +812,20 @@ describe('WebClient', () => { const client = new WebClient(token, { allowAbsoluteUrls: false }); await client.apiCall('https://example.com/api/method'); }); + + it('should add a trailing slash to slackApiUrl if missing', async () => { + const alternativeUrl = 'http://12.34.56.78/api'; // No trailing slash here + nock(alternativeUrl) + .post(/api\/method/) + .reply(200, { ok: true }); + const client = new WebClient(token, { slackApiUrl: alternativeUrl }); + await client.apiCall('method'); + }); }); describe('has an option to set request concurrency', () => { // TODO: factor out common logic into test helpers - const responseDelay = 100; // ms + const responseDelay = 500; // ms let testStart: number; let scope: nock.Scope; @@ -1102,14 +1126,15 @@ describe('WebClient', () => { }); it('should throw an error if the response has no retry info', async () => { - // @ts-expect-error header values cannot be undefined - const scope = nock('https://slack.com').post(/api/).reply(429, {}, { 'retry-after': undefined }); + const emptyHeaders: ReplyHeaders & { 'retry-after'?: never } = {}; // Ensure that 'retry-after' is not in the headers + const scope = nock('https://slack.com').post(/api/).reply(429, {}, emptyHeaders); const client = new WebClient(token); try { await client.apiCall('method'); assert.fail('expected error to be thrown'); } catch (err) { assert.instanceOf(err, Error); + } finally { scope.done(); } }); diff --git a/packages/web-api/src/WebClient.ts b/packages/web-api/src/WebClient.ts index e0418d53d..beecdf726 100644 --- a/packages/web-api/src/WebClient.ts +++ b/packages/web-api/src/WebClient.ts @@ -286,6 +286,9 @@ export class WebClient extends Methods { this.token = token; this.slackApiUrl = slackApiUrl; + if (!this.slackApiUrl.endsWith('/')) { + this.slackApiUrl += '/'; + } this.retryConfig = retryConfig; this.requestQueue = new pQueue({ concurrency: maxRequestConcurrency }); @@ -311,7 +314,7 @@ export class WebClient extends Methods { this.axios = axios.create({ adapter: adapter ? (config: InternalAxiosRequestConfig) => adapter({ ...config, adapter: undefined }) : undefined, timeout, - baseURL: slackApiUrl, + baseURL: this.slackApiUrl, headers: isElectron() ? headers : { 'User-Agent': getUserAgent(), ...headers }, httpAgent: agent, httpsAgent: agent, diff --git a/packages/web-api/src/file-upload.ts b/packages/web-api/src/file-upload.ts index 09ff422ee..e0955af20 100644 --- a/packages/web-api/src/file-upload.ts +++ b/packages/web-api/src/file-upload.ts @@ -5,6 +5,7 @@ import type { Logger } from '@slack/logger'; import { ErrorCode, errorWithCode } from './errors'; import type { + FileThreadDestinationArgument, FileUploadV2, FileUploadV2Job, FilesCompleteUploadExternalArguments, @@ -200,10 +201,10 @@ export async function getFileDataAsStream(readable: Readable): Promise { return new Promise((resolve, reject) => { readable.on('readable', () => { - let chunk: Buffer; - // biome-ignore lint/suspicious/noAssignInExpressions: being terse, this is OK - while ((chunk = readable.read()) !== null) { + let chunk = readable.read(); + while (chunk !== null) { chunks.push(chunk); + chunk = readable.read(); } }); readable.on('end', () => { @@ -240,8 +241,15 @@ export function getAllFileUploadsToComplete( channel_id, initial_comment, }; - if (thread_ts) { - toComplete[compareString].thread_ts = upload.thread_ts; + if (thread_ts && channel_id) { + const fileThreadDestinationArgument: FileThreadDestinationArgument = { + channel_id, + thread_ts, + }; + toComplete[compareString] = { + ...toComplete[compareString], + ...fileThreadDestinationArgument, + }; } if ('token' in upload) { toComplete[compareString].token = upload.token; diff --git a/packages/web-api/src/types/response/AdminConversationsSearchResponse.ts b/packages/web-api/src/types/response/AdminConversationsSearchResponse.ts index 6afd97347..e4f290a55 100644 --- a/packages/web-api/src/types/response/AdminConversationsSearchResponse.ts +++ b/packages/web-api/src/types/response/AdminConversationsSearchResponse.ts @@ -87,6 +87,7 @@ export interface Properties { huddles_restricted?: boolean; posting_restricted_to?: PostingRestrictedTo; tabs?: Tab[]; + tabz?: Tab[]; threads_restricted_to?: ThreadsRestrictedTo; } diff --git a/packages/web-api/src/types/response/AdminFunctionsPermissionsLookupResponse.ts b/packages/web-api/src/types/response/AdminFunctionsPermissionsLookupResponse.ts index e61e1d2fb..cf4d39391 100644 --- a/packages/web-api/src/types/response/AdminFunctionsPermissionsLookupResponse.ts +++ b/packages/web-api/src/types/response/AdminFunctionsPermissionsLookupResponse.ts @@ -11,6 +11,7 @@ import type { WebAPICallResult } from '../../WebClient'; export type AdminFunctionsPermissionsLookupResponse = WebAPICallResult & { error?: string; errors?: Errors; + metadata?: { [key: string]: Errors }; needed?: string; ok?: boolean; permissions?: { [key: string]: Permission }; diff --git a/packages/web-api/src/types/response/AppsManifestCreateResponse.ts b/packages/web-api/src/types/response/AppsManifestCreateResponse.ts index 37e8a31cf..cf8eba58f 100644 --- a/packages/web-api/src/types/response/AppsManifestCreateResponse.ts +++ b/packages/web-api/src/types/response/AppsManifestCreateResponse.ts @@ -18,6 +18,8 @@ export type AppsManifestCreateResponse = WebAPICallResult & { ok?: boolean; provided?: string; response_metadata?: ResponseMetadata; + team_domain?: string; + team_id?: string; }; export interface Credentials { diff --git a/packages/web-api/src/types/response/ChatPostMessageResponse.ts b/packages/web-api/src/types/response/ChatPostMessageResponse.ts index d0d4642d5..ec38406b8 100644 --- a/packages/web-api/src/types/response/ChatPostMessageResponse.ts +++ b/packages/web-api/src/types/response/ChatPostMessageResponse.ts @@ -66,6 +66,7 @@ export interface AssistantAppThreadBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; @@ -109,7 +110,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -138,7 +139,7 @@ export interface Accessory { style?: string; text?: DescriptionElement; timezone?: string; - type?: string; + type?: AccessoryType; url?: string; value?: string; workflow?: Workflow; @@ -170,7 +171,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: FluffyType; + type?: AccessoryType; } export interface PurpleElement { @@ -216,14 +217,33 @@ export enum PurpleType { Usergroup = 'usergroup', } -export enum FluffyType { +export enum AccessoryType { + Button = 'button', + ChannelsSelect = 'channels_select', + Checkboxes = 'checkboxes', + ConversationsSelect = 'conversations_select', + Datepicker = 'datepicker', + Datetimepicker = 'datetimepicker', + ExternalSelect = 'external_select', + Image = 'image', + MultiChannelsSelect = 'multi_channels_select', + MultiConversationsSelect = 'multi_conversations_select', + MultiExternalSelect = 'multi_external_select', + MultiStaticSelect = 'multi_static_select', + MultiUsersSelect = 'multi_users_select', + Overflow = 'overflow', + RadioButtons = 'radio_buttons', RichTextList = 'rich_text_list', RichTextPreformatted = 'rich_text_preformatted', RichTextQuote = 'rich_text_quote', RichTextSection = 'rich_text_section', + StaticSelect = 'static_select', + Timepicker = 'timepicker', + UsersSelect = 'users_select', + WorkflowButton = 'workflow_button', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -313,9 +333,10 @@ export interface FileElement { app_id?: string; app_name?: string; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -362,6 +383,7 @@ export interface FileElement { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -454,7 +476,7 @@ export interface FileElement { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: FileBlock[]; + title_blocks?: DescriptionBlockElement[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -468,7 +490,7 @@ export interface FileElement { vtt?: string; } -export interface FileBlock { +export interface DescriptionBlockElement { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -480,6 +502,7 @@ export interface FileBlock { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -555,6 +578,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -567,6 +591,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: DescriptionBlockElement[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -633,11 +658,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -650,6 +679,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; @@ -711,8 +753,9 @@ export interface Attachment { author_link?: string; author_name?: string; author_subname?: string; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; + bot_team_id?: string; callback_id?: string; channel_id?: string; channel_name?: string; @@ -783,7 +826,7 @@ export interface Action { selected_options?: SelectedOptionElement[]; style?: string; text?: string; - type?: string; + type?: AccessoryType; url?: string; value?: string; } @@ -888,7 +931,7 @@ export interface FieldMessage { app_id?: string; assistant_app_thread?: AssistantAppThread; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; bot_link?: string; bot_profile?: BotProfile; @@ -1005,6 +1048,7 @@ export interface MessageFile { blocks?: any[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: any[]; channel_actions_count?: number; @@ -1051,6 +1095,7 @@ export interface MessageFile { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -1183,6 +1228,7 @@ export interface Room { display_id?: string; external_unique_id?: string; has_ended?: boolean; + huddle_link?: string; id?: string; is_dm_call?: boolean; is_prewarmed?: boolean; @@ -1199,12 +1245,21 @@ export interface Room { participants_screenshare_off?: string[]; participants_screenshare_on?: string[]; pending_invitees?: EventPayload; + recording?: Recording; thread_root_ts?: string; was_accepted?: boolean; was_missed?: boolean; was_rejected?: boolean; } +export interface Recording { + can_record_summary?: string; + notetaking?: boolean; + summary?: boolean; + summary_status?: string; + transcript?: boolean; +} + export interface PurpleRoot { bot_id?: string; bot_profile?: BotProfile; diff --git a/packages/web-api/src/types/response/ChatScheduleMessageResponse.ts b/packages/web-api/src/types/response/ChatScheduleMessageResponse.ts index c3b85b03f..79955764b 100644 --- a/packages/web-api/src/types/response/ChatScheduleMessageResponse.ts +++ b/packages/web-api/src/types/response/ChatScheduleMessageResponse.ts @@ -57,6 +57,7 @@ export interface AssistantAppThreadBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; @@ -100,7 +101,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -214,7 +215,7 @@ export enum FluffyType { RichTextSection = 'rich_text_section', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -304,9 +305,10 @@ export interface File { app_id?: string; app_name?: string; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -353,6 +355,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -445,7 +448,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: FileBlock[]; + title_blocks?: DescriptionBlockElement[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -459,7 +462,7 @@ export interface File { vtt?: string; } -export interface FileBlock { +export interface DescriptionBlockElement { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -471,6 +474,7 @@ export interface FileBlock { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -546,6 +550,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -558,6 +563,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: DescriptionBlockElement[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -624,11 +630,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -641,6 +651,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; @@ -730,6 +753,7 @@ export interface Room { display_id?: string; external_unique_id?: string; has_ended?: boolean; + huddle_link?: string; id?: string; is_dm_call?: boolean; is_prewarmed?: boolean; @@ -746,12 +770,21 @@ export interface Room { participants_screenshare_off?: string[]; participants_screenshare_on?: string[]; pending_invitees?: EventPayload; + recording?: Recording; thread_root_ts?: string; was_accepted?: boolean; was_missed?: boolean; was_rejected?: boolean; } +export interface Recording { + can_record_summary?: string; + notetaking?: boolean; + summary?: boolean; + summary_status?: string; + transcript?: boolean; +} + export interface ResponseMetadata { messages?: string[]; } diff --git a/packages/web-api/src/types/response/ChatUpdateResponse.ts b/packages/web-api/src/types/response/ChatUpdateResponse.ts index 54dc5ddef..05432b328 100644 --- a/packages/web-api/src/types/response/ChatUpdateResponse.ts +++ b/packages/web-api/src/types/response/ChatUpdateResponse.ts @@ -62,6 +62,7 @@ export interface AssistantAppThreadBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; @@ -105,7 +106,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -219,7 +220,7 @@ export enum FluffyType { RichTextSection = 'rich_text_section', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -309,9 +310,10 @@ export interface File { app_id?: string; app_name?: string; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -358,6 +360,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -450,7 +453,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: FileBlock[]; + title_blocks?: DescriptionBlockElement[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -464,7 +467,7 @@ export interface File { vtt?: string; } -export interface FileBlock { +export interface DescriptionBlockElement { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -476,6 +479,7 @@ export interface FileBlock { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -551,6 +555,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -563,6 +568,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: DescriptionBlockElement[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -629,11 +635,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -646,6 +656,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; @@ -740,6 +763,7 @@ export interface Room { display_id?: string; external_unique_id?: string; has_ended?: boolean; + huddle_link?: string; id?: string; is_dm_call?: boolean; is_prewarmed?: boolean; @@ -756,12 +780,21 @@ export interface Room { participants_screenshare_off?: string[]; participants_screenshare_on?: string[]; pending_invitees?: EventPayload; + recording?: Recording; thread_root_ts?: string; was_accepted?: boolean; was_missed?: boolean; was_rejected?: boolean; } +export interface Recording { + can_record_summary?: string; + notetaking?: boolean; + summary?: boolean; + summary_status?: string; + transcript?: boolean; +} + export interface ResponseMetadata { messages?: string[]; } diff --git a/packages/web-api/src/types/response/ConversationsHistoryResponse.ts b/packages/web-api/src/types/response/ConversationsHistoryResponse.ts index 16a2916d4..b4f8a7703 100644 --- a/packages/web-api/src/types/response/ConversationsHistoryResponse.ts +++ b/packages/web-api/src/types/response/ConversationsHistoryResponse.ts @@ -13,6 +13,7 @@ export type ConversationsHistoryResponse = WebAPICallResult & { channel_actions_ts?: number; error?: string; has_more?: boolean; + latest?: string; messages?: MessageElement[]; needed?: string; ok?: boolean; @@ -82,6 +83,7 @@ export interface AssistantAppThreadBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; @@ -125,7 +127,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -154,7 +156,7 @@ export interface Accessory { style?: string; text?: DescriptionElement; timezone?: string; - type?: string; + type?: AccessoryType; url?: string; value?: string; workflow?: Workflow; @@ -186,7 +188,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: FluffyType; + type?: AccessoryType; } export interface PurpleElement { @@ -232,14 +234,33 @@ export enum PurpleType { Usergroup = 'usergroup', } -export enum FluffyType { +export enum AccessoryType { + Button = 'button', + ChannelsSelect = 'channels_select', + Checkboxes = 'checkboxes', + ConversationsSelect = 'conversations_select', + Datepicker = 'datepicker', + Datetimepicker = 'datetimepicker', + ExternalSelect = 'external_select', + Image = 'image', + MultiChannelsSelect = 'multi_channels_select', + MultiConversationsSelect = 'multi_conversations_select', + MultiExternalSelect = 'multi_external_select', + MultiStaticSelect = 'multi_static_select', + MultiUsersSelect = 'multi_users_select', + Overflow = 'overflow', + RadioButtons = 'radio_buttons', RichTextList = 'rich_text_list', RichTextPreformatted = 'rich_text_preformatted', RichTextQuote = 'rich_text_quote', RichTextSection = 'rich_text_section', + StaticSelect = 'static_select', + Timepicker = 'timepicker', + UsersSelect = 'users_select', + WorkflowButton = 'workflow_button', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -329,9 +350,10 @@ export interface FileElement { app_id?: string; app_name?: string; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -378,6 +400,7 @@ export interface FileElement { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -470,7 +493,7 @@ export interface FileElement { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: FileBlock[]; + title_blocks?: DescriptionBlockElement[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -484,7 +507,7 @@ export interface FileElement { vtt?: string; } -export interface FileBlock { +export interface DescriptionBlockElement { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -496,6 +519,7 @@ export interface FileBlock { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -571,6 +595,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -583,6 +608,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: DescriptionBlockElement[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -649,11 +675,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -666,6 +696,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; @@ -727,8 +770,9 @@ export interface Attachment { author_link?: string; author_name?: string; author_subname?: string; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; + bot_team_id?: string; callback_id?: string; channel_id?: string; channel_name?: string; @@ -799,7 +843,7 @@ export interface Action { selected_options?: SelectedOptionElement[]; style?: string; text?: string; - type?: string; + type?: AccessoryType; url?: string; value?: string; } @@ -904,7 +948,7 @@ export interface FieldMessage { app_id?: string; assistant_app_thread?: AssistantAppThread; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; bot_link?: string; bot_profile?: BotProfile; @@ -1021,6 +1065,7 @@ export interface PurpleFile { blocks?: any[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: any[]; channel_actions_count?: number; @@ -1067,6 +1112,7 @@ export interface PurpleFile { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -1199,6 +1245,7 @@ export interface Room { display_id?: string; external_unique_id?: string; has_ended?: boolean; + huddle_link?: string; id?: string; is_dm_call?: boolean; is_prewarmed?: boolean; @@ -1212,12 +1259,21 @@ export interface Room { participants_camera_on?: any[]; participants_screenshare_off?: any[]; participants_screenshare_on?: any[]; + recording?: Recording; thread_root_ts?: string; was_accepted?: boolean; was_missed?: boolean; was_rejected?: boolean; } +export interface Recording { + can_record_summary?: string; + notetaking?: boolean; + summary?: boolean; + summary_status?: string; + transcript?: boolean; +} + export interface PurpleRoot { bot_id?: string; bot_profile?: BotProfile; diff --git a/packages/web-api/src/types/response/ConversationsJoinResponse.ts b/packages/web-api/src/types/response/ConversationsJoinResponse.ts index 4c7822811..8e3c9a900 100644 --- a/packages/web-api/src/types/response/ConversationsJoinResponse.ts +++ b/packages/web-api/src/types/response/ConversationsJoinResponse.ts @@ -56,6 +56,7 @@ export interface Channel { export interface Properties { canvas?: Canvas; tabs?: Tab[]; + tabz?: Tab[]; } export interface Canvas { diff --git a/packages/web-api/src/types/response/ConversationsKickResponse.ts b/packages/web-api/src/types/response/ConversationsKickResponse.ts index d92c65c99..7954a5d82 100644 --- a/packages/web-api/src/types/response/ConversationsKickResponse.ts +++ b/packages/web-api/src/types/response/ConversationsKickResponse.ts @@ -10,7 +10,10 @@ import type { WebAPICallResult } from '../../WebClient'; export type ConversationsKickResponse = WebAPICallResult & { error?: string; + errors?: Errors; needed?: string; ok?: boolean; provided?: string; }; + +export type Errors = {}; diff --git a/packages/web-api/src/types/response/ConversationsListResponse.ts b/packages/web-api/src/types/response/ConversationsListResponse.ts index 68f5e8a9c..1bb8ad7ca 100644 --- a/packages/web-api/src/types/response/ConversationsListResponse.ts +++ b/packages/web-api/src/types/response/ConversationsListResponse.ts @@ -61,6 +61,7 @@ export interface Properties { canvas?: Canvas; posting_restricted_to?: RestrictedTo; tabs?: Tab[]; + tabz?: Tab[]; threads_restricted_to?: RestrictedTo; } diff --git a/packages/web-api/src/types/response/ConversationsOpenResponse.ts b/packages/web-api/src/types/response/ConversationsOpenResponse.ts index 14de7dbb4..1a75a7f03 100644 --- a/packages/web-api/src/types/response/ConversationsOpenResponse.ts +++ b/packages/web-api/src/types/response/ConversationsOpenResponse.ts @@ -73,6 +73,7 @@ export interface AssistantAppThreadBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; @@ -116,7 +117,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -230,7 +231,7 @@ export enum FluffyType { RichTextSection = 'rich_text_section', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -320,9 +321,10 @@ export interface File { app_id?: string; app_name?: string; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -369,6 +371,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -461,7 +464,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: FileBlock[]; + title_blocks?: DescriptionBlockElement[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -475,7 +478,7 @@ export interface File { vtt?: string; } -export interface FileBlock { +export interface DescriptionBlockElement { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -487,6 +490,7 @@ export interface FileBlock { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -562,6 +566,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -574,6 +579,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: DescriptionBlockElement[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -640,11 +646,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -657,6 +667,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; diff --git a/packages/web-api/src/types/response/ConversationsRepliesResponse.ts b/packages/web-api/src/types/response/ConversationsRepliesResponse.ts index 798b0da61..8fce61840 100644 --- a/packages/web-api/src/types/response/ConversationsRepliesResponse.ts +++ b/packages/web-api/src/types/response/ConversationsRepliesResponse.ts @@ -71,6 +71,7 @@ export interface AssistantAppThreadBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; @@ -114,7 +115,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -143,7 +144,7 @@ export interface Accessory { style?: string; text?: DescriptionElement; timezone?: string; - type?: string; + type?: AccessoryType; url?: string; value?: string; workflow?: Workflow; @@ -175,7 +176,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: FluffyType; + type?: AccessoryType; } export interface PurpleElement { @@ -221,14 +222,33 @@ export enum PurpleType { Usergroup = 'usergroup', } -export enum FluffyType { +export enum AccessoryType { + Button = 'button', + ChannelsSelect = 'channels_select', + Checkboxes = 'checkboxes', + ConversationsSelect = 'conversations_select', + Datepicker = 'datepicker', + Datetimepicker = 'datetimepicker', + ExternalSelect = 'external_select', + Image = 'image', + MultiChannelsSelect = 'multi_channels_select', + MultiConversationsSelect = 'multi_conversations_select', + MultiExternalSelect = 'multi_external_select', + MultiStaticSelect = 'multi_static_select', + MultiUsersSelect = 'multi_users_select', + Overflow = 'overflow', + RadioButtons = 'radio_buttons', RichTextList = 'rich_text_list', RichTextPreformatted = 'rich_text_preformatted', RichTextQuote = 'rich_text_quote', RichTextSection = 'rich_text_section', + StaticSelect = 'static_select', + Timepicker = 'timepicker', + UsersSelect = 'users_select', + WorkflowButton = 'workflow_button', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -318,9 +338,10 @@ export interface FileElement { app_id?: string; app_name?: string; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -367,6 +388,7 @@ export interface FileElement { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -459,7 +481,7 @@ export interface FileElement { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: FileBlock[]; + title_blocks?: DescriptionBlockElement[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -473,7 +495,7 @@ export interface FileElement { vtt?: string; } -export interface FileBlock { +export interface DescriptionBlockElement { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -485,6 +507,7 @@ export interface FileBlock { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -560,6 +583,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -572,6 +596,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: DescriptionBlockElement[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -638,11 +663,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -655,6 +684,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; @@ -716,8 +758,9 @@ export interface Attachment { author_link?: string; author_name?: string; author_subname?: string; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; + bot_team_id?: string; callback_id?: string; channel_id?: string; channel_name?: string; @@ -788,7 +831,7 @@ export interface Action { selected_options?: SelectedOptionElement[]; style?: string; text?: string; - type?: string; + type?: AccessoryType; url?: string; value?: string; } @@ -893,7 +936,7 @@ export interface FieldMessage { app_id?: string; assistant_app_thread?: AssistantAppThread; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; bot_link?: string; bot_profile?: BotProfile; @@ -1010,6 +1053,7 @@ export interface PurpleFile { blocks?: any[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: any[]; channel_actions_count?: number; @@ -1056,6 +1100,7 @@ export interface PurpleFile { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -1188,6 +1233,7 @@ export interface Room { display_id?: string; external_unique_id?: string; has_ended?: boolean; + huddle_link?: string; id?: string; is_dm_call?: boolean; is_prewarmed?: boolean; @@ -1201,12 +1247,21 @@ export interface Room { participants_camera_on?: any[]; participants_screenshare_off?: any[]; participants_screenshare_on?: any[]; + recording?: Recording; thread_root_ts?: string; was_accepted?: boolean; was_missed?: boolean; was_rejected?: boolean; } +export interface Recording { + can_record_summary?: string; + notetaking?: boolean; + summary?: boolean; + summary_status?: string; + transcript?: boolean; +} + export interface Root { bot_id?: string; bot_profile?: BotProfile; diff --git a/packages/web-api/src/types/response/FilesCompleteUploadExternalResponse.ts b/packages/web-api/src/types/response/FilesCompleteUploadExternalResponse.ts index d15ab5da1..41bf439e0 100644 --- a/packages/web-api/src/types/response/FilesCompleteUploadExternalResponse.ts +++ b/packages/web-api/src/types/response/FilesCompleteUploadExternalResponse.ts @@ -82,6 +82,7 @@ export interface Shares { export interface Public { channel_name?: string; + is_silent_share?: boolean; latest_reply?: string; reply_count?: number; reply_users?: string[]; diff --git a/packages/web-api/src/types/response/FilesInfoResponse.ts b/packages/web-api/src/types/response/FilesInfoResponse.ts index 6a9791723..6003e8847 100644 --- a/packages/web-api/src/types/response/FilesInfoResponse.ts +++ b/packages/web-api/src/types/response/FilesInfoResponse.ts @@ -40,6 +40,7 @@ export interface File { app_name?: string; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -86,6 +87,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -178,7 +180,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: TitleBlock[]; + title_blocks?: Block[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -219,6 +221,7 @@ export interface Headers { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -231,6 +234,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -246,116 +250,7 @@ export interface CreationSource { workflow_function_id?: string; } -export interface Schema { - id?: string; - is_primary_column?: boolean; - key?: string; - name?: string; - options?: Options; - type?: string; -} - -export interface Options { - canvas_id?: string; - canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; - choices?: Choice[]; - currency?: string; - currency_format?: string; - date_format?: string; - default_value?: string; - default_value_typed?: DefaultValueTyped; - emoji?: string; - emoji_team_id?: string; - for_assignment?: boolean; - format?: string; - linked_to?: string[]; - mark_as_done_when_checked?: boolean; - max?: number; - notify_users?: boolean; - precision?: number; - rounding?: string; - show_member_name?: boolean; - time_format?: string; -} - -export interface CanvasPlaceholderMapping { - column?: string; - variable?: string; -} - -export interface Choice { - color?: string; - label?: string; - value?: string; -} - -export interface DefaultValueTyped { - select?: string[]; -} - -export interface View { - columns?: Column[]; - created_by?: string; - date_created?: number; - id?: string; - is_all_items_view?: boolean; - is_locked?: boolean; - name?: string; - position?: string; - stick_column_left?: boolean; - type?: string; -} - -export interface Column { - id?: string; - key?: string; - position?: string; - visible?: boolean; - width?: number; -} - -export interface MediaProgress { - duration_ms?: number; - max_offset_ms?: number; - media_watched?: boolean; - offset_ms?: number; -} - -export interface Reaction { - count?: number; - name?: string; - url?: string; - users?: string[]; -} - -export interface Saved { - date_completed?: number; - date_due?: number; - is_archived?: boolean; - state?: string; -} - -export interface Shares { - private?: { [key: string]: Private[] }; - public?: { [key: string]: Private[] }; -} - -export interface Private { - access?: string; - channel_name?: string; - date_last_shared?: number; - latest_reply?: string; - reply_count?: number; - reply_users?: string[]; - reply_users_count?: number; - share_user_id?: string; - source?: string; - team_id?: string; - thread_ts?: string; - ts?: string; -} - -export interface TitleBlock { +export interface Block { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -367,6 +262,7 @@ export interface TitleBlock { description?: Text | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: Text[]; function_trigger_id?: string; @@ -403,7 +299,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -464,7 +360,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: string; + type?: FluffyType; } export interface PurpleElement { @@ -478,7 +374,7 @@ export interface PurpleElement { team_id?: string; text?: string; timestamp?: number; - type?: ElementType; + type?: PurpleType; unicode?: string; unsafe?: boolean; url?: string; @@ -497,7 +393,7 @@ export interface Style { unlink?: boolean; } -export enum ElementType { +export enum PurpleType { Broadcast = 'broadcast', Channel = 'channel', Color = 'color', @@ -510,7 +406,14 @@ export enum ElementType { Usergroup = 'usergroup', } -export interface Filter { +export enum FluffyType { + RichTextList = 'rich_text_list', + RichTextPreformatted = 'rich_text_preformatted', + RichTextQuote = 'rich_text_quote', + RichTextSection = 'rich_text_section', +} + +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -547,6 +450,132 @@ export interface CustomizableInputParameter { value?: string; } +export interface Schema { + id?: string; + is_primary_column?: boolean; + key?: string; + name?: string; + options?: Options; + type?: string; +} + +export interface Options { + canvas_id?: string; + canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; + choices?: Choice[]; + currency?: string; + currency_format?: string; + date_format?: string; + default_value?: string; + default_value_typed?: DefaultValueTyped; + emoji?: string; + emoji_team_id?: string; + for_assignment?: boolean; + format?: string; + linked_to?: string[]; + mark_as_done_when_checked?: boolean; + max?: number; + notify_users?: boolean; + precision?: number; + rounding?: string; + show_member_name?: boolean; + time_format?: string; +} + +export interface CanvasPlaceholderMapping { + column?: string; + variable?: string; +} + +export interface Choice { + color?: string; + label?: string; + value?: string; +} + +export interface DefaultValueTyped { + select?: string[]; +} + +export interface View { + columns?: Column[]; + created_by?: string; + date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; + id?: string; + is_all_items_view?: boolean; + is_locked?: boolean; + name?: string; + position?: string; + show_completed_items?: boolean; + stick_column_left?: boolean; + type?: string; +} + +export interface Column { + id?: string; + key?: string; + position?: string; + visible?: boolean; + width?: number; +} + +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + +export interface MediaProgress { + duration_ms?: number; + max_offset_ms?: number; + media_watched?: boolean; + offset_ms?: number; +} + +export interface Reaction { + count?: number; + name?: string; + url?: string; + users?: string[]; +} + +export interface Saved { + date_completed?: number; + date_due?: number; + is_archived?: boolean; + state?: string; +} + +export interface Shares { + private?: { [key: string]: Private[] }; + public?: { [key: string]: Private[] }; +} + +export interface Private { + access?: string; + channel_name?: string; + date_last_shared?: number; + latest_reply?: string; + reply_count?: number; + reply_users?: string[]; + reply_users_count?: number; + share_user_id?: string; + source?: string; + team_id?: string; + thread_ts?: string; + ts?: string; +} + export interface Transcription { locale?: string; preview?: Preview; diff --git a/packages/web-api/src/types/response/FilesListResponse.ts b/packages/web-api/src/types/response/FilesListResponse.ts index cbc20d36e..507dbbc94 100644 --- a/packages/web-api/src/types/response/FilesListResponse.ts +++ b/packages/web-api/src/types/response/FilesListResponse.ts @@ -24,6 +24,7 @@ export interface File { app_name?: string; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -70,6 +71,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -162,7 +164,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: TitleBlock[]; + title_blocks?: Block[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -213,6 +215,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -225,6 +228,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -240,116 +244,7 @@ export interface CreationSource { workflow_function_id?: string; } -export interface Schema { - id?: string; - is_primary_column?: boolean; - key?: string; - name?: string; - options?: Options; - type?: string; -} - -export interface Options { - canvas_id?: string; - canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; - choices?: Choice[]; - currency?: string; - currency_format?: string; - date_format?: string; - default_value?: string; - default_value_typed?: DefaultValueTyped; - emoji?: string; - emoji_team_id?: string; - for_assignment?: boolean; - format?: string; - linked_to?: string[]; - mark_as_done_when_checked?: boolean; - max?: number; - notify_users?: boolean; - precision?: number; - rounding?: string; - show_member_name?: boolean; - time_format?: string; -} - -export interface CanvasPlaceholderMapping { - column?: string; - variable?: string; -} - -export interface Choice { - color?: string; - label?: string; - value?: string; -} - -export interface DefaultValueTyped { - select?: string[]; -} - -export interface View { - columns?: Column[]; - created_by?: string; - date_created?: number; - id?: string; - is_all_items_view?: boolean; - is_locked?: boolean; - name?: string; - position?: string; - stick_column_left?: boolean; - type?: string; -} - -export interface Column { - id?: string; - key?: string; - position?: string; - visible?: boolean; - width?: number; -} - -export interface MediaProgress { - duration_ms?: number; - max_offset_ms?: number; - media_watched?: boolean; - offset_ms?: number; -} - -export interface Reaction { - count?: number; - name?: string; - url?: string; - users?: string[]; -} - -export interface Saved { - date_completed?: number; - date_due?: number; - is_archived?: boolean; - state?: string; -} - -export interface Shares { - private?: { [key: string]: Private[] }; - public?: { [key: string]: Private[] }; -} - -export interface Private { - access?: string; - channel_name?: string; - date_last_shared?: number; - latest_reply?: string; - reply_count?: number; - reply_users?: string[]; - reply_users_count?: number; - share_user_id?: string; - source?: string; - team_id?: string; - thread_ts?: string; - ts?: string; -} - -export interface TitleBlock { +export interface Block { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -361,6 +256,7 @@ export interface TitleBlock { description?: Text | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: Text[]; function_trigger_id?: string; @@ -397,7 +293,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -458,7 +354,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: string; + type?: FluffyType; } export interface PurpleElement { @@ -472,7 +368,7 @@ export interface PurpleElement { team_id?: string; text?: string; timestamp?: number; - type?: ElementType; + type?: PurpleType; unicode?: string; unsafe?: boolean; url?: string; @@ -491,7 +387,7 @@ export interface Style { unlink?: boolean; } -export enum ElementType { +export enum PurpleType { Broadcast = 'broadcast', Channel = 'channel', Color = 'color', @@ -504,7 +400,14 @@ export enum ElementType { Usergroup = 'usergroup', } -export interface Filter { +export enum FluffyType { + RichTextList = 'rich_text_list', + RichTextPreformatted = 'rich_text_preformatted', + RichTextQuote = 'rich_text_quote', + RichTextSection = 'rich_text_section', +} + +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -541,6 +444,132 @@ export interface CustomizableInputParameter { value?: string; } +export interface Schema { + id?: string; + is_primary_column?: boolean; + key?: string; + name?: string; + options?: Options; + type?: string; +} + +export interface Options { + canvas_id?: string; + canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; + choices?: Choice[]; + currency?: string; + currency_format?: string; + date_format?: string; + default_value?: string; + default_value_typed?: DefaultValueTyped; + emoji?: string; + emoji_team_id?: string; + for_assignment?: boolean; + format?: string; + linked_to?: string[]; + mark_as_done_when_checked?: boolean; + max?: number; + notify_users?: boolean; + precision?: number; + rounding?: string; + show_member_name?: boolean; + time_format?: string; +} + +export interface CanvasPlaceholderMapping { + column?: string; + variable?: string; +} + +export interface Choice { + color?: string; + label?: string; + value?: string; +} + +export interface DefaultValueTyped { + select?: string[]; +} + +export interface View { + columns?: Column[]; + created_by?: string; + date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; + id?: string; + is_all_items_view?: boolean; + is_locked?: boolean; + name?: string; + position?: string; + show_completed_items?: boolean; + stick_column_left?: boolean; + type?: string; +} + +export interface Column { + id?: string; + key?: string; + position?: string; + visible?: boolean; + width?: number; +} + +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + +export interface MediaProgress { + duration_ms?: number; + max_offset_ms?: number; + media_watched?: boolean; + offset_ms?: number; +} + +export interface Reaction { + count?: number; + name?: string; + url?: string; + users?: string[]; +} + +export interface Saved { + date_completed?: number; + date_due?: number; + is_archived?: boolean; + state?: string; +} + +export interface Shares { + private?: { [key: string]: Private[] }; + public?: { [key: string]: Private[] }; +} + +export interface Private { + access?: string; + channel_name?: string; + date_last_shared?: number; + latest_reply?: string; + reply_count?: number; + reply_users?: string[]; + reply_users_count?: number; + share_user_id?: string; + source?: string; + team_id?: string; + thread_ts?: string; + ts?: string; +} + export interface Transcription { locale?: string; preview?: Preview; diff --git a/packages/web-api/src/types/response/FilesRemoteAddResponse.ts b/packages/web-api/src/types/response/FilesRemoteAddResponse.ts index 5db667903..01f77006b 100644 --- a/packages/web-api/src/types/response/FilesRemoteAddResponse.ts +++ b/packages/web-api/src/types/response/FilesRemoteAddResponse.ts @@ -23,6 +23,7 @@ export interface File { app_name?: string; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -69,6 +70,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -161,7 +163,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: TitleBlock[]; + title_blocks?: Block[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -212,6 +214,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -224,6 +227,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -239,116 +243,7 @@ export interface CreationSource { workflow_function_id?: string; } -export interface Schema { - id?: string; - is_primary_column?: boolean; - key?: string; - name?: string; - options?: Options; - type?: string; -} - -export interface Options { - canvas_id?: string; - canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; - choices?: Choice[]; - currency?: string; - currency_format?: string; - date_format?: string; - default_value?: string; - default_value_typed?: DefaultValueTyped; - emoji?: string; - emoji_team_id?: string; - for_assignment?: boolean; - format?: string; - linked_to?: string[]; - mark_as_done_when_checked?: boolean; - max?: number; - notify_users?: boolean; - precision?: number; - rounding?: string; - show_member_name?: boolean; - time_format?: string; -} - -export interface CanvasPlaceholderMapping { - column?: string; - variable?: string; -} - -export interface Choice { - color?: string; - label?: string; - value?: string; -} - -export interface DefaultValueTyped { - select?: string[]; -} - -export interface View { - columns?: Column[]; - created_by?: string; - date_created?: number; - id?: string; - is_all_items_view?: boolean; - is_locked?: boolean; - name?: string; - position?: string; - stick_column_left?: boolean; - type?: string; -} - -export interface Column { - id?: string; - key?: string; - position?: string; - visible?: boolean; - width?: number; -} - -export interface MediaProgress { - duration_ms?: number; - max_offset_ms?: number; - media_watched?: boolean; - offset_ms?: number; -} - -export interface Reaction { - count?: number; - name?: string; - url?: string; - users?: string[]; -} - -export interface Saved { - date_completed?: number; - date_due?: number; - is_archived?: boolean; - state?: string; -} - -export interface Shares { - private?: { [key: string]: Private[] }; - public?: { [key: string]: Private[] }; -} - -export interface Private { - access?: string; - channel_name?: string; - date_last_shared?: number; - latest_reply?: string; - reply_count?: number; - reply_users?: string[]; - reply_users_count?: number; - share_user_id?: string; - source?: string; - team_id?: string; - thread_ts?: string; - ts?: string; -} - -export interface TitleBlock { +export interface Block { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -360,6 +255,7 @@ export interface TitleBlock { description?: Text | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: Text[]; function_trigger_id?: string; @@ -396,7 +292,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -457,7 +353,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: string; + type?: FluffyType; } export interface PurpleElement { @@ -471,7 +367,7 @@ export interface PurpleElement { team_id?: string; text?: string; timestamp?: number; - type?: ElementType; + type?: PurpleType; unicode?: string; unsafe?: boolean; url?: string; @@ -490,7 +386,7 @@ export interface Style { unlink?: boolean; } -export enum ElementType { +export enum PurpleType { Broadcast = 'broadcast', Channel = 'channel', Color = 'color', @@ -503,7 +399,14 @@ export enum ElementType { Usergroup = 'usergroup', } -export interface Filter { +export enum FluffyType { + RichTextList = 'rich_text_list', + RichTextPreformatted = 'rich_text_preformatted', + RichTextQuote = 'rich_text_quote', + RichTextSection = 'rich_text_section', +} + +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -540,6 +443,132 @@ export interface CustomizableInputParameter { value?: string; } +export interface Schema { + id?: string; + is_primary_column?: boolean; + key?: string; + name?: string; + options?: Options; + type?: string; +} + +export interface Options { + canvas_id?: string; + canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; + choices?: Choice[]; + currency?: string; + currency_format?: string; + date_format?: string; + default_value?: string; + default_value_typed?: DefaultValueTyped; + emoji?: string; + emoji_team_id?: string; + for_assignment?: boolean; + format?: string; + linked_to?: string[]; + mark_as_done_when_checked?: boolean; + max?: number; + notify_users?: boolean; + precision?: number; + rounding?: string; + show_member_name?: boolean; + time_format?: string; +} + +export interface CanvasPlaceholderMapping { + column?: string; + variable?: string; +} + +export interface Choice { + color?: string; + label?: string; + value?: string; +} + +export interface DefaultValueTyped { + select?: string[]; +} + +export interface View { + columns?: Column[]; + created_by?: string; + date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; + id?: string; + is_all_items_view?: boolean; + is_locked?: boolean; + name?: string; + position?: string; + show_completed_items?: boolean; + stick_column_left?: boolean; + type?: string; +} + +export interface Column { + id?: string; + key?: string; + position?: string; + visible?: boolean; + width?: number; +} + +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + +export interface MediaProgress { + duration_ms?: number; + max_offset_ms?: number; + media_watched?: boolean; + offset_ms?: number; +} + +export interface Reaction { + count?: number; + name?: string; + url?: string; + users?: string[]; +} + +export interface Saved { + date_completed?: number; + date_due?: number; + is_archived?: boolean; + state?: string; +} + +export interface Shares { + private?: { [key: string]: Private[] }; + public?: { [key: string]: Private[] }; +} + +export interface Private { + access?: string; + channel_name?: string; + date_last_shared?: number; + latest_reply?: string; + reply_count?: number; + reply_users?: string[]; + reply_users_count?: number; + share_user_id?: string; + source?: string; + team_id?: string; + thread_ts?: string; + ts?: string; +} + export interface Transcription { locale?: string; preview?: Preview; diff --git a/packages/web-api/src/types/response/FilesRemoteInfoResponse.ts b/packages/web-api/src/types/response/FilesRemoteInfoResponse.ts index b9b679b9d..19c7e5ac9 100644 --- a/packages/web-api/src/types/response/FilesRemoteInfoResponse.ts +++ b/packages/web-api/src/types/response/FilesRemoteInfoResponse.ts @@ -23,6 +23,7 @@ export interface File { app_name?: string; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -69,6 +70,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -161,7 +163,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: TitleBlock[]; + title_blocks?: Block[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -212,6 +214,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -224,6 +227,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -239,116 +243,7 @@ export interface CreationSource { workflow_function_id?: string; } -export interface Schema { - id?: string; - is_primary_column?: boolean; - key?: string; - name?: string; - options?: Options; - type?: string; -} - -export interface Options { - canvas_id?: string; - canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; - choices?: Choice[]; - currency?: string; - currency_format?: string; - date_format?: string; - default_value?: string; - default_value_typed?: DefaultValueTyped; - emoji?: string; - emoji_team_id?: string; - for_assignment?: boolean; - format?: string; - linked_to?: string[]; - mark_as_done_when_checked?: boolean; - max?: number; - notify_users?: boolean; - precision?: number; - rounding?: string; - show_member_name?: boolean; - time_format?: string; -} - -export interface CanvasPlaceholderMapping { - column?: string; - variable?: string; -} - -export interface Choice { - color?: string; - label?: string; - value?: string; -} - -export interface DefaultValueTyped { - select?: string[]; -} - -export interface View { - columns?: Column[]; - created_by?: string; - date_created?: number; - id?: string; - is_all_items_view?: boolean; - is_locked?: boolean; - name?: string; - position?: string; - stick_column_left?: boolean; - type?: string; -} - -export interface Column { - id?: string; - key?: string; - position?: string; - visible?: boolean; - width?: number; -} - -export interface MediaProgress { - duration_ms?: number; - max_offset_ms?: number; - media_watched?: boolean; - offset_ms?: number; -} - -export interface Reaction { - count?: number; - name?: string; - url?: string; - users?: string[]; -} - -export interface Saved { - date_completed?: number; - date_due?: number; - is_archived?: boolean; - state?: string; -} - -export interface Shares { - private?: { [key: string]: Private[] }; - public?: { [key: string]: Private[] }; -} - -export interface Private { - access?: string; - channel_name?: string; - date_last_shared?: number; - latest_reply?: string; - reply_count?: number; - reply_users?: string[]; - reply_users_count?: number; - share_user_id?: string; - source?: string; - team_id?: string; - thread_ts?: string; - ts?: string; -} - -export interface TitleBlock { +export interface Block { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -360,6 +255,7 @@ export interface TitleBlock { description?: Text | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: Text[]; function_trigger_id?: string; @@ -396,7 +292,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -457,7 +353,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: string; + type?: FluffyType; } export interface PurpleElement { @@ -471,7 +367,7 @@ export interface PurpleElement { team_id?: string; text?: string; timestamp?: number; - type?: ElementType; + type?: PurpleType; unicode?: string; unsafe?: boolean; url?: string; @@ -490,7 +386,7 @@ export interface Style { unlink?: boolean; } -export enum ElementType { +export enum PurpleType { Broadcast = 'broadcast', Channel = 'channel', Color = 'color', @@ -503,7 +399,14 @@ export enum ElementType { Usergroup = 'usergroup', } -export interface Filter { +export enum FluffyType { + RichTextList = 'rich_text_list', + RichTextPreformatted = 'rich_text_preformatted', + RichTextQuote = 'rich_text_quote', + RichTextSection = 'rich_text_section', +} + +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -540,6 +443,132 @@ export interface CustomizableInputParameter { value?: string; } +export interface Schema { + id?: string; + is_primary_column?: boolean; + key?: string; + name?: string; + options?: Options; + type?: string; +} + +export interface Options { + canvas_id?: string; + canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; + choices?: Choice[]; + currency?: string; + currency_format?: string; + date_format?: string; + default_value?: string; + default_value_typed?: DefaultValueTyped; + emoji?: string; + emoji_team_id?: string; + for_assignment?: boolean; + format?: string; + linked_to?: string[]; + mark_as_done_when_checked?: boolean; + max?: number; + notify_users?: boolean; + precision?: number; + rounding?: string; + show_member_name?: boolean; + time_format?: string; +} + +export interface CanvasPlaceholderMapping { + column?: string; + variable?: string; +} + +export interface Choice { + color?: string; + label?: string; + value?: string; +} + +export interface DefaultValueTyped { + select?: string[]; +} + +export interface View { + columns?: Column[]; + created_by?: string; + date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; + id?: string; + is_all_items_view?: boolean; + is_locked?: boolean; + name?: string; + position?: string; + show_completed_items?: boolean; + stick_column_left?: boolean; + type?: string; +} + +export interface Column { + id?: string; + key?: string; + position?: string; + visible?: boolean; + width?: number; +} + +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + +export interface MediaProgress { + duration_ms?: number; + max_offset_ms?: number; + media_watched?: boolean; + offset_ms?: number; +} + +export interface Reaction { + count?: number; + name?: string; + url?: string; + users?: string[]; +} + +export interface Saved { + date_completed?: number; + date_due?: number; + is_archived?: boolean; + state?: string; +} + +export interface Shares { + private?: { [key: string]: Private[] }; + public?: { [key: string]: Private[] }; +} + +export interface Private { + access?: string; + channel_name?: string; + date_last_shared?: number; + latest_reply?: string; + reply_count?: number; + reply_users?: string[]; + reply_users_count?: number; + share_user_id?: string; + source?: string; + team_id?: string; + thread_ts?: string; + ts?: string; +} + export interface Transcription { locale?: string; preview?: Preview; diff --git a/packages/web-api/src/types/response/FilesRemoteListResponse.ts b/packages/web-api/src/types/response/FilesRemoteListResponse.ts index c3b4fc7fd..6854f61b1 100644 --- a/packages/web-api/src/types/response/FilesRemoteListResponse.ts +++ b/packages/web-api/src/types/response/FilesRemoteListResponse.ts @@ -24,6 +24,7 @@ export interface File { app_name?: string; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -70,6 +71,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -162,7 +164,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: TitleBlock[]; + title_blocks?: Block[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -213,6 +215,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -225,6 +228,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -240,116 +244,7 @@ export interface CreationSource { workflow_function_id?: string; } -export interface Schema { - id?: string; - is_primary_column?: boolean; - key?: string; - name?: string; - options?: Options; - type?: string; -} - -export interface Options { - canvas_id?: string; - canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; - choices?: Choice[]; - currency?: string; - currency_format?: string; - date_format?: string; - default_value?: string; - default_value_typed?: DefaultValueTyped; - emoji?: string; - emoji_team_id?: string; - for_assignment?: boolean; - format?: string; - linked_to?: string[]; - mark_as_done_when_checked?: boolean; - max?: number; - notify_users?: boolean; - precision?: number; - rounding?: string; - show_member_name?: boolean; - time_format?: string; -} - -export interface CanvasPlaceholderMapping { - column?: string; - variable?: string; -} - -export interface Choice { - color?: string; - label?: string; - value?: string; -} - -export interface DefaultValueTyped { - select?: string[]; -} - -export interface View { - columns?: Column[]; - created_by?: string; - date_created?: number; - id?: string; - is_all_items_view?: boolean; - is_locked?: boolean; - name?: string; - position?: string; - stick_column_left?: boolean; - type?: string; -} - -export interface Column { - id?: string; - key?: string; - position?: string; - visible?: boolean; - width?: number; -} - -export interface MediaProgress { - duration_ms?: number; - max_offset_ms?: number; - media_watched?: boolean; - offset_ms?: number; -} - -export interface Reaction { - count?: number; - name?: string; - url?: string; - users?: string[]; -} - -export interface Saved { - date_completed?: number; - date_due?: number; - is_archived?: boolean; - state?: string; -} - -export interface Shares { - private?: { [key: string]: Private[] }; - public?: { [key: string]: Private[] }; -} - -export interface Private { - access?: string; - channel_name?: string; - date_last_shared?: number; - latest_reply?: string; - reply_count?: number; - reply_users?: string[]; - reply_users_count?: number; - share_user_id?: string; - source?: string; - team_id?: string; - thread_ts?: string; - ts?: string; -} - -export interface TitleBlock { +export interface Block { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -361,6 +256,7 @@ export interface TitleBlock { description?: Text | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: Text[]; function_trigger_id?: string; @@ -397,7 +293,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -458,7 +354,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: string; + type?: FluffyType; } export interface PurpleElement { @@ -472,7 +368,7 @@ export interface PurpleElement { team_id?: string; text?: string; timestamp?: number; - type?: ElementType; + type?: PurpleType; unicode?: string; unsafe?: boolean; url?: string; @@ -491,7 +387,7 @@ export interface Style { unlink?: boolean; } -export enum ElementType { +export enum PurpleType { Broadcast = 'broadcast', Channel = 'channel', Color = 'color', @@ -504,7 +400,14 @@ export enum ElementType { Usergroup = 'usergroup', } -export interface Filter { +export enum FluffyType { + RichTextList = 'rich_text_list', + RichTextPreformatted = 'rich_text_preformatted', + RichTextQuote = 'rich_text_quote', + RichTextSection = 'rich_text_section', +} + +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -541,6 +444,132 @@ export interface CustomizableInputParameter { value?: string; } +export interface Schema { + id?: string; + is_primary_column?: boolean; + key?: string; + name?: string; + options?: Options; + type?: string; +} + +export interface Options { + canvas_id?: string; + canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; + choices?: Choice[]; + currency?: string; + currency_format?: string; + date_format?: string; + default_value?: string; + default_value_typed?: DefaultValueTyped; + emoji?: string; + emoji_team_id?: string; + for_assignment?: boolean; + format?: string; + linked_to?: string[]; + mark_as_done_when_checked?: boolean; + max?: number; + notify_users?: boolean; + precision?: number; + rounding?: string; + show_member_name?: boolean; + time_format?: string; +} + +export interface CanvasPlaceholderMapping { + column?: string; + variable?: string; +} + +export interface Choice { + color?: string; + label?: string; + value?: string; +} + +export interface DefaultValueTyped { + select?: string[]; +} + +export interface View { + columns?: Column[]; + created_by?: string; + date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; + id?: string; + is_all_items_view?: boolean; + is_locked?: boolean; + name?: string; + position?: string; + show_completed_items?: boolean; + stick_column_left?: boolean; + type?: string; +} + +export interface Column { + id?: string; + key?: string; + position?: string; + visible?: boolean; + width?: number; +} + +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + +export interface MediaProgress { + duration_ms?: number; + max_offset_ms?: number; + media_watched?: boolean; + offset_ms?: number; +} + +export interface Reaction { + count?: number; + name?: string; + url?: string; + users?: string[]; +} + +export interface Saved { + date_completed?: number; + date_due?: number; + is_archived?: boolean; + state?: string; +} + +export interface Shares { + private?: { [key: string]: Private[] }; + public?: { [key: string]: Private[] }; +} + +export interface Private { + access?: string; + channel_name?: string; + date_last_shared?: number; + latest_reply?: string; + reply_count?: number; + reply_users?: string[]; + reply_users_count?: number; + share_user_id?: string; + source?: string; + team_id?: string; + thread_ts?: string; + ts?: string; +} + export interface Transcription { locale?: string; preview?: Preview; diff --git a/packages/web-api/src/types/response/FilesRemoteShareResponse.ts b/packages/web-api/src/types/response/FilesRemoteShareResponse.ts index f8fe76d2d..4d1b2d60d 100644 --- a/packages/web-api/src/types/response/FilesRemoteShareResponse.ts +++ b/packages/web-api/src/types/response/FilesRemoteShareResponse.ts @@ -23,6 +23,7 @@ export interface File { app_name?: string; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -69,6 +70,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -161,7 +163,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: TitleBlock[]; + title_blocks?: Block[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -212,6 +214,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -224,6 +227,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -239,116 +243,7 @@ export interface CreationSource { workflow_function_id?: string; } -export interface Schema { - id?: string; - is_primary_column?: boolean; - key?: string; - name?: string; - options?: Options; - type?: string; -} - -export interface Options { - canvas_id?: string; - canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; - choices?: Choice[]; - currency?: string; - currency_format?: string; - date_format?: string; - default_value?: string; - default_value_typed?: DefaultValueTyped; - emoji?: string; - emoji_team_id?: string; - for_assignment?: boolean; - format?: string; - linked_to?: string[]; - mark_as_done_when_checked?: boolean; - max?: number; - notify_users?: boolean; - precision?: number; - rounding?: string; - show_member_name?: boolean; - time_format?: string; -} - -export interface CanvasPlaceholderMapping { - column?: string; - variable?: string; -} - -export interface Choice { - color?: string; - label?: string; - value?: string; -} - -export interface DefaultValueTyped { - select?: string[]; -} - -export interface View { - columns?: Column[]; - created_by?: string; - date_created?: number; - id?: string; - is_all_items_view?: boolean; - is_locked?: boolean; - name?: string; - position?: string; - stick_column_left?: boolean; - type?: string; -} - -export interface Column { - id?: string; - key?: string; - position?: string; - visible?: boolean; - width?: number; -} - -export interface MediaProgress { - duration_ms?: number; - max_offset_ms?: number; - media_watched?: boolean; - offset_ms?: number; -} - -export interface Reaction { - count?: number; - name?: string; - url?: string; - users?: string[]; -} - -export interface Saved { - date_completed?: number; - date_due?: number; - is_archived?: boolean; - state?: string; -} - -export interface Shares { - private?: { [key: string]: Private[] }; - public?: { [key: string]: Private[] }; -} - -export interface Private { - access?: string; - channel_name?: string; - date_last_shared?: number; - latest_reply?: string; - reply_count?: number; - reply_users?: string[]; - reply_users_count?: number; - share_user_id?: string; - source?: string; - team_id?: string; - thread_ts?: string; - ts?: string; -} - -export interface TitleBlock { +export interface Block { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -360,6 +255,7 @@ export interface TitleBlock { description?: Text | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: Text[]; function_trigger_id?: string; @@ -396,7 +292,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -457,7 +353,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: string; + type?: FluffyType; } export interface PurpleElement { @@ -471,7 +367,7 @@ export interface PurpleElement { team_id?: string; text?: string; timestamp?: number; - type?: ElementType; + type?: PurpleType; unicode?: string; unsafe?: boolean; url?: string; @@ -490,7 +386,7 @@ export interface Style { unlink?: boolean; } -export enum ElementType { +export enum PurpleType { Broadcast = 'broadcast', Channel = 'channel', Color = 'color', @@ -503,7 +399,14 @@ export enum ElementType { Usergroup = 'usergroup', } -export interface Filter { +export enum FluffyType { + RichTextList = 'rich_text_list', + RichTextPreformatted = 'rich_text_preformatted', + RichTextQuote = 'rich_text_quote', + RichTextSection = 'rich_text_section', +} + +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -540,6 +443,132 @@ export interface CustomizableInputParameter { value?: string; } +export interface Schema { + id?: string; + is_primary_column?: boolean; + key?: string; + name?: string; + options?: Options; + type?: string; +} + +export interface Options { + canvas_id?: string; + canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; + choices?: Choice[]; + currency?: string; + currency_format?: string; + date_format?: string; + default_value?: string; + default_value_typed?: DefaultValueTyped; + emoji?: string; + emoji_team_id?: string; + for_assignment?: boolean; + format?: string; + linked_to?: string[]; + mark_as_done_when_checked?: boolean; + max?: number; + notify_users?: boolean; + precision?: number; + rounding?: string; + show_member_name?: boolean; + time_format?: string; +} + +export interface CanvasPlaceholderMapping { + column?: string; + variable?: string; +} + +export interface Choice { + color?: string; + label?: string; + value?: string; +} + +export interface DefaultValueTyped { + select?: string[]; +} + +export interface View { + columns?: Column[]; + created_by?: string; + date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; + id?: string; + is_all_items_view?: boolean; + is_locked?: boolean; + name?: string; + position?: string; + show_completed_items?: boolean; + stick_column_left?: boolean; + type?: string; +} + +export interface Column { + id?: string; + key?: string; + position?: string; + visible?: boolean; + width?: number; +} + +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + +export interface MediaProgress { + duration_ms?: number; + max_offset_ms?: number; + media_watched?: boolean; + offset_ms?: number; +} + +export interface Reaction { + count?: number; + name?: string; + url?: string; + users?: string[]; +} + +export interface Saved { + date_completed?: number; + date_due?: number; + is_archived?: boolean; + state?: string; +} + +export interface Shares { + private?: { [key: string]: Private[] }; + public?: { [key: string]: Private[] }; +} + +export interface Private { + access?: string; + channel_name?: string; + date_last_shared?: number; + latest_reply?: string; + reply_count?: number; + reply_users?: string[]; + reply_users_count?: number; + share_user_id?: string; + source?: string; + team_id?: string; + thread_ts?: string; + ts?: string; +} + export interface Transcription { locale?: string; preview?: Preview; diff --git a/packages/web-api/src/types/response/FilesRemoteUpdateResponse.ts b/packages/web-api/src/types/response/FilesRemoteUpdateResponse.ts index 7a2f61c4e..53cbe263e 100644 --- a/packages/web-api/src/types/response/FilesRemoteUpdateResponse.ts +++ b/packages/web-api/src/types/response/FilesRemoteUpdateResponse.ts @@ -23,6 +23,7 @@ export interface File { app_name?: string; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -69,6 +70,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -161,7 +163,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: TitleBlock[]; + title_blocks?: Block[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -212,6 +214,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -224,6 +227,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -239,116 +243,7 @@ export interface CreationSource { workflow_function_id?: string; } -export interface Schema { - id?: string; - is_primary_column?: boolean; - key?: string; - name?: string; - options?: Options; - type?: string; -} - -export interface Options { - canvas_id?: string; - canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; - choices?: Choice[]; - currency?: string; - currency_format?: string; - date_format?: string; - default_value?: string; - default_value_typed?: DefaultValueTyped; - emoji?: string; - emoji_team_id?: string; - for_assignment?: boolean; - format?: string; - linked_to?: string[]; - mark_as_done_when_checked?: boolean; - max?: number; - notify_users?: boolean; - precision?: number; - rounding?: string; - show_member_name?: boolean; - time_format?: string; -} - -export interface CanvasPlaceholderMapping { - column?: string; - variable?: string; -} - -export interface Choice { - color?: string; - label?: string; - value?: string; -} - -export interface DefaultValueTyped { - select?: string[]; -} - -export interface View { - columns?: Column[]; - created_by?: string; - date_created?: number; - id?: string; - is_all_items_view?: boolean; - is_locked?: boolean; - name?: string; - position?: string; - stick_column_left?: boolean; - type?: string; -} - -export interface Column { - id?: string; - key?: string; - position?: string; - visible?: boolean; - width?: number; -} - -export interface MediaProgress { - duration_ms?: number; - max_offset_ms?: number; - media_watched?: boolean; - offset_ms?: number; -} - -export interface Reaction { - count?: number; - name?: string; - url?: string; - users?: string[]; -} - -export interface Saved { - date_completed?: number; - date_due?: number; - is_archived?: boolean; - state?: string; -} - -export interface Shares { - private?: { [key: string]: Private[] }; - public?: { [key: string]: Private[] }; -} - -export interface Private { - access?: string; - channel_name?: string; - date_last_shared?: number; - latest_reply?: string; - reply_count?: number; - reply_users?: string[]; - reply_users_count?: number; - share_user_id?: string; - source?: string; - team_id?: string; - thread_ts?: string; - ts?: string; -} - -export interface TitleBlock { +export interface Block { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -360,6 +255,7 @@ export interface TitleBlock { description?: Text | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: Text[]; function_trigger_id?: string; @@ -396,7 +292,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -457,7 +353,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: string; + type?: FluffyType; } export interface PurpleElement { @@ -471,7 +367,7 @@ export interface PurpleElement { team_id?: string; text?: string; timestamp?: number; - type?: ElementType; + type?: PurpleType; unicode?: string; unsafe?: boolean; url?: string; @@ -490,7 +386,7 @@ export interface Style { unlink?: boolean; } -export enum ElementType { +export enum PurpleType { Broadcast = 'broadcast', Channel = 'channel', Color = 'color', @@ -503,7 +399,14 @@ export enum ElementType { Usergroup = 'usergroup', } -export interface Filter { +export enum FluffyType { + RichTextList = 'rich_text_list', + RichTextPreformatted = 'rich_text_preformatted', + RichTextQuote = 'rich_text_quote', + RichTextSection = 'rich_text_section', +} + +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -540,6 +443,132 @@ export interface CustomizableInputParameter { value?: string; } +export interface Schema { + id?: string; + is_primary_column?: boolean; + key?: string; + name?: string; + options?: Options; + type?: string; +} + +export interface Options { + canvas_id?: string; + canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; + choices?: Choice[]; + currency?: string; + currency_format?: string; + date_format?: string; + default_value?: string; + default_value_typed?: DefaultValueTyped; + emoji?: string; + emoji_team_id?: string; + for_assignment?: boolean; + format?: string; + linked_to?: string[]; + mark_as_done_when_checked?: boolean; + max?: number; + notify_users?: boolean; + precision?: number; + rounding?: string; + show_member_name?: boolean; + time_format?: string; +} + +export interface CanvasPlaceholderMapping { + column?: string; + variable?: string; +} + +export interface Choice { + color?: string; + label?: string; + value?: string; +} + +export interface DefaultValueTyped { + select?: string[]; +} + +export interface View { + columns?: Column[]; + created_by?: string; + date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; + id?: string; + is_all_items_view?: boolean; + is_locked?: boolean; + name?: string; + position?: string; + show_completed_items?: boolean; + stick_column_left?: boolean; + type?: string; +} + +export interface Column { + id?: string; + key?: string; + position?: string; + visible?: boolean; + width?: number; +} + +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + +export interface MediaProgress { + duration_ms?: number; + max_offset_ms?: number; + media_watched?: boolean; + offset_ms?: number; +} + +export interface Reaction { + count?: number; + name?: string; + url?: string; + users?: string[]; +} + +export interface Saved { + date_completed?: number; + date_due?: number; + is_archived?: boolean; + state?: string; +} + +export interface Shares { + private?: { [key: string]: Private[] }; + public?: { [key: string]: Private[] }; +} + +export interface Private { + access?: string; + channel_name?: string; + date_last_shared?: number; + latest_reply?: string; + reply_count?: number; + reply_users?: string[]; + reply_users_count?: number; + share_user_id?: string; + source?: string; + team_id?: string; + thread_ts?: string; + ts?: string; +} + export interface Transcription { locale?: string; preview?: Preview; diff --git a/packages/web-api/src/types/response/FilesRevokePublicURLResponse.ts b/packages/web-api/src/types/response/FilesRevokePublicURLResponse.ts index bd7857525..9bb10a619 100644 --- a/packages/web-api/src/types/response/FilesRevokePublicURLResponse.ts +++ b/packages/web-api/src/types/response/FilesRevokePublicURLResponse.ts @@ -23,6 +23,7 @@ export interface File { app_name?: string; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -69,6 +70,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -161,7 +163,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: TitleBlock[]; + title_blocks?: Block[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -212,6 +214,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -224,6 +227,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -239,116 +243,7 @@ export interface CreationSource { workflow_function_id?: string; } -export interface Schema { - id?: string; - is_primary_column?: boolean; - key?: string; - name?: string; - options?: Options; - type?: string; -} - -export interface Options { - canvas_id?: string; - canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; - choices?: Choice[]; - currency?: string; - currency_format?: string; - date_format?: string; - default_value?: string; - default_value_typed?: DefaultValueTyped; - emoji?: string; - emoji_team_id?: string; - for_assignment?: boolean; - format?: string; - linked_to?: string[]; - mark_as_done_when_checked?: boolean; - max?: number; - notify_users?: boolean; - precision?: number; - rounding?: string; - show_member_name?: boolean; - time_format?: string; -} - -export interface CanvasPlaceholderMapping { - column?: string; - variable?: string; -} - -export interface Choice { - color?: string; - label?: string; - value?: string; -} - -export interface DefaultValueTyped { - select?: string[]; -} - -export interface View { - columns?: Column[]; - created_by?: string; - date_created?: number; - id?: string; - is_all_items_view?: boolean; - is_locked?: boolean; - name?: string; - position?: string; - stick_column_left?: boolean; - type?: string; -} - -export interface Column { - id?: string; - key?: string; - position?: string; - visible?: boolean; - width?: number; -} - -export interface MediaProgress { - duration_ms?: number; - max_offset_ms?: number; - media_watched?: boolean; - offset_ms?: number; -} - -export interface Reaction { - count?: number; - name?: string; - url?: string; - users?: string[]; -} - -export interface Saved { - date_completed?: number; - date_due?: number; - is_archived?: boolean; - state?: string; -} - -export interface Shares { - private?: { [key: string]: Private[] }; - public?: { [key: string]: Private[] }; -} - -export interface Private { - access?: string; - channel_name?: string; - date_last_shared?: number; - latest_reply?: string; - reply_count?: number; - reply_users?: string[]; - reply_users_count?: number; - share_user_id?: string; - source?: string; - team_id?: string; - thread_ts?: string; - ts?: string; -} - -export interface TitleBlock { +export interface Block { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -360,6 +255,7 @@ export interface TitleBlock { description?: Text | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: Text[]; function_trigger_id?: string; @@ -396,7 +292,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -457,7 +353,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: string; + type?: FluffyType; } export interface PurpleElement { @@ -471,7 +367,7 @@ export interface PurpleElement { team_id?: string; text?: string; timestamp?: number; - type?: ElementType; + type?: PurpleType; unicode?: string; unsafe?: boolean; url?: string; @@ -490,7 +386,7 @@ export interface Style { unlink?: boolean; } -export enum ElementType { +export enum PurpleType { Broadcast = 'broadcast', Channel = 'channel', Color = 'color', @@ -503,7 +399,14 @@ export enum ElementType { Usergroup = 'usergroup', } -export interface Filter { +export enum FluffyType { + RichTextList = 'rich_text_list', + RichTextPreformatted = 'rich_text_preformatted', + RichTextQuote = 'rich_text_quote', + RichTextSection = 'rich_text_section', +} + +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -540,6 +443,132 @@ export interface CustomizableInputParameter { value?: string; } +export interface Schema { + id?: string; + is_primary_column?: boolean; + key?: string; + name?: string; + options?: Options; + type?: string; +} + +export interface Options { + canvas_id?: string; + canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; + choices?: Choice[]; + currency?: string; + currency_format?: string; + date_format?: string; + default_value?: string; + default_value_typed?: DefaultValueTyped; + emoji?: string; + emoji_team_id?: string; + for_assignment?: boolean; + format?: string; + linked_to?: string[]; + mark_as_done_when_checked?: boolean; + max?: number; + notify_users?: boolean; + precision?: number; + rounding?: string; + show_member_name?: boolean; + time_format?: string; +} + +export interface CanvasPlaceholderMapping { + column?: string; + variable?: string; +} + +export interface Choice { + color?: string; + label?: string; + value?: string; +} + +export interface DefaultValueTyped { + select?: string[]; +} + +export interface View { + columns?: Column[]; + created_by?: string; + date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; + id?: string; + is_all_items_view?: boolean; + is_locked?: boolean; + name?: string; + position?: string; + show_completed_items?: boolean; + stick_column_left?: boolean; + type?: string; +} + +export interface Column { + id?: string; + key?: string; + position?: string; + visible?: boolean; + width?: number; +} + +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + +export interface MediaProgress { + duration_ms?: number; + max_offset_ms?: number; + media_watched?: boolean; + offset_ms?: number; +} + +export interface Reaction { + count?: number; + name?: string; + url?: string; + users?: string[]; +} + +export interface Saved { + date_completed?: number; + date_due?: number; + is_archived?: boolean; + state?: string; +} + +export interface Shares { + private?: { [key: string]: Private[] }; + public?: { [key: string]: Private[] }; +} + +export interface Private { + access?: string; + channel_name?: string; + date_last_shared?: number; + latest_reply?: string; + reply_count?: number; + reply_users?: string[]; + reply_users_count?: number; + share_user_id?: string; + source?: string; + team_id?: string; + thread_ts?: string; + ts?: string; +} + export interface Transcription { locale?: string; preview?: Preview; diff --git a/packages/web-api/src/types/response/FilesSharedPublicURLResponse.ts b/packages/web-api/src/types/response/FilesSharedPublicURLResponse.ts index 290c98f31..45d258383 100644 --- a/packages/web-api/src/types/response/FilesSharedPublicURLResponse.ts +++ b/packages/web-api/src/types/response/FilesSharedPublicURLResponse.ts @@ -23,6 +23,7 @@ export interface File { app_name?: string; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -69,6 +70,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -161,7 +163,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: TitleBlock[]; + title_blocks?: Block[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -212,6 +214,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -224,6 +227,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -239,116 +243,7 @@ export interface CreationSource { workflow_function_id?: string; } -export interface Schema { - id?: string; - is_primary_column?: boolean; - key?: string; - name?: string; - options?: Options; - type?: string; -} - -export interface Options { - canvas_id?: string; - canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; - choices?: Choice[]; - currency?: string; - currency_format?: string; - date_format?: string; - default_value?: string; - default_value_typed?: DefaultValueTyped; - emoji?: string; - emoji_team_id?: string; - for_assignment?: boolean; - format?: string; - linked_to?: string[]; - mark_as_done_when_checked?: boolean; - max?: number; - notify_users?: boolean; - precision?: number; - rounding?: string; - show_member_name?: boolean; - time_format?: string; -} - -export interface CanvasPlaceholderMapping { - column?: string; - variable?: string; -} - -export interface Choice { - color?: string; - label?: string; - value?: string; -} - -export interface DefaultValueTyped { - select?: string[]; -} - -export interface View { - columns?: Column[]; - created_by?: string; - date_created?: number; - id?: string; - is_all_items_view?: boolean; - is_locked?: boolean; - name?: string; - position?: string; - stick_column_left?: boolean; - type?: string; -} - -export interface Column { - id?: string; - key?: string; - position?: string; - visible?: boolean; - width?: number; -} - -export interface MediaProgress { - duration_ms?: number; - max_offset_ms?: number; - media_watched?: boolean; - offset_ms?: number; -} - -export interface Reaction { - count?: number; - name?: string; - url?: string; - users?: string[]; -} - -export interface Saved { - date_completed?: number; - date_due?: number; - is_archived?: boolean; - state?: string; -} - -export interface Shares { - private?: { [key: string]: Private[] }; - public?: { [key: string]: Private[] }; -} - -export interface Private { - access?: string; - channel_name?: string; - date_last_shared?: number; - latest_reply?: string; - reply_count?: number; - reply_users?: string[]; - reply_users_count?: number; - share_user_id?: string; - source?: string; - team_id?: string; - thread_ts?: string; - ts?: string; -} - -export interface TitleBlock { +export interface Block { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -360,6 +255,7 @@ export interface TitleBlock { description?: Text | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: Text[]; function_trigger_id?: string; @@ -396,7 +292,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -457,7 +353,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: string; + type?: FluffyType; } export interface PurpleElement { @@ -471,7 +367,7 @@ export interface PurpleElement { team_id?: string; text?: string; timestamp?: number; - type?: ElementType; + type?: PurpleType; unicode?: string; unsafe?: boolean; url?: string; @@ -490,7 +386,7 @@ export interface Style { unlink?: boolean; } -export enum ElementType { +export enum PurpleType { Broadcast = 'broadcast', Channel = 'channel', Color = 'color', @@ -503,7 +399,14 @@ export enum ElementType { Usergroup = 'usergroup', } -export interface Filter { +export enum FluffyType { + RichTextList = 'rich_text_list', + RichTextPreformatted = 'rich_text_preformatted', + RichTextQuote = 'rich_text_quote', + RichTextSection = 'rich_text_section', +} + +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -540,6 +443,132 @@ export interface CustomizableInputParameter { value?: string; } +export interface Schema { + id?: string; + is_primary_column?: boolean; + key?: string; + name?: string; + options?: Options; + type?: string; +} + +export interface Options { + canvas_id?: string; + canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; + choices?: Choice[]; + currency?: string; + currency_format?: string; + date_format?: string; + default_value?: string; + default_value_typed?: DefaultValueTyped; + emoji?: string; + emoji_team_id?: string; + for_assignment?: boolean; + format?: string; + linked_to?: string[]; + mark_as_done_when_checked?: boolean; + max?: number; + notify_users?: boolean; + precision?: number; + rounding?: string; + show_member_name?: boolean; + time_format?: string; +} + +export interface CanvasPlaceholderMapping { + column?: string; + variable?: string; +} + +export interface Choice { + color?: string; + label?: string; + value?: string; +} + +export interface DefaultValueTyped { + select?: string[]; +} + +export interface View { + columns?: Column[]; + created_by?: string; + date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; + id?: string; + is_all_items_view?: boolean; + is_locked?: boolean; + name?: string; + position?: string; + show_completed_items?: boolean; + stick_column_left?: boolean; + type?: string; +} + +export interface Column { + id?: string; + key?: string; + position?: string; + visible?: boolean; + width?: number; +} + +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + +export interface MediaProgress { + duration_ms?: number; + max_offset_ms?: number; + media_watched?: boolean; + offset_ms?: number; +} + +export interface Reaction { + count?: number; + name?: string; + url?: string; + users?: string[]; +} + +export interface Saved { + date_completed?: number; + date_due?: number; + is_archived?: boolean; + state?: string; +} + +export interface Shares { + private?: { [key: string]: Private[] }; + public?: { [key: string]: Private[] }; +} + +export interface Private { + access?: string; + channel_name?: string; + date_last_shared?: number; + latest_reply?: string; + reply_count?: number; + reply_users?: string[]; + reply_users_count?: number; + share_user_id?: string; + source?: string; + team_id?: string; + thread_ts?: string; + ts?: string; +} + export interface Transcription { locale?: string; preview?: Preview; diff --git a/packages/web-api/src/types/response/FilesUploadResponse.ts b/packages/web-api/src/types/response/FilesUploadResponse.ts index 13184d572..467314ecf 100644 --- a/packages/web-api/src/types/response/FilesUploadResponse.ts +++ b/packages/web-api/src/types/response/FilesUploadResponse.ts @@ -23,6 +23,7 @@ export interface File { app_name?: string; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -69,6 +70,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -161,7 +163,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: TitleBlock[]; + title_blocks?: Block[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -212,6 +214,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -224,6 +227,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -239,116 +243,7 @@ export interface CreationSource { workflow_function_id?: string; } -export interface Schema { - id?: string; - is_primary_column?: boolean; - key?: string; - name?: string; - options?: Options; - type?: string; -} - -export interface Options { - canvas_id?: string; - canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; - choices?: Choice[]; - currency?: string; - currency_format?: string; - date_format?: string; - default_value?: string; - default_value_typed?: DefaultValueTyped; - emoji?: string; - emoji_team_id?: string; - for_assignment?: boolean; - format?: string; - linked_to?: string[]; - mark_as_done_when_checked?: boolean; - max?: number; - notify_users?: boolean; - precision?: number; - rounding?: string; - show_member_name?: boolean; - time_format?: string; -} - -export interface CanvasPlaceholderMapping { - column?: string; - variable?: string; -} - -export interface Choice { - color?: string; - label?: string; - value?: string; -} - -export interface DefaultValueTyped { - select?: string[]; -} - -export interface View { - columns?: Column[]; - created_by?: string; - date_created?: number; - id?: string; - is_all_items_view?: boolean; - is_locked?: boolean; - name?: string; - position?: string; - stick_column_left?: boolean; - type?: string; -} - -export interface Column { - id?: string; - key?: string; - position?: string; - visible?: boolean; - width?: number; -} - -export interface MediaProgress { - duration_ms?: number; - max_offset_ms?: number; - media_watched?: boolean; - offset_ms?: number; -} - -export interface Reaction { - count?: number; - name?: string; - url?: string; - users?: string[]; -} - -export interface Saved { - date_completed?: number; - date_due?: number; - is_archived?: boolean; - state?: string; -} - -export interface Shares { - private?: { [key: string]: Private[] }; - public?: { [key: string]: Private[] }; -} - -export interface Private { - access?: string; - channel_name?: string; - date_last_shared?: number; - latest_reply?: string; - reply_count?: number; - reply_users?: string[]; - reply_users_count?: number; - share_user_id?: string; - source?: string; - team_id?: string; - thread_ts?: string; - ts?: string; -} - -export interface TitleBlock { +export interface Block { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -360,6 +255,7 @@ export interface TitleBlock { description?: Text | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: Text[]; function_trigger_id?: string; @@ -396,7 +292,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -457,7 +353,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: string; + type?: FluffyType; } export interface PurpleElement { @@ -471,7 +367,7 @@ export interface PurpleElement { team_id?: string; text?: string; timestamp?: number; - type?: ElementType; + type?: PurpleType; unicode?: string; unsafe?: boolean; url?: string; @@ -490,7 +386,7 @@ export interface Style { unlink?: boolean; } -export enum ElementType { +export enum PurpleType { Broadcast = 'broadcast', Channel = 'channel', Color = 'color', @@ -503,7 +399,14 @@ export enum ElementType { Usergroup = 'usergroup', } -export interface Filter { +export enum FluffyType { + RichTextList = 'rich_text_list', + RichTextPreformatted = 'rich_text_preformatted', + RichTextQuote = 'rich_text_quote', + RichTextSection = 'rich_text_section', +} + +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -540,6 +443,132 @@ export interface CustomizableInputParameter { value?: string; } +export interface Schema { + id?: string; + is_primary_column?: boolean; + key?: string; + name?: string; + options?: Options; + type?: string; +} + +export interface Options { + canvas_id?: string; + canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; + choices?: Choice[]; + currency?: string; + currency_format?: string; + date_format?: string; + default_value?: string; + default_value_typed?: DefaultValueTyped; + emoji?: string; + emoji_team_id?: string; + for_assignment?: boolean; + format?: string; + linked_to?: string[]; + mark_as_done_when_checked?: boolean; + max?: number; + notify_users?: boolean; + precision?: number; + rounding?: string; + show_member_name?: boolean; + time_format?: string; +} + +export interface CanvasPlaceholderMapping { + column?: string; + variable?: string; +} + +export interface Choice { + color?: string; + label?: string; + value?: string; +} + +export interface DefaultValueTyped { + select?: string[]; +} + +export interface View { + columns?: Column[]; + created_by?: string; + date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; + id?: string; + is_all_items_view?: boolean; + is_locked?: boolean; + name?: string; + position?: string; + show_completed_items?: boolean; + stick_column_left?: boolean; + type?: string; +} + +export interface Column { + id?: string; + key?: string; + position?: string; + visible?: boolean; + width?: number; +} + +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + +export interface MediaProgress { + duration_ms?: number; + max_offset_ms?: number; + media_watched?: boolean; + offset_ms?: number; +} + +export interface Reaction { + count?: number; + name?: string; + url?: string; + users?: string[]; +} + +export interface Saved { + date_completed?: number; + date_due?: number; + is_archived?: boolean; + state?: string; +} + +export interface Shares { + private?: { [key: string]: Private[] }; + public?: { [key: string]: Private[] }; +} + +export interface Private { + access?: string; + channel_name?: string; + date_last_shared?: number; + latest_reply?: string; + reply_count?: number; + reply_users?: string[]; + reply_users_count?: number; + share_user_id?: string; + source?: string; + team_id?: string; + thread_ts?: string; + ts?: string; +} + export interface Transcription { locale?: string; preview?: Preview; diff --git a/packages/web-api/src/types/response/PinsListResponse.ts b/packages/web-api/src/types/response/PinsListResponse.ts index 52515fe76..b1fd3f404 100644 --- a/packages/web-api/src/types/response/PinsListResponse.ts +++ b/packages/web-api/src/types/response/PinsListResponse.ts @@ -31,6 +31,7 @@ export interface File { app_name?: string; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -77,6 +78,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -169,7 +171,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: TitleBlock[]; + title_blocks?: Block[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -220,6 +222,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -232,6 +235,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -247,116 +251,7 @@ export interface CreationSource { workflow_function_id?: string; } -export interface Schema { - id?: string; - is_primary_column?: boolean; - key?: string; - name?: string; - options?: Options; - type?: string; -} - -export interface Options { - canvas_id?: string; - canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; - choices?: Choice[]; - currency?: string; - currency_format?: string; - date_format?: string; - default_value?: string; - default_value_typed?: DefaultValueTyped; - emoji?: string; - emoji_team_id?: string; - for_assignment?: boolean; - format?: string; - linked_to?: string[]; - mark_as_done_when_checked?: boolean; - max?: number; - notify_users?: boolean; - precision?: number; - rounding?: string; - show_member_name?: boolean; - time_format?: string; -} - -export interface CanvasPlaceholderMapping { - column?: string; - variable?: string; -} - -export interface Choice { - color?: string; - label?: string; - value?: string; -} - -export interface DefaultValueTyped { - select?: string[]; -} - -export interface View { - columns?: Column[]; - created_by?: string; - date_created?: number; - id?: string; - is_all_items_view?: boolean; - is_locked?: boolean; - name?: string; - position?: string; - stick_column_left?: boolean; - type?: string; -} - -export interface Column { - id?: string; - key?: string; - position?: string; - visible?: boolean; - width?: number; -} - -export interface MediaProgress { - duration_ms?: number; - max_offset_ms?: number; - media_watched?: boolean; - offset_ms?: number; -} - -export interface Reaction { - count?: number; - name?: string; - url?: string; - users?: string[]; -} - -export interface Saved { - date_completed?: number; - date_due?: number; - is_archived?: boolean; - state?: string; -} - -export interface Shares { - private?: { [key: string]: Private[] }; - public?: { [key: string]: Private[] }; -} - -export interface Private { - access?: string; - channel_name?: string; - date_last_shared?: number; - latest_reply?: string; - reply_count?: number; - reply_users?: string[]; - reply_users_count?: number; - share_user_id?: string; - source?: string; - team_id?: string; - thread_ts?: string; - ts?: string; -} - -export interface TitleBlock { +export interface Block { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -368,6 +263,7 @@ export interface TitleBlock { description?: Text | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: Text[]; function_trigger_id?: string; @@ -404,7 +300,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -465,7 +361,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: string; + type?: FluffyType; } export interface PurpleElement { @@ -479,7 +375,7 @@ export interface PurpleElement { team_id?: string; text?: string; timestamp?: number; - type?: ElementType; + type?: PurpleType; unicode?: string; unsafe?: boolean; url?: string; @@ -498,7 +394,7 @@ export interface Style { unlink?: boolean; } -export enum ElementType { +export enum PurpleType { Broadcast = 'broadcast', Channel = 'channel', Color = 'color', @@ -511,7 +407,14 @@ export enum ElementType { Usergroup = 'usergroup', } -export interface Filter { +export enum FluffyType { + RichTextList = 'rich_text_list', + RichTextPreformatted = 'rich_text_preformatted', + RichTextQuote = 'rich_text_quote', + RichTextSection = 'rich_text_section', +} + +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -548,6 +451,132 @@ export interface CustomizableInputParameter { value?: string; } +export interface Schema { + id?: string; + is_primary_column?: boolean; + key?: string; + name?: string; + options?: Options; + type?: string; +} + +export interface Options { + canvas_id?: string; + canvas_placeholder_mapping?: CanvasPlaceholderMapping[]; + choices?: Choice[]; + currency?: string; + currency_format?: string; + date_format?: string; + default_value?: string; + default_value_typed?: DefaultValueTyped; + emoji?: string; + emoji_team_id?: string; + for_assignment?: boolean; + format?: string; + linked_to?: string[]; + mark_as_done_when_checked?: boolean; + max?: number; + notify_users?: boolean; + precision?: number; + rounding?: string; + show_member_name?: boolean; + time_format?: string; +} + +export interface CanvasPlaceholderMapping { + column?: string; + variable?: string; +} + +export interface Choice { + color?: string; + label?: string; + value?: string; +} + +export interface DefaultValueTyped { + select?: string[]; +} + +export interface View { + columns?: Column[]; + created_by?: string; + date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; + id?: string; + is_all_items_view?: boolean; + is_locked?: boolean; + name?: string; + position?: string; + show_completed_items?: boolean; + stick_column_left?: boolean; + type?: string; +} + +export interface Column { + id?: string; + key?: string; + position?: string; + visible?: boolean; + width?: number; +} + +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + +export interface MediaProgress { + duration_ms?: number; + max_offset_ms?: number; + media_watched?: boolean; + offset_ms?: number; +} + +export interface Reaction { + count?: number; + name?: string; + url?: string; + users?: string[]; +} + +export interface Saved { + date_completed?: number; + date_due?: number; + is_archived?: boolean; + state?: string; +} + +export interface Shares { + private?: { [key: string]: Private[] }; + public?: { [key: string]: Private[] }; +} + +export interface Private { + access?: string; + channel_name?: string; + date_last_shared?: number; + latest_reply?: string; + reply_count?: number; + reply_users?: string[]; + reply_users_count?: number; + share_user_id?: string; + source?: string; + team_id?: string; + thread_ts?: string; + ts?: string; +} + export interface Transcription { locale?: string; preview?: Preview; diff --git a/packages/web-api/src/types/response/ReactionsGetResponse.ts b/packages/web-api/src/types/response/ReactionsGetResponse.ts index a159270eb..1d211e091 100644 --- a/packages/web-api/src/types/response/ReactionsGetResponse.ts +++ b/packages/web-api/src/types/response/ReactionsGetResponse.ts @@ -57,6 +57,7 @@ export interface AssistantAppThreadBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; @@ -100,7 +101,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -214,7 +215,7 @@ export enum FluffyType { RichTextSection = 'rich_text_section', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -304,9 +305,10 @@ export interface File { app_id?: string; app_name?: string; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -353,6 +355,7 @@ export interface File { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -445,7 +448,7 @@ export interface File { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: FileBlock[]; + title_blocks?: DescriptionBlockElement[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -459,7 +462,7 @@ export interface File { vtt?: string; } -export interface FileBlock { +export interface DescriptionBlockElement { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -471,6 +474,7 @@ export interface FileBlock { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -546,6 +550,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -558,6 +563,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: DescriptionBlockElement[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -624,11 +630,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -641,6 +651,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; @@ -723,6 +746,7 @@ export interface Room { display_id?: string; external_unique_id?: string; has_ended?: boolean; + huddle_link?: string; id?: string; is_dm_call?: boolean; is_prewarmed?: boolean; @@ -739,6 +763,7 @@ export interface Room { participants_screenshare_off?: string[]; participants_screenshare_on?: string[]; pending_invitees?: Knocks; + recording?: Recording; thread_root_ts?: string; was_accepted?: boolean; was_missed?: boolean; @@ -746,3 +771,11 @@ export interface Room { } export type Knocks = {}; + +export interface Recording { + can_record_summary?: string; + notetaking?: boolean; + summary?: boolean; + summary_status?: string; + transcript?: boolean; +} diff --git a/packages/web-api/src/types/response/ReactionsListResponse.ts b/packages/web-api/src/types/response/ReactionsListResponse.ts index 3fe00689d..ba72fd3ad 100644 --- a/packages/web-api/src/types/response/ReactionsListResponse.ts +++ b/packages/web-api/src/types/response/ReactionsListResponse.ts @@ -83,6 +83,7 @@ export interface AssistantAppThreadBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; @@ -126,7 +127,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -155,7 +156,7 @@ export interface Accessory { style?: string; text?: DescriptionElement; timezone?: string; - type?: string; + type?: AccessoryType; url?: string; value?: string; workflow?: Workflow; @@ -187,7 +188,7 @@ export interface AccessoryElement { indent?: number; offset?: number; style?: string; - type?: FluffyType; + type?: AccessoryType; } export interface PurpleElement { @@ -233,14 +234,33 @@ export enum PurpleType { Usergroup = 'usergroup', } -export enum FluffyType { +export enum AccessoryType { + Button = 'button', + ChannelsSelect = 'channels_select', + Checkboxes = 'checkboxes', + ConversationsSelect = 'conversations_select', + Datepicker = 'datepicker', + Datetimepicker = 'datetimepicker', + ExternalSelect = 'external_select', + Image = 'image', + MultiChannelsSelect = 'multi_channels_select', + MultiConversationsSelect = 'multi_conversations_select', + MultiExternalSelect = 'multi_external_select', + MultiStaticSelect = 'multi_static_select', + MultiUsersSelect = 'multi_users_select', + Overflow = 'overflow', + RadioButtons = 'radio_buttons', RichTextList = 'rich_text_list', RichTextPreformatted = 'rich_text_preformatted', RichTextQuote = 'rich_text_quote', RichTextSection = 'rich_text_section', + StaticSelect = 'static_select', + Timepicker = 'timepicker', + UsersSelect = 'users_select', + WorkflowButton = 'workflow_button', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -330,9 +350,10 @@ export interface FileElement { app_id?: string; app_name?: string; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -379,6 +400,7 @@ export interface FileElement { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -471,7 +493,7 @@ export interface FileElement { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: FileBlock[]; + title_blocks?: DescriptionBlockElement[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -485,7 +507,7 @@ export interface FileElement { vtt?: string; } -export interface FileBlock { +export interface DescriptionBlockElement { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -497,6 +519,7 @@ export interface FileBlock { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -572,6 +595,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -584,6 +608,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: DescriptionBlockElement[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -650,11 +675,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -667,6 +696,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; @@ -728,8 +770,9 @@ export interface Attachment { author_link?: string; author_name?: string; author_subname?: string; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; + bot_team_id?: string; callback_id?: string; channel_id?: string; channel_name?: string; @@ -800,7 +843,7 @@ export interface Action { selected_options?: SelectedOptionElement[]; style?: string; text?: string; - type?: string; + type?: AccessoryType; url?: string; value?: string; } @@ -905,7 +948,7 @@ export interface FieldMessage { app_id?: string; assistant_app_thread?: AssistantAppThread; attachments?: any[]; - blocks?: FileBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; bot_link?: string; bot_profile?: BotProfile; @@ -1022,6 +1065,7 @@ export interface PurpleFile { blocks?: any[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: any[]; channel_actions_count?: number; @@ -1068,6 +1112,7 @@ export interface PurpleFile { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -1200,6 +1245,7 @@ export interface Room { display_id?: string; external_unique_id?: string; has_ended?: boolean; + huddle_link?: string; id?: string; is_dm_call?: boolean; is_prewarmed?: boolean; @@ -1216,12 +1262,21 @@ export interface Room { participants_screenshare_off?: string[]; participants_screenshare_on?: string[]; pending_invitees?: Knocks; + recording?: Recording; thread_root_ts?: string; was_accepted?: boolean; was_missed?: boolean; was_rejected?: boolean; } +export interface Recording { + can_record_summary?: string; + notetaking?: boolean; + summary?: boolean; + summary_status?: string; + transcript?: boolean; +} + export interface Root { bot_id?: string; bot_profile?: BotProfile; diff --git a/packages/web-api/src/types/response/RtmStartResponse.ts b/packages/web-api/src/types/response/RtmStartResponse.ts index 1f54768e2..17722398f 100644 --- a/packages/web-api/src/types/response/RtmStartResponse.ts +++ b/packages/web-api/src/types/response/RtmStartResponse.ts @@ -174,6 +174,7 @@ export interface Attachment { author_subname?: string; blocks?: TitleBlockElement[]; bot_id?: string; + bot_team_id?: string; callback_id?: string; channel_id?: string; channel_name?: string; @@ -304,6 +305,7 @@ export interface TitleBlockElement { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -340,7 +342,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -447,7 +449,7 @@ export enum PurpleType { Usergroup = 'usergroup', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -510,6 +512,7 @@ export interface FileElement { blocks?: TitleBlockElement[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -556,6 +559,7 @@ export interface FileElement { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -699,6 +703,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -711,6 +716,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: TitleBlockElement[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -777,11 +783,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -794,6 +804,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; @@ -1030,6 +1053,7 @@ export interface MessageFile { blocks?: any[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: any[]; channel_actions_count?: number; @@ -1076,6 +1100,7 @@ export interface MessageFile { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -1208,6 +1233,7 @@ export interface Room { display_id?: string; external_unique_id?: string; has_ended?: boolean; + huddle_link?: string; id?: string; is_dm_call?: boolean; is_prewarmed?: boolean; @@ -1221,12 +1247,21 @@ export interface Room { participants_camera_on?: any[]; participants_screenshare_off?: any[]; participants_screenshare_on?: any[]; + recording?: Recording; thread_root_ts?: string; was_accepted?: boolean; was_missed?: boolean; was_rejected?: boolean; } +export interface Recording { + can_record_summary?: string; + notetaking?: boolean; + summary?: boolean; + summary_status?: string; + transcript?: boolean; +} + export interface Root { bot_id?: string; bot_profile?: Bot; @@ -1321,6 +1356,7 @@ export interface LatestBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; diff --git a/packages/web-api/src/types/response/SearchAllResponse.ts b/packages/web-api/src/types/response/SearchAllResponse.ts index 52fcf8954..e1f2c0d8a 100644 --- a/packages/web-api/src/types/response/SearchAllResponse.ts +++ b/packages/web-api/src/types/response/SearchAllResponse.ts @@ -30,6 +30,7 @@ export interface FilesMatch { access?: string; attachments?: Attachment[]; bot_id?: string; + canvas_printing_enabled?: boolean; cc?: Cc[]; channels?: string[]; comments_count?: number; @@ -60,6 +61,7 @@ export interface FilesMatch { is_channel_space?: boolean; is_external?: boolean; is_public?: boolean; + is_restricted_sharing_enabled?: boolean; is_starred?: boolean; last_editor?: LastEditor; lines?: number; @@ -143,8 +145,9 @@ export interface Attachment { author_link?: string; author_name?: string; author_subname?: string; - blocks?: AttachmentBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; + bot_team_id?: string; callback_id?: string; channel_id?: string; channel_name?: string; @@ -263,7 +266,7 @@ export enum ActionType { WorkflowButton = 'workflow_button', } -export interface AttachmentBlock { +export interface DescriptionBlockElement { accessory?: Accessory; alt_text?: string; app_collaborators?: string[]; @@ -275,6 +278,7 @@ export interface AttachmentBlock { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -311,7 +315,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -418,7 +422,7 @@ export enum PurpleType { Usergroup = 'usergroup', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -478,9 +482,10 @@ export interface FileElement { app_id?: string; app_name?: string; attachments?: any[]; - blocks?: AttachmentBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -527,6 +532,7 @@ export interface FileElement { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -619,7 +625,7 @@ export interface FileElement { thumb_video_w?: number; timestamp?: number; title?: string; - title_blocks?: AttachmentBlock[]; + title_blocks?: DescriptionBlockElement[]; to?: Cc[]; transcription?: Transcription; update_notification?: number; @@ -675,6 +681,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -687,6 +694,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: DescriptionBlockElement[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -753,11 +761,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -770,6 +782,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; @@ -909,7 +934,7 @@ export interface Message { app_id?: string; assistant_app_thread?: AssistantAppThread; attachments?: any[]; - blocks?: AttachmentBlock[]; + blocks?: DescriptionBlockElement[]; bot_id?: string; bot_link?: string; bot_profile?: BotProfile; @@ -1032,6 +1057,7 @@ export interface MessageFile { blocks?: any[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: any[]; channel_actions_count?: number; @@ -1078,6 +1104,7 @@ export interface MessageFile { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -1210,6 +1237,7 @@ export interface Room { display_id?: string; external_unique_id?: string; has_ended?: boolean; + huddle_link?: string; id?: string; is_dm_call?: boolean; is_prewarmed?: boolean; @@ -1223,12 +1251,21 @@ export interface Room { participants_camera_on?: any[]; participants_screenshare_off?: any[]; participants_screenshare_on?: any[]; + recording?: Recording; thread_root_ts?: string; was_accepted?: boolean; was_missed?: boolean; was_rejected?: boolean; } +export interface Recording { + can_record_summary?: string; + notetaking?: boolean; + summary?: boolean; + summary_status?: string; + transcript?: boolean; +} + export interface Root { bot_id?: string; bot_profile?: BotProfile; @@ -1331,6 +1368,7 @@ export interface MatchTitleBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; diff --git a/packages/web-api/src/types/response/SearchFilesResponse.ts b/packages/web-api/src/types/response/SearchFilesResponse.ts index 886332918..24614be34 100644 --- a/packages/web-api/src/types/response/SearchFilesResponse.ts +++ b/packages/web-api/src/types/response/SearchFilesResponse.ts @@ -28,6 +28,7 @@ export interface Match { access?: string; attachments?: Attachment[]; bot_id?: string; + canvas_printing_enabled?: boolean; cc?: Cc[]; channels?: string[]; comments_count?: number; @@ -58,6 +59,7 @@ export interface Match { is_channel_space?: boolean; is_external?: boolean; is_public?: boolean; + is_restricted_sharing_enabled?: boolean; is_starred?: boolean; last_editor?: LastEditor; lines?: number; @@ -143,6 +145,7 @@ export interface Attachment { author_subname?: string; blocks?: Block[]; bot_id?: string; + bot_team_id?: string; callback_id?: string; channel_id?: string; channel_name?: string; @@ -247,6 +250,7 @@ export interface Block { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -283,7 +287,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -397,7 +401,7 @@ export enum FluffyType { RichTextSection = 'rich_text_section', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -460,6 +464,7 @@ export interface FileElement { blocks?: Block[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -506,6 +511,7 @@ export interface FileElement { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -654,6 +660,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -666,6 +673,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: Block[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -732,11 +740,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -749,6 +761,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; @@ -1011,6 +1036,7 @@ export interface MessageFile { blocks?: any[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: any[]; channel_actions_count?: number; @@ -1057,6 +1083,7 @@ export interface MessageFile { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -1189,6 +1216,7 @@ export interface Room { display_id?: string; external_unique_id?: string; has_ended?: boolean; + huddle_link?: string; id?: string; is_dm_call?: boolean; is_prewarmed?: boolean; @@ -1202,12 +1230,21 @@ export interface Room { participants_camera_on?: any[]; participants_screenshare_off?: any[]; participants_screenshare_on?: any[]; + recording?: Recording; thread_root_ts?: string; was_accepted?: boolean; was_missed?: boolean; was_rejected?: boolean; } +export interface Recording { + can_record_summary?: string; + notetaking?: boolean; + summary?: boolean; + summary_status?: string; + transcript?: boolean; +} + export interface Root { bot_id?: string; bot_profile?: BotProfile; @@ -1310,6 +1347,7 @@ export interface TitleBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; diff --git a/packages/web-api/src/types/response/SearchMessagesResponse.ts b/packages/web-api/src/types/response/SearchMessagesResponse.ts index 93a4c0f5b..69755bd51 100644 --- a/packages/web-api/src/types/response/SearchMessagesResponse.ts +++ b/packages/web-api/src/types/response/SearchMessagesResponse.ts @@ -55,6 +55,7 @@ export interface Attachment { author_subname?: string; blocks?: TitleBlockElement[]; bot_id?: string; + bot_team_id?: string; callback_id?: string; channel_id?: string; channel_name?: string; @@ -185,6 +186,7 @@ export interface TitleBlockElement { description?: DescriptionElement | string; developer_trace_id?: string; elements?: Accessory[]; + expand?: boolean; fallback?: string; fields?: DescriptionElement[]; function_trigger_id?: string; @@ -221,7 +223,7 @@ export interface Accessory { default_to_current_conversation?: boolean; elements?: AccessoryElement[]; fallback?: string; - filter?: Filter; + filter?: AccessoryFilter; focus_on_load?: boolean; image_bytes?: number; image_height?: number; @@ -328,7 +330,7 @@ export enum PurpleType { Usergroup = 'usergroup', } -export interface Filter { +export interface AccessoryFilter { exclude_bot_users?: boolean; exclude_external_shared_channels?: boolean; include?: any[]; @@ -391,6 +393,7 @@ export interface FileElement { blocks?: TitleBlockElement[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: Cc[]; channel_actions_count?: number; @@ -437,6 +440,7 @@ export interface FileElement { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -580,6 +584,7 @@ export interface InitialComment { export interface ListLimits { column_count?: number; column_count_limit?: number; + max_attachments_per_cell?: number; over_column_maximum?: boolean; over_row_maximum?: boolean; over_view_maximum?: boolean; @@ -592,6 +597,7 @@ export interface ListLimits { export interface ListMetadata { creation_source?: CreationSource; description?: string; + description_blocks?: TitleBlockElement[]; icon?: string; icon_team_id?: string; icon_url?: string; @@ -658,11 +664,15 @@ export interface View { columns?: Column[]; created_by?: string; date_created?: number; + default_view_key?: string; + filters?: FilterElement[]; + grouping?: Grouping; id?: string; is_all_items_view?: boolean; is_locked?: boolean; name?: string; position?: string; + show_completed_items?: boolean; stick_column_left?: boolean; type?: string; } @@ -675,6 +685,19 @@ export interface Column { width?: number; } +export interface FilterElement { + column_id?: string; + key?: string; + operator?: string; + typed_values?: any[]; + values?: string[]; +} + +export interface Grouping { + group_by?: string; + group_by_column_id?: string; +} + export interface MediaProgress { duration_ms?: number; max_offset_ms?: number; @@ -927,6 +950,7 @@ export interface MessageFile { blocks?: any[]; bot_id?: string; can_toggle_canvas_lock?: boolean; + canvas_printing_enabled?: boolean; canvas_template_mode?: string; cc?: any[]; channel_actions_count?: number; @@ -973,6 +997,7 @@ export interface MessageFile { lines?: number; lines_more?: number; linked_channel_id?: string; + list_csv_download_url?: string; list_limits?: ListLimits; list_metadata?: ListMetadata; media_display_type?: string; @@ -1105,6 +1130,7 @@ export interface Room { display_id?: string; external_unique_id?: string; has_ended?: boolean; + huddle_link?: string; id?: string; is_dm_call?: boolean; is_prewarmed?: boolean; @@ -1118,12 +1144,21 @@ export interface Room { participants_camera_on?: any[]; participants_screenshare_off?: any[]; participants_screenshare_on?: any[]; + recording?: Recording; thread_root_ts?: string; was_accepted?: boolean; was_missed?: boolean; was_rejected?: boolean; } +export interface Recording { + can_record_summary?: string; + notetaking?: boolean; + summary?: boolean; + summary_status?: string; + transcript?: boolean; +} + export interface Root { bot_id?: string; bot_profile?: BotProfile; @@ -1218,6 +1253,7 @@ export interface MatchBlock { dispatch_action?: boolean; element?: Accessory; elements?: Accessory[]; + expand?: boolean; external_id?: string; fallback?: string; fields?: DescriptionElement[]; diff --git a/packages/web-api/src/types/response/UsergroupsCreateResponse.ts b/packages/web-api/src/types/response/UsergroupsCreateResponse.ts index 1fe5905a6..7cac0a9bb 100644 --- a/packages/web-api/src/types/response/UsergroupsCreateResponse.ts +++ b/packages/web-api/src/types/response/UsergroupsCreateResponse.ts @@ -28,6 +28,7 @@ export interface Usergroup { handle?: string; id?: string; is_external?: boolean; + is_section?: boolean; is_subteam?: boolean; is_usergroup?: boolean; name?: string; diff --git a/packages/web-api/src/types/response/UsergroupsDisableResponse.ts b/packages/web-api/src/types/response/UsergroupsDisableResponse.ts index c679f98c9..c4862272f 100644 --- a/packages/web-api/src/types/response/UsergroupsDisableResponse.ts +++ b/packages/web-api/src/types/response/UsergroupsDisableResponse.ts @@ -29,6 +29,7 @@ export interface Usergroup { handle?: string; id?: string; is_external?: boolean; + is_section?: boolean; is_subteam?: boolean; is_usergroup?: boolean; name?: string; diff --git a/packages/web-api/src/types/response/UsergroupsEnableResponse.ts b/packages/web-api/src/types/response/UsergroupsEnableResponse.ts index 0bafcf72f..c42a3c631 100644 --- a/packages/web-api/src/types/response/UsergroupsEnableResponse.ts +++ b/packages/web-api/src/types/response/UsergroupsEnableResponse.ts @@ -28,6 +28,7 @@ export interface Usergroup { handle?: string; id?: string; is_external?: boolean; + is_section?: boolean; is_subteam?: boolean; is_usergroup?: boolean; name?: string; diff --git a/packages/web-api/src/types/response/UsergroupsListResponse.ts b/packages/web-api/src/types/response/UsergroupsListResponse.ts index 7f79bf52e..3d7928bb5 100644 --- a/packages/web-api/src/types/response/UsergroupsListResponse.ts +++ b/packages/web-api/src/types/response/UsergroupsListResponse.ts @@ -28,6 +28,7 @@ export interface Usergroup { handle?: string; id?: string; is_external?: boolean; + is_section?: boolean; is_subteam?: boolean; is_usergroup?: boolean; name?: string; diff --git a/packages/web-api/src/types/response/UsergroupsUpdateResponse.ts b/packages/web-api/src/types/response/UsergroupsUpdateResponse.ts index 050113316..7680a64da 100644 --- a/packages/web-api/src/types/response/UsergroupsUpdateResponse.ts +++ b/packages/web-api/src/types/response/UsergroupsUpdateResponse.ts @@ -28,6 +28,7 @@ export interface Usergroup { handle?: string; id?: string; is_external?: boolean; + is_section?: boolean; is_subteam?: boolean; is_usergroup?: boolean; name?: string; diff --git a/packages/web-api/src/types/response/UsergroupsUsersUpdateResponse.ts b/packages/web-api/src/types/response/UsergroupsUsersUpdateResponse.ts index 78462953d..650b52fab 100644 --- a/packages/web-api/src/types/response/UsergroupsUsersUpdateResponse.ts +++ b/packages/web-api/src/types/response/UsergroupsUsersUpdateResponse.ts @@ -28,6 +28,7 @@ export interface Usergroup { handle?: string; id?: string; is_external?: boolean; + is_section?: boolean; is_subteam?: boolean; is_usergroup?: boolean; name?: string; diff --git a/packages/web-api/src/types/response/UsersConversationsResponse.ts b/packages/web-api/src/types/response/UsersConversationsResponse.ts index f31fd842b..a227109bf 100644 --- a/packages/web-api/src/types/response/UsersConversationsResponse.ts +++ b/packages/web-api/src/types/response/UsersConversationsResponse.ts @@ -64,6 +64,7 @@ export interface Properties { huddles_restricted?: boolean; posting_restricted_to?: PostingRestrictedTo; tabs?: Tab[]; + tabz?: Tab[]; threads_restricted_to?: ThreadsRestrictedTo; } diff --git a/packages/web-api/src/types/response/UsersInfoResponse.ts b/packages/web-api/src/types/response/UsersInfoResponse.ts index 678ace962..8b2b8f1a7 100644 --- a/packages/web-api/src/types/response/UsersInfoResponse.ts +++ b/packages/web-api/src/types/response/UsersInfoResponse.ts @@ -52,6 +52,7 @@ export interface EnterpriseUser { id?: string; is_admin?: boolean; is_owner?: boolean; + is_primary_owner?: boolean; teams?: string[]; } diff --git a/packages/web-api/src/types/response/ViewsOpenResponse.ts b/packages/web-api/src/types/response/ViewsOpenResponse.ts index ab7af7eef..bb73228de 100644 --- a/packages/web-api/src/types/response/ViewsOpenResponse.ts +++ b/packages/web-api/src/types/response/ViewsOpenResponse.ts @@ -54,6 +54,7 @@ export interface Block { dispatch_action?: boolean; element?: PurpleElement; elements?: StickyElement[]; + expand?: boolean; fallback?: string; fields?: Close[]; hint?: Close; diff --git a/packages/web-api/src/types/response/ViewsPublishResponse.ts b/packages/web-api/src/types/response/ViewsPublishResponse.ts index d11e63129..71c24c5c9 100644 --- a/packages/web-api/src/types/response/ViewsPublishResponse.ts +++ b/packages/web-api/src/types/response/ViewsPublishResponse.ts @@ -54,6 +54,7 @@ export interface Block { dispatch_action?: boolean; element?: PurpleElement; elements?: StickyElement[]; + expand?: boolean; fallback?: string; fields?: Close[]; hint?: Close; diff --git a/packages/web-api/src/types/response/ViewsPushResponse.ts b/packages/web-api/src/types/response/ViewsPushResponse.ts index 402bc6db5..f912c09a8 100644 --- a/packages/web-api/src/types/response/ViewsPushResponse.ts +++ b/packages/web-api/src/types/response/ViewsPushResponse.ts @@ -54,6 +54,7 @@ export interface Block { dispatch_action?: boolean; element?: PurpleElement; elements?: StickyElement[]; + expand?: boolean; fallback?: string; fields?: Close[]; hint?: Close; diff --git a/packages/web-api/src/types/response/ViewsUpdateResponse.ts b/packages/web-api/src/types/response/ViewsUpdateResponse.ts index 55dc1913a..5eecbeadc 100644 --- a/packages/web-api/src/types/response/ViewsUpdateResponse.ts +++ b/packages/web-api/src/types/response/ViewsUpdateResponse.ts @@ -54,6 +54,7 @@ export interface Block { dispatch_action?: boolean; element?: PurpleElement; elements?: StickyElement[]; + expand?: boolean; fallback?: string; fields?: Close[]; hint?: Close; diff --git a/scripts/code_generator.rb b/scripts/code_generator.rb index a8dd3e868..defdf0ed3 100644 --- a/scripts/code_generator.rb +++ b/scripts/code_generator.rb @@ -29,7 +29,7 @@ def write(root_class_name, json_path, typedef_filepath, input_json) Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr| stdin.write(input_json) stdin.close() - source = "#{NOTICE}\nimport { WebAPICallResult } from '../../WebClient';\n" + stdout.read + source = "#{NOTICE}\nimport type { WebAPICallResult } from '../../WebClient';\n" + stdout.read source.gsub!( "export interface #{root_class_name} {", "export type #{root_class_name} = WebAPICallResult & {" diff --git a/scripts/generate-web-api-types.sh b/scripts/generate-web-api-types.sh index c8c5b366c..cea430314 100755 --- a/scripts/generate-web-api-types.sh +++ b/scripts/generate-web-api-types.sh @@ -23,4 +23,4 @@ popd # run lint fixing after type generation pushd packages/web-api npm i -npm run lint +npm run lint:fix diff --git a/scripts/package.json b/scripts/package.json index 0f5872494..c48d44b00 100644 --- a/scripts/package.json +++ b/scripts/package.json @@ -6,6 +6,6 @@ "author": "", "license": "MIT", "devDependencies": { - "quicktype": "^23.0.106" + "quicktype": "^23.2.0" } }